Script interface

Class representing a database script.

Extends

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.

provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

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.

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.

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

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

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

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type