Script interface

Package:

@azure/arm-kusto

Class representing a database script.

Extends

ProxyResource

Properties

continueOnErrors	Flag that indicates whether to continue if one of the command fails.
forceUpdateTag	A unique string. If changed the script will be applied again.
managedIdentityResourceId	The resource identifier of the managed identity to be used. When provided, the managed identity will be used to read the script content from the scriptUrl.
principalPermissionsAction	Indicates if the permissions for the script caller are kept following completion of the script.
provisioningState	The provisioned state of the resource.
scriptContent	The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties.
scriptLevel	Differentiates between the type of script commands included - Database or Cluster. The default is Database.
scriptUrl	The url to the KQL script blob file. Must not be used together with scriptContent property
scriptUrlSasToken	The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

continueOnErrors

Flag that indicates whether to continue if one of the command fails.

continueOnErrors?: boolean

Property Value

boolean

forceUpdateTag

A unique string. If changed the script will be applied again.

forceUpdateTag?: string

Property Value

string

managedIdentityResourceId

The resource identifier of the managed identity to be used. When provided, the managed identity will be used to read the script content from the scriptUrl.

managedIdentityResourceId?: string

Property Value

string

principalPermissionsAction

Indicates if the permissions for the script caller are kept following completion of the script.

principalPermissionsAction?: string

Property Value

string

provisioningState

The provisioned state of the resource.

provisioningState?: string

Property Value

string

scriptContent

The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties.

scriptContent?: string

Property Value

string

scriptLevel

Differentiates between the type of script commands included - Database or Cluster. The default is Database.

scriptLevel?: string

Property Value

string

scriptUrl

The url to the KQL script blob file. Must not be used together with scriptContent property

scriptUrl?: string

Property Value

string

scriptUrlSasToken

The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property.

scriptUrlSasToken?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type