UNPKG

@pulumi/azure-native

Version:

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com) [![NPM version](https://badge.fury.io/js/%40pulumi%2Fazure-native.svg)](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

124 lines (123 loc) 5.2 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Class representing a database script. * * Uses Azure REST API version 2024-04-13. In version 2.x of the Azure Native provider, it used API version 2022-12-29. * * 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details. */ export declare class Script extends pulumi.CustomResource { /** * Get an existing Script resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Script; /** * Returns true if the given object is an instance of Script. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Script; /** * The Azure API version of the resource. */ readonly azureApiVersion: pulumi.Output<string>; /** * Flag that indicates whether to continue if one of the command fails. */ readonly continueOnErrors: pulumi.Output<boolean | undefined>; /** * A unique string. If changed the script will be applied again. */ readonly forceUpdateTag: pulumi.Output<string | undefined>; /** * The name of the resource */ readonly name: pulumi.Output<string>; /** * Indicates if the permissions for the script caller are kept following completion of the script. */ readonly principalPermissionsAction: pulumi.Output<string | undefined>; /** * The provisioned state of the resource. */ readonly provisioningState: pulumi.Output<string>; /** * Differentiates between the type of script commands included - Database or Cluster. The default is Database. */ readonly scriptLevel: pulumi.Output<string | undefined>; /** * The url to the KQL script blob file. Must not be used together with scriptContent property */ readonly scriptUrl: pulumi.Output<string | undefined>; /** * Metadata pertaining to creation and last modification of the resource. */ readonly systemData: pulumi.Output<outputs.kusto.SystemDataResponse>; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ readonly type: pulumi.Output<string>; /** * Create a Script resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ScriptArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Script resource. */ export interface ScriptArgs { /** * The name of the Kusto cluster. */ clusterName: pulumi.Input<string>; /** * Flag that indicates whether to continue if one of the command fails. */ continueOnErrors?: pulumi.Input<boolean>; /** * The name of the database in the Kusto cluster. */ databaseName: pulumi.Input<string>; /** * A unique string. If changed the script will be applied again. */ forceUpdateTag?: pulumi.Input<string>; /** * Indicates if the permissions for the script caller are kept following completion of the script. */ principalPermissionsAction?: pulumi.Input<string | enums.kusto.PrincipalPermissionsAction>; /** * The name of the resource group. The name is case insensitive. */ resourceGroupName: pulumi.Input<string>; /** * 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?: pulumi.Input<string>; /** * Differentiates between the type of script commands included - Database or Cluster. The default is Database. */ scriptLevel?: pulumi.Input<string | enums.kusto.ScriptLevel>; /** * The name of the Kusto database script. */ scriptName?: pulumi.Input<string>; /** * The url to the KQL script blob file. Must not be used together with scriptContent property */ scriptUrl?: pulumi.Input<string>; /** * The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. */ scriptUrlSasToken?: pulumi.Input<string>; }