We recommend using Azure Native.
azure.core.ResourceDeploymentScriptPowerShell
Explore with Pulumi AI
Manages a Resource Deployment Script of Azure PowerShell.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleUserAssignedIdentity = new azure.authorization.UserAssignedIdentity("example", {
name: "example-uai",
location: example.location,
resourceGroupName: example.name,
});
const exampleResourceDeploymentScriptPowerShell = new azure.core.ResourceDeploymentScriptPowerShell("example", {
name: "example-rdsaps",
resourceGroupName: example.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",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_user_assigned_identity = azure.authorization.UserAssignedIdentity("example",
name="example-uai",
location=example.location,
resource_group_name=example.name)
example_resource_deployment_script_power_shell = azure.core.ResourceDeploymentScriptPowerShell("example",
name="example-rdsaps",
resource_group_name=example.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={
"type": "UserAssigned",
"identity_ids": [example_user_assigned_identity.id],
},
tags={
"key": "value",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/authorization"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleUserAssignedIdentity, err := authorization.NewUserAssignedIdentity(ctx, "example", &authorization.UserAssignedIdentityArgs{
Name: pulumi.String("example-uai"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
_, err = core.NewResourceDeploymentScriptPowerShell(ctx, "example", &core.ResourceDeploymentScriptPowerShellArgs{
Name: pulumi.String("example-rdsaps"),
ResourceGroupName: example.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)
$output = 'Hello {0}.' -f $name
Write-Output $output
$DeploymentScriptOutputs = @{}
$DeploymentScriptOutputs['text'] = $output
`),
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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleUserAssignedIdentity = new Azure.Authorization.UserAssignedIdentity("example", new()
{
Name = "example-uai",
Location = example.Location,
ResourceGroupName = example.Name,
});
var exampleResourceDeploymentScriptPowerShell = new Azure.Core.ResourceDeploymentScriptPowerShell("example", new()
{
Name = "example-rdsaps",
ResourceGroupName = example.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 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleUserAssignedIdentity = new UserAssignedIdentity("exampleUserAssignedIdentity", UserAssignedIdentityArgs.builder()
.name("example-uai")
.location(example.location())
.resourceGroupName(example.name())
.build());
var exampleResourceDeploymentScriptPowerShell = new ResourceDeploymentScriptPowerShell("exampleResourceDeploymentScriptPowerShell", ResourceDeploymentScriptPowerShellArgs.builder()
.name("example-rdsaps")
.resourceGroupName(example.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());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleUserAssignedIdentity:
type: azure:authorization:UserAssignedIdentity
name: example
properties:
name: example-uai
location: ${example.location}
resourceGroupName: ${example.name}
exampleResourceDeploymentScriptPowerShell:
type: azure:core:ResourceDeploymentScriptPowerShell
name: example
properties:
name: example-rdsaps
resourceGroupName: ${example.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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ResourceDeploymentScriptPowerShell(name: string, args: ResourceDeploymentScriptPowerShellArgs, opts?: CustomResourceOptions);
@overload
def ResourceDeploymentScriptPowerShell(resource_name: str,
args: ResourceDeploymentScriptPowerShellArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ResourceDeploymentScriptPowerShell(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
version: Optional[str] = None,
retention_interval: Optional[str] = None,
primary_script_uri: Optional[str] = None,
container: Optional[ResourceDeploymentScriptPowerShellContainerArgs] = None,
identity: Optional[ResourceDeploymentScriptPowerShellIdentityArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
cleanup_preference: Optional[str] = None,
environment_variables: Optional[Sequence[ResourceDeploymentScriptPowerShellEnvironmentVariableArgs]] = None,
force_update_tag: 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,
command_line: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var resourceDeploymentScriptPowerShellResource = new Azure.Core.ResourceDeploymentScriptPowerShell("resourceDeploymentScriptPowerShellResource", new()
{
ResourceGroupName = "string",
Version = "string",
RetentionInterval = "string",
PrimaryScriptUri = "string",
Container = new Azure.Core.Inputs.ResourceDeploymentScriptPowerShellContainerArgs
{
ContainerGroupName = "string",
},
Identity = new Azure.Core.Inputs.ResourceDeploymentScriptPowerShellIdentityArgs
{
IdentityIds = new[]
{
"string",
},
Type = "string",
},
Location = "string",
Name = "string",
CleanupPreference = "string",
EnvironmentVariables = new[]
{
new Azure.Core.Inputs.ResourceDeploymentScriptPowerShellEnvironmentVariableArgs
{
Name = "string",
SecureValue = "string",
Value = "string",
},
},
ForceUpdateTag = "string",
ScriptContent = "string",
StorageAccount = new Azure.Core.Inputs.ResourceDeploymentScriptPowerShellStorageAccountArgs
{
Key = "string",
Name = "string",
},
SupportingScriptUris = new[]
{
"string",
},
Tags =
{
{ "string", "string" },
},
Timeout = "string",
CommandLine = "string",
});
example, err := core.NewResourceDeploymentScriptPowerShell(ctx, "resourceDeploymentScriptPowerShellResource", &core.ResourceDeploymentScriptPowerShellArgs{
ResourceGroupName: pulumi.String("string"),
Version: pulumi.String("string"),
RetentionInterval: pulumi.String("string"),
PrimaryScriptUri: pulumi.String("string"),
Container: &core.ResourceDeploymentScriptPowerShellContainerArgs{
ContainerGroupName: pulumi.String("string"),
},
Identity: &core.ResourceDeploymentScriptPowerShellIdentityArgs{
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
CleanupPreference: pulumi.String("string"),
EnvironmentVariables: core.ResourceDeploymentScriptPowerShellEnvironmentVariableArray{
&core.ResourceDeploymentScriptPowerShellEnvironmentVariableArgs{
Name: pulumi.String("string"),
SecureValue: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ForceUpdateTag: pulumi.String("string"),
ScriptContent: pulumi.String("string"),
StorageAccount: &core.ResourceDeploymentScriptPowerShellStorageAccountArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
},
SupportingScriptUris: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeout: pulumi.String("string"),
CommandLine: pulumi.String("string"),
})
var resourceDeploymentScriptPowerShellResource = new ResourceDeploymentScriptPowerShell("resourceDeploymentScriptPowerShellResource", ResourceDeploymentScriptPowerShellArgs.builder()
.resourceGroupName("string")
.version("string")
.retentionInterval("string")
.primaryScriptUri("string")
.container(ResourceDeploymentScriptPowerShellContainerArgs.builder()
.containerGroupName("string")
.build())
.identity(ResourceDeploymentScriptPowerShellIdentityArgs.builder()
.identityIds("string")
.type("string")
.build())
.location("string")
.name("string")
.cleanupPreference("string")
.environmentVariables(ResourceDeploymentScriptPowerShellEnvironmentVariableArgs.builder()
.name("string")
.secureValue("string")
.value("string")
.build())
.forceUpdateTag("string")
.scriptContent("string")
.storageAccount(ResourceDeploymentScriptPowerShellStorageAccountArgs.builder()
.key("string")
.name("string")
.build())
.supportingScriptUris("string")
.tags(Map.of("string", "string"))
.timeout("string")
.commandLine("string")
.build());
resource_deployment_script_power_shell_resource = azure.core.ResourceDeploymentScriptPowerShell("resourceDeploymentScriptPowerShellResource",
resource_group_name="string",
version="string",
retention_interval="string",
primary_script_uri="string",
container={
"containerGroupName": "string",
},
identity={
"identityIds": ["string"],
"type": "string",
},
location="string",
name="string",
cleanup_preference="string",
environment_variables=[{
"name": "string",
"secureValue": "string",
"value": "string",
}],
force_update_tag="string",
script_content="string",
storage_account={
"key": "string",
"name": "string",
},
supporting_script_uris=["string"],
tags={
"string": "string",
},
timeout="string",
command_line="string")
const resourceDeploymentScriptPowerShellResource = new azure.core.ResourceDeploymentScriptPowerShell("resourceDeploymentScriptPowerShellResource", {
resourceGroupName: "string",
version: "string",
retentionInterval: "string",
primaryScriptUri: "string",
container: {
containerGroupName: "string",
},
identity: {
identityIds: ["string"],
type: "string",
},
location: "string",
name: "string",
cleanupPreference: "string",
environmentVariables: [{
name: "string",
secureValue: "string",
value: "string",
}],
forceUpdateTag: "string",
scriptContent: "string",
storageAccount: {
key: "string",
name: "string",
},
supportingScriptUris: ["string"],
tags: {
string: "string",
},
timeout: "string",
commandLine: "string",
});
type: azure:core:ResourceDeploymentScriptPowerShell
properties:
cleanupPreference: string
commandLine: string
container:
containerGroupName: string
environmentVariables:
- name: string
secureValue: string
value: string
forceUpdateTag: string
identity:
identityIds:
- string
type: string
location: string
name: string
primaryScriptUri: string
resourceGroupName: string
retentionInterval: string
scriptContent: string
storageAccount:
key: string
name: string
supportingScriptUris:
- string
tags:
string: string
timeout: string
version: string
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:
- Resource
Group stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - Version string
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created. - Cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - Command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- Container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Environment
Variables List<ResourceDeployment Script Power Shell Environment Variable> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- Primary
Script stringUri - 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 string - Script body. Changing this forces a new Resource Deployment Script to be created.
- Storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Supporting
Script List<string>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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.
- Resource
Group stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - Version string
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created. - Cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - Command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- Container
Resource
Deployment Script Power Shell Container Args - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Environment
Variables []ResourceDeployment Script Power Shell Environment Variable Args - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity Args - 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.
- Primary
Script stringUri - 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 string - Script body. Changing this forces a new Resource Deployment Script to be created.
- Storage
Account ResourceDeployment Script Power Shell Storage Account Args - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Supporting
Script []stringUris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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.
- resource
Group StringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - version String
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created. - cleanup
Preference String - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line String - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment
Variables List<ResourceDeployment Script Power Shell Environment Variable> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update StringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- primary
Script StringUri - 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 String - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script List<String>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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.
- resource
Group stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - version string
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created. - cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment
Variables ResourceDeployment Script Power Shell Environment Variable[] - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- primary
Script stringUri - 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 string - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script string[]Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- {[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_ strname - 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - version str
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. 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 toAlways
. 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
Resource
Deployment Script Power Shell Container Args - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment_
variables Sequence[ResourceDeployment Script Power Shell Environment Variable Args] - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force_
update_ strtag - 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
Resource
Deployment Script Power Shell Identity Args - 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_ struri - 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 ResourceDeployment Script Power Shell Storage Account Args - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting_
script_ Sequence[str]uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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.
- resource
Group StringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - version String
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created. - cleanup
Preference String - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line 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. - environment
Variables List<Property Map> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update StringTag - 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.
- primary
Script StringUri - 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 String - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account Property Map - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script List<String>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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:
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.
- Cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - Command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- Container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Environment
Variables List<ResourceDeployment Script Power Shell Environment Variable> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- Primary
Script stringUri - 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 stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - Script
Content string - Script body. Changing this forces a new Resource Deployment Script to be created.
- Storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Supporting
Script List<string>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created.
- Cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - Command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- Container
Resource
Deployment Script Power Shell Container Args - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Environment
Variables []ResourceDeployment Script Power Shell Environment Variable Args - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity Args - 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.
- Primary
Script stringUri - 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 stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - Script
Content string - Script body. Changing this forces a new Resource Deployment Script to be created.
- Storage
Account ResourceDeployment Script Power Shell Storage Account Args - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - Supporting
Script []stringUris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created.
- cleanup
Preference String - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line String - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment
Variables List<ResourceDeployment Script Power Shell Environment Variable> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update StringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- primary
Script StringUri - 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 StringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - script
Content String - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script List<String>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created.
- cleanup
Preference string - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line string - Command line arguments to pass to the script. Changing this forces a new Resource Deployment Script to be created.
- container
Resource
Deployment Script Power Shell Container - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment
Variables ResourceDeployment Script Power Shell Environment Variable[] - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update stringTag - 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
Resource
Deployment Script Power Shell Identity - 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.
- primary
Script stringUri - 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 stringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - script
Content string - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account ResourceDeployment Script Power Shell Storage Account - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script string[]Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- {[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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. 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 toAlways
. 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
Resource
Deployment Script Power Shell Container Args - A
container
block as defined below. Changing this forces a new Resource Deployment Script to be created. - environment_
variables Sequence[ResourceDeployment Script Power Shell Environment Variable Args] - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force_
update_ strtag - 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
Resource
Deployment Script Power Shell Identity Args - 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_ struri - 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_ strname - 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 and26
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 ResourceDeployment Script Power Shell Storage Account Args - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting_
script_ Sequence[str]uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created.
- cleanup
Preference String - Specifies the cleanup preference when the script execution gets in a terminal state. Possible values are
Always
,OnExpiration
,OnSuccess
. Defaults toAlways
. Changing this forces a new Resource Deployment Script to be created. - command
Line 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. - environment
Variables List<Property Map> - An
environment_variable
block as defined below. Changing this forces a new Resource Deployment Script to be created. - force
Update StringTag - 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.
- primary
Script StringUri - 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 StringName - 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 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 and26
hours (inclusive) and should be specified in ISO 8601 format. Changing this forces a new Resource Deployment Script to be created. - script
Content String - Script body. Changing this forces a new Resource Deployment Script to be created.
- storage
Account Property Map - A
storage_account
block as defined below. Changing this forces a new Resource Deployment Script to be created. - supporting
Script List<String>Uris - Supporting files for the external script. Changing this forces a new Resource Deployment Script to be created.
- 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
- Specifies the version of the Azure PowerShell that should be used in the format
X.Y
(e.g.9.7
). A canonical list of versions is available from the Microsoft Container Registry API. Changing this forces a new Resource Deployment Script to be created.
Supporting Types
ResourceDeploymentScriptPowerShellContainer, ResourceDeploymentScriptPowerShellContainerArgs
- Container
Group stringName - 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 stringName - 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 StringName - 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 stringName - 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_ strname - 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 StringName - Container group name, if not specified then the name will get auto-generated. For more information, please refer to the Container Configuration documentation.
ResourceDeploymentScriptPowerShellEnvironmentVariable, ResourceDeploymentScriptPowerShellEnvironmentVariableArgs
- Name string
- Specifies the name of the environment variable.
- Secure
Value 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.
- Secure
Value 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.
- secure
Value 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.
- secure
Value 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.
- secure
Value String - Specifies the value of the secure environment variable.
- value String
- Specifies the value of the environment variable.
ResourceDeploymentScriptPowerShellIdentity, ResourceDeploymentScriptPowerShellIdentityArgs
- Identity
Ids 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.
- Identity
Ids []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 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.
- identity
Ids 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.
- identity
Ids 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, ResourceDeploymentScriptPowerShellStorageAccountArgs
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.