1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. core
  5. ResourceDeploymentScriptPowerShell
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.core.ResourceDeploymentScriptPowerShell

Manages a Resource Deployment Script of Azure PowerShell.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleUserAssignedIdentity = new Azure.Authorization.UserAssignedIdentity("exampleUserAssignedIdentity", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleResourceDeploymentScriptPowerShell = new Azure.Core.ResourceDeploymentScriptPowerShell("exampleResourceDeploymentScriptPowerShell", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = "West Europe",
        Version = "8.3",
        RetentionInterval = "P1D",
        CommandLine = "-name \"John Dole\"",
        CleanupPreference = "OnSuccess",
        ForceUpdateTag = "1",
        Timeout = "PT30M",
        ScriptContent = @"          param([string] $name)
            $output = 'Hello {0}.' -f $name
            Write-Output $output
            $DeploymentScriptOutputs = @{}
            $DeploymentScriptOutputs['text'] = $output
",
        Identity = new Azure.Core.Inputs.ResourceDeploymentScriptPowerShellIdentityArgs
        {
            Type = "UserAssigned",
            IdentityIds = new[]
            {
                exampleUserAssignedIdentity.Id,
            },
        },
        Tags = 
        {
            { "key", "value" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleUserAssignedIdentity, err := authorization.NewUserAssignedIdentity(ctx, "exampleUserAssignedIdentity", &authorization.UserAssignedIdentityArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = core.NewResourceDeploymentScriptPowerShell(ctx, "exampleResourceDeploymentScriptPowerShell", &core.ResourceDeploymentScriptPowerShellArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          pulumi.String("West Europe"),
			Version:           pulumi.String("8.3"),
			RetentionInterval: pulumi.String("P1D"),
			CommandLine:       pulumi.String("-name \"John Dole\""),
			CleanupPreference: pulumi.String("OnSuccess"),
			ForceUpdateTag:    pulumi.String("1"),
			Timeout:           pulumi.String("PT30M"),
			ScriptContent:     pulumi.String("          param([string] $name)\n            $output = 'Hello {0}.' -f $name\n            Write-Output $output\n            $DeploymentScriptOutputs = @{}\n            $DeploymentScriptOutputs['text'] = $output\n"),
			Identity: &core.ResourceDeploymentScriptPowerShellIdentityArgs{
				Type: pulumi.String("UserAssigned"),
				IdentityIds: pulumi.StringArray{
					exampleUserAssignedIdentity.ID(),
				},
			},
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.authorization.UserAssignedIdentity;
import com.pulumi.azure.authorization.UserAssignedIdentityArgs;
import com.pulumi.azure.core.ResourceDeploymentScriptPowerShell;
import com.pulumi.azure.core.ResourceDeploymentScriptPowerShellArgs;
import com.pulumi.azure.core.inputs.ResourceDeploymentScriptPowerShellIdentityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleUserAssignedIdentity = new UserAssignedIdentity("exampleUserAssignedIdentity", UserAssignedIdentityArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleResourceDeploymentScriptPowerShell = new ResourceDeploymentScriptPowerShell("exampleResourceDeploymentScriptPowerShell", ResourceDeploymentScriptPowerShellArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location("West Europe")
            .version("8.3")
            .retentionInterval("P1D")
            .commandLine("-name \"John Dole\"")
            .cleanupPreference("OnSuccess")
            .forceUpdateTag("1")
            .timeout("PT30M")
            .scriptContent("""
          param([string] $name)
            $output = 'Hello {0}.' -f $name
            Write-Output $output
            $DeploymentScriptOutputs = @{}
            $DeploymentScriptOutputs['text'] = $output
            """)
            .identity(ResourceDeploymentScriptPowerShellIdentityArgs.builder()
                .type("UserAssigned")
                .identityIds(exampleUserAssignedIdentity.id())
                .build())
            .tags(Map.of("key", "value"))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_user_assigned_identity = azure.authorization.UserAssignedIdentity("exampleUserAssignedIdentity",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_resource_deployment_script_power_shell = azure.core.ResourceDeploymentScriptPowerShell("exampleResourceDeploymentScriptPowerShell",
    resource_group_name=example_resource_group.name,
    location="West Europe",
    version="8.3",
    retention_interval="P1D",
    command_line="-name \"John Dole\"",
    cleanup_preference="OnSuccess",
    force_update_tag="1",
    timeout="PT30M",
    script_content="""          param([string] $name)
            $output = 'Hello {0}.' -f $name
            Write-Output $output
            $DeploymentScriptOutputs = @{}
            $DeploymentScriptOutputs['text'] = $output
""",
    identity=azure.core.ResourceDeploymentScriptPowerShellIdentityArgs(
        type="UserAssigned",
        identity_ids=[example_user_assigned_identity.id],
    ),
    tags={
        "key": "value",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleUserAssignedIdentity = new azure.authorization.UserAssignedIdentity("exampleUserAssignedIdentity", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleResourceDeploymentScriptPowerShell = new azure.core.ResourceDeploymentScriptPowerShell("exampleResourceDeploymentScriptPowerShell", {
    resourceGroupName: exampleResourceGroup.name,
    location: "West Europe",
    version: "8.3",
    retentionInterval: "P1D",
    commandLine: "-name \"John Dole\"",
    cleanupPreference: "OnSuccess",
    forceUpdateTag: "1",
    timeout: "PT30M",
    scriptContent: `          param([string] $name)
            $output = 'Hello {0}.' -f $name
            Write-Output $output
            $DeploymentScriptOutputs = @{}
            $DeploymentScriptOutputs['text'] = $output
`,
    identity: {
        type: "UserAssigned",
        identityIds: [exampleUserAssignedIdentity.id],
    },
    tags: {
        key: "value",
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleUserAssignedIdentity:
    type: azure:authorization:UserAssignedIdentity
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleResourceDeploymentScriptPowerShell:
    type: azure:core:ResourceDeploymentScriptPowerShell
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: West Europe
      version: '8.3'
      retentionInterval: P1D
      commandLine: -name "John Dole"
      cleanupPreference: OnSuccess
      forceUpdateTag: '1'
      timeout: PT30M
      scriptContent: |2
                  param([string] $name)
                    $output = 'Hello {0}.' -f $name
                    Write-Output $output
                    $DeploymentScriptOutputs = @{}
                    $DeploymentScriptOutputs['text'] = $output
      identity:
        type: UserAssigned
        identityIds:
          - ${exampleUserAssignedIdentity.id}
      tags:
        key: value

Create ResourceDeploymentScriptPowerShell Resource

new ResourceDeploymentScriptPowerShell(name: string, args: ResourceDeploymentScriptPowerShellArgs, opts?: CustomResourceOptions);
@overload
def ResourceDeploymentScriptPowerShell(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       cleanup_preference: Optional[str] = None,
                                       command_line: Optional[str] = None,
                                       container: Optional[ResourceDeploymentScriptPowerShellContainerArgs] = None,
                                       environment_variables: Optional[Sequence[ResourceDeploymentScriptPowerShellEnvironmentVariableArgs]] = None,
                                       force_update_tag: Optional[str] = None,
                                       identity: Optional[ResourceDeploymentScriptPowerShellIdentityArgs] = None,
                                       location: Optional[str] = None,
                                       name: Optional[str] = None,
                                       primary_script_uri: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       retention_interval: Optional[str] = None,
                                       script_content: Optional[str] = None,
                                       storage_account: Optional[ResourceDeploymentScriptPowerShellStorageAccountArgs] = None,
                                       supporting_script_uris: Optional[Sequence[str]] = None,
                                       tags: Optional[Mapping[str, str]] = None,
                                       timeout: Optional[str] = None,
                                       version: Optional[str] = None)
@overload
def ResourceDeploymentScriptPowerShell(resource_name: str,
                                       args: ResourceDeploymentScriptPowerShellArgs,
                                       opts: Optional[ResourceOptions] = None)
func NewResourceDeploymentScriptPowerShell(ctx *Context, name string, args ResourceDeploymentScriptPowerShellArgs, opts ...ResourceOption) (*ResourceDeploymentScriptPowerShell, error)
public ResourceDeploymentScriptPowerShell(string name, ResourceDeploymentScriptPowerShellArgs args, CustomResourceOptions? opts = null)
public ResourceDeploymentScriptPowerShell(String name, ResourceDeploymentScriptPowerShellArgs args)
public ResourceDeploymentScriptPowerShell(String name, ResourceDeploymentScriptPowerShellArgs args, CustomResourceOptions options)

type: azure:core:ResourceDeploymentScriptPowerShell
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ResourceDeploymentScriptPowerShellArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ResourceDeploymentScriptPowerShellArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ResourceDeploymentScriptPowerShellArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ResourceDeploymentScriptPowerShellArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ResourceDeploymentScriptPowerShellArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ResourceDeploymentScriptPowerShell Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ResourceDeploymentScriptPowerShell resource accepts the following input properties:

ResourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

RetentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

Version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

CleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

CommandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

Container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

EnvironmentVariables List<ResourceDeploymentScriptPowerShellEnvironmentVariableArgs>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

ForceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

Identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

Location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

Name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

PrimaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

ScriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

StorageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

SupportingScriptUris List<string>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Resource Deployment Script.

Timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

ResourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

RetentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

Version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

CleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

CommandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

Container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

EnvironmentVariables []ResourceDeploymentScriptPowerShellEnvironmentVariableArgs

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

ForceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

Identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

Location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

Name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

PrimaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

ScriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

StorageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

SupportingScriptUris []string

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

Tags map[string]string

A mapping of tags which should be assigned to the Resource Deployment Script.

Timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval String

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

version String

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference String

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine String

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables List<ResourceDeploymentScriptPowerShellEnvironmentVariableArgs>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag String

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location String

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name String

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

primaryScriptUri String

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

scriptContent String

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris List<String>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout String

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables ResourceDeploymentScriptPowerShellEnvironmentVariableArgs[]

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

primaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

scriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris string[]

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

resource_group_name str

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retention_interval str

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

version str

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanup_preference str

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

command_line str

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environment_variables Sequence[ResourceDeploymentScriptPowerShellEnvironmentVariableArgs]

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

force_update_tag str

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location str

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name str

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

primary_script_uri str

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

script_content str

Script body. Changing this forces a new Resource Deployment Script to be created.

storage_account ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supporting_script_uris Sequence[str]

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout str

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval String

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

version String

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference String

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine String

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container Property Map

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables List<Property Map>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag String

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity Property Map

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location String

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name String

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

primaryScriptUri String

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

scriptContent String

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount Property Map

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris List<String>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Map<String>

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout String

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the ResourceDeploymentScriptPowerShell resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Outputs string

List of script outputs.

Id string

The provider-assigned unique ID for this managed resource.

Outputs string

List of script outputs.

id String

The provider-assigned unique ID for this managed resource.

outputs String

List of script outputs.

id string

The provider-assigned unique ID for this managed resource.

outputs string

List of script outputs.

id str

The provider-assigned unique ID for this managed resource.

outputs str

List of script outputs.

id String

The provider-assigned unique ID for this managed resource.

outputs String

List of script outputs.

Look up Existing ResourceDeploymentScriptPowerShell Resource

Get an existing ResourceDeploymentScriptPowerShell resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ResourceDeploymentScriptPowerShellState, opts?: CustomResourceOptions): ResourceDeploymentScriptPowerShell
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cleanup_preference: Optional[str] = None,
        command_line: Optional[str] = None,
        container: Optional[ResourceDeploymentScriptPowerShellContainerArgs] = None,
        environment_variables: Optional[Sequence[ResourceDeploymentScriptPowerShellEnvironmentVariableArgs]] = None,
        force_update_tag: Optional[str] = None,
        identity: Optional[ResourceDeploymentScriptPowerShellIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        outputs: Optional[str] = None,
        primary_script_uri: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        retention_interval: Optional[str] = None,
        script_content: Optional[str] = None,
        storage_account: Optional[ResourceDeploymentScriptPowerShellStorageAccountArgs] = None,
        supporting_script_uris: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeout: Optional[str] = None,
        version: Optional[str] = None) -> ResourceDeploymentScriptPowerShell
func GetResourceDeploymentScriptPowerShell(ctx *Context, name string, id IDInput, state *ResourceDeploymentScriptPowerShellState, opts ...ResourceOption) (*ResourceDeploymentScriptPowerShell, error)
public static ResourceDeploymentScriptPowerShell Get(string name, Input<string> id, ResourceDeploymentScriptPowerShellState? state, CustomResourceOptions? opts = null)
public static ResourceDeploymentScriptPowerShell get(String name, Output<String> id, ResourceDeploymentScriptPowerShellState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

CommandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

Container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

EnvironmentVariables List<ResourceDeploymentScriptPowerShellEnvironmentVariableArgs>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

ForceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

Identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

Location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

Name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

Outputs string

List of script outputs.

PrimaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

ResourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

RetentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

ScriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

StorageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

SupportingScriptUris List<string>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Resource Deployment Script.

Timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

Version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

CleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

CommandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

Container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

EnvironmentVariables []ResourceDeploymentScriptPowerShellEnvironmentVariableArgs

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

ForceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

Identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

Location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

Name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

Outputs string

List of script outputs.

PrimaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

ResourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

RetentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

ScriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

StorageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

SupportingScriptUris []string

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

Tags map[string]string

A mapping of tags which should be assigned to the Resource Deployment Script.

Timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

Version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference String

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine String

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables List<ResourceDeploymentScriptPowerShellEnvironmentVariableArgs>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag String

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location String

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name String

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

outputs String

List of script outputs.

primaryScriptUri String

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval String

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

scriptContent String

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris List<String>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout String

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

version String

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference string

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine string

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables ResourceDeploymentScriptPowerShellEnvironmentVariableArgs[]

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag string

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location string

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name string

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

outputs string

List of script outputs.

primaryScriptUri string

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName string

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval string

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

scriptContent string

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris string[]

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout string

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

version string

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanup_preference str

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

command_line str

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container ResourceDeploymentScriptPowerShellContainerArgs

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environment_variables Sequence[ResourceDeploymentScriptPowerShellEnvironmentVariableArgs]

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

force_update_tag str

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity ResourceDeploymentScriptPowerShellIdentityArgs

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location str

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name str

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

outputs str

List of script outputs.

primary_script_uri str

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

resource_group_name str

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retention_interval str

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

script_content str

Script body. Changing this forces a new Resource Deployment Script to be created.

storage_account ResourceDeploymentScriptPowerShellStorageAccountArgs

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supporting_script_uris Sequence[str]

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout str

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

version str

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

cleanupPreference String

Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are Always, OnExpiration, OnSuccess. Defaults to Always. Changing this forces a new Resource Deployment Script to be created.

commandLine String

Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.

container Property Map

A container block as defined below. Changing this forces a new Resource Deployment Script to be created.

environmentVariables List<Property Map>

An environment_variable block as defined below. Changing this forces a new Resource Deployment Script to be created.

forceUpdateTag String

Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. Changing this forces a new Resource Deployment Script to be created.

identity Property Map

An identity block as defined below. Changing this forces a new Resource Deployment Script to be created.

location String

Specifies the Azure Region where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

name String

Specifies the name which should be used for this Resource Deployment Script. The name length must be from 1 to 260 characters. The name can only contain alphanumeric, underscore, parentheses, hyphen and period, and it cannot end with a period. Changing this forces a new Resource Deployment Script to be created.

outputs String

List of script outputs.

primaryScriptUri String

Uri for the script. This is the entry point for the external script. Changing this forces a new Resource Deployment Script to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Resource Deployment Script should exist. Changing this forces a new Resource Deployment Script to be created.

retentionInterval String

Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. The time duration should be between 1 hour and 26 hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created.

scriptContent String

Script body. Changing this forces a new Resource Deployment Script to be created.

storageAccount Property Map

A storage_account block as defined below. Changing this forces a new Resource Deployment Script to be created.

supportingScriptUris List<String>

Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.

tags Map<String>

A mapping of tags which should be assigned to the Resource Deployment Script.

timeout String

Maximum allowed script execution time specified in ISO 8601 format. Needs to be greater than 0 and smaller than 1 day. Defaults to P1D. Changing this forces a new Resource Deployment Script to be created.

version String

Azure PowerShell module version to be used. The supported versions are 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 8.0, 8.1, 8.2, 8.3, 9.0. Changing this forces a new Resource Deployment Script to be created.

Supporting Types

ResourceDeploymentScriptPowerShellContainer

ContainerGroupName string

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

ContainerGroupName string

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

containerGroupName String

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

containerGroupName string

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

container_group_name str

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

containerGroupName String

Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.

ResourceDeploymentScriptPowerShellEnvironmentVariable

Name string

Specifies the name of the environment variable.

SecureValue string

Specifies the value of the secure environment variable.

Value string

Specifies the value of the environment variable.

Name string

Specifies the name of the environment variable.

SecureValue string

Specifies the value of the secure environment variable.

Value string

Specifies the value of the environment variable.

name String

Specifies the name of the environment variable.

secureValue String

Specifies the value of the secure environment variable.

value String

Specifies the value of the environment variable.

name string

Specifies the name of the environment variable.

secureValue string

Specifies the value of the secure environment variable.

value string

Specifies the value of the environment variable.

name str

Specifies the name of the environment variable.

secure_value str

Specifies the value of the secure environment variable.

value str

Specifies the value of the environment variable.

name String

Specifies the name of the environment variable.

secureValue String

Specifies the value of the secure environment variable.

value String

Specifies the value of the environment variable.

ResourceDeploymentScriptPowerShellIdentity

IdentityIds List<string>

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

Type string

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

IdentityIds []string

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

Type string

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

identityIds List<String>

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

type String

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

identityIds string[]

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

type string

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

identity_ids Sequence[str]

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

type str

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

identityIds List<String>

Specifies the list of user-assigned managed identity IDs associated with the resource. Changing this forces a new resource to be created.

type String

Type of the managed identity. The only possible value is UserAssigned. Changing this forces a new resource to be created.

ResourceDeploymentScriptPowerShellStorageAccount

Key string

Specifies the storage account access key.

Name string

Specifies the storage account name.

Key string

Specifies the storage account access key.

Name string

Specifies the storage account name.

key String

Specifies the storage account access key.

name String

Specifies the storage account name.

key string

Specifies the storage account access key.

name string

Specifies the storage account name.

key str

Specifies the storage account access key.

name str

Specifies the storage account name.

key String

Specifies the storage account access key.

name String

Specifies the storage account name.

Import

Resource Deployment Script can be imported using the resource id, e.g.

 $ pulumi import azure:core/resourceDeploymentScriptPowerShell:ResourceDeploymentScriptPowerShell example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Resources/deploymentScripts/script1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.