Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getScript
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.getScript

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a Kusto cluster database script.

Uses Azure REST API version 2024-04-13.

Other available API versions: 2021-01-01, 2021-08-27, 2022-02-01, 2022-07-07, 2022-11-11, 2022-12-29, 2023-05-02, 2023-08-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native kusto [ApiVersion]. See the version guide for details.

Using getScript

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getScript(args: GetScriptArgs, opts?: InvokeOptions): Promise<GetScriptResult>
function getScriptOutput(args: GetScriptOutputArgs, opts?: InvokeOptions): Output<GetScriptResult>
Copy
def get_script(cluster_name: Optional[str] = None,
               database_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               script_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetScriptResult
def get_script_output(cluster_name: Optional[pulumi.Input[str]] = None,
               database_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               script_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetScriptResult]
Copy
func LookupScript(ctx *Context, args *LookupScriptArgs, opts ...InvokeOption) (*LookupScriptResult, error)
func LookupScriptOutput(ctx *Context, args *LookupScriptOutputArgs, opts ...InvokeOption) LookupScriptResultOutput
Copy

> Note: This function is named LookupScript in the Go SDK.

public static class GetScript 
{
    public static Task<GetScriptResult> InvokeAsync(GetScriptArgs args, InvokeOptions? opts = null)
    public static Output<GetScriptResult> Invoke(GetScriptInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetScriptResult> getScript(GetScriptArgs args, InvokeOptions options)
public static Output<GetScriptResult> getScript(GetScriptArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:getScript
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScriptName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto database script.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScriptName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto database script.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scriptName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto database script.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
scriptName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto database script.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
script_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto database script.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scriptName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto database script.

getScript Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SystemData Pulumi.AzureNative.Kusto.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ContinueOnErrors bool
Flag that indicates whether to continue if one of the command fails.
ForceUpdateTag string
A unique string. If changed the script will be applied again.
PrincipalPermissionsAction string
Indicates if the permissions for the script caller are kept following completion of the script.
ScriptLevel string
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
ScriptUrl string
The url to the KQL script blob file. Must not be used together with scriptContent property
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ContinueOnErrors bool
Flag that indicates whether to continue if one of the command fails.
ForceUpdateTag string
A unique string. If changed the script will be applied again.
PrincipalPermissionsAction string
Indicates if the permissions for the script caller are kept following completion of the script.
ScriptLevel string
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
ScriptUrl string
The url to the KQL script blob file. Must not be used together with scriptContent property
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
continueOnErrors Boolean
Flag that indicates whether to continue if one of the command fails.
forceUpdateTag String
A unique string. If changed the script will be applied again.
principalPermissionsAction String
Indicates if the permissions for the script caller are kept following completion of the script.
scriptLevel String
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
scriptUrl String
The url to the KQL script blob file. Must not be used together with scriptContent property
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
The provisioned state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
continueOnErrors boolean
Flag that indicates whether to continue if one of the command fails.
forceUpdateTag string
A unique string. If changed the script will be applied again.
principalPermissionsAction string
Indicates if the permissions for the script caller are kept following completion of the script.
scriptLevel string
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
scriptUrl string
The url to the KQL script blob file. Must not be used together with scriptContent property
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
The provisioned state of the resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
continue_on_errors bool
Flag that indicates whether to continue if one of the command fails.
force_update_tag str
A unique string. If changed the script will be applied again.
principal_permissions_action str
Indicates if the permissions for the script caller are kept following completion of the script.
script_level str
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
script_url str
The url to the KQL script blob file. Must not be used together with scriptContent property
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
continueOnErrors Boolean
Flag that indicates whether to continue if one of the command fails.
forceUpdateTag String
A unique string. If changed the script will be applied again.
principalPermissionsAction String
Indicates if the permissions for the script caller are kept following completion of the script.
scriptLevel String
Differentiates between the type of script commands included - Database or Cluster. The default is Database.
scriptUrl String
The url to the KQL script blob file. Must not be used together with scriptContent property

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native