azure-native.kusto.getScript
Explore with Pulumi AI
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>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]func LookupScript(ctx *Context, args *LookupScriptArgs, opts ...InvokeOption) (*LookupScriptResult, error)
func LookupScriptOutput(ctx *Context, args *LookupScriptOutputArgs, opts ...InvokeOption) LookupScriptResultOutput> 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)
}public static CompletableFuture<GetScriptResult> getScript(GetScriptArgs args, InvokeOptions options)
public static Output<GetScriptResult> getScript(GetScriptArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:kusto:getScript
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cluster
Name string - The name of the Kusto cluster.
 - Database
Name string - The name of the database in the Kusto cluster.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Script
Name string - The name of the Kusto database script.
 
- Cluster
Name string - The name of the Kusto cluster.
 - Database
Name string - The name of the database in the Kusto cluster.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Script
Name string - The name of the Kusto database script.
 
- cluster
Name String - The name of the Kusto cluster.
 - database
Name String - The name of the database in the Kusto cluster.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - script
Name String - The name of the Kusto database script.
 
- cluster
Name string - The name of the Kusto cluster.
 - database
Name string - The name of the database in the Kusto cluster.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - script
Name string - The name of the Kusto database script.
 
- cluster_
name str - The name of the Kusto cluster.
 - database_
name str - The name of the database in the Kusto cluster.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 - script_
name str - The name of the Kusto database script.
 
- cluster
Name String - The name of the Kusto cluster.
 - database
Name String - The name of the database in the Kusto cluster.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - script
Name String - The name of the Kusto database script.
 
getScript Result
The following output properties are available:
- Azure
Api stringVersion  - 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
 - Provisioning
State string - The provisioned state of the resource.
 - System
Data Pulumi.Azure Native. Kusto. Outputs. System Data Response  - 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"
 - Continue
On boolErrors  - Flag that indicates whether to continue if one of the command fails.
 - Force
Update stringTag  - A unique string. If changed the script will be applied again.
 - Principal
Permissions stringAction  - Indicates if the permissions for the script caller are kept following completion of the script.
 - Script
Level string - Differentiates between the type of script commands included - Database or Cluster. The default is Database.
 - Script
Url string - The url to the KQL script blob file. Must not be used together with scriptContent property
 
- Azure
Api stringVersion  - 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
 - Provisioning
State string - The provisioned state of the resource.
 - System
Data SystemData Response  - 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"
 - Continue
On boolErrors  - Flag that indicates whether to continue if one of the command fails.
 - Force
Update stringTag  - A unique string. If changed the script will be applied again.
 - Principal
Permissions stringAction  - Indicates if the permissions for the script caller are kept following completion of the script.
 - Script
Level string - Differentiates between the type of script commands included - Database or Cluster. The default is Database.
 - Script
Url string - The url to the KQL script blob file. Must not be used together with scriptContent property
 
- azure
Api StringVersion  - 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
 - provisioning
State String - The provisioned state of the resource.
 - system
Data SystemData Response  - 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"
 - continue
On BooleanErrors  - Flag that indicates whether to continue if one of the command fails.
 - force
Update StringTag  - A unique string. If changed the script will be applied again.
 - principal
Permissions StringAction  - Indicates if the permissions for the script caller are kept following completion of the script.
 - script
Level String - Differentiates between the type of script commands included - Database or Cluster. The default is Database.
 - script
Url String - The url to the KQL script blob file. Must not be used together with scriptContent property
 
- azure
Api stringVersion  - 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
 - provisioning
State string - The provisioned state of the resource.
 - system
Data SystemData Response  - 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"
 - continue
On booleanErrors  - Flag that indicates whether to continue if one of the command fails.
 - force
Update stringTag  - A unique string. If changed the script will be applied again.
 - principal
Permissions stringAction  - Indicates if the permissions for the script caller are kept following completion of the script.
 - script
Level string - Differentiates between the type of script commands included - Database or Cluster. The default is Database.
 - script
Url string - The url to the KQL script blob file. Must not be used together with scriptContent property
 
- azure_
api_ strversion  - 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 SystemData Response  - 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_ boolerrors  - Flag that indicates whether to continue if one of the command fails.
 - force_
update_ strtag  - A unique string. If changed the script will be applied again.
 - principal_
permissions_ straction  - 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
 
- azure
Api StringVersion  - 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
 - provisioning
State String - The provisioned state of the resource.
 - system
Data 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"
 - continue
On BooleanErrors  - Flag that indicates whether to continue if one of the command fails.
 - force
Update StringTag  - A unique string. If changed the script will be applied again.
 - principal
Permissions StringAction  - Indicates if the permissions for the script caller are kept following completion of the script.
 - script
Level String - Differentiates between the type of script commands included - Database or Cluster. The default is Database.
 - script
Url String - The url to the KQL script blob file. Must not be used together with scriptContent property
 
Supporting Types
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - 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_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0