azure-native.resources.AzurePowerShellScript
Explore with Pulumi AI
Object model for the Azure PowerShell script. Azure REST API version: 2020-10-01. Prior API version in Azure Native 1.x: 2020-10-01.
Example Usage
DeploymentScriptsCreateNoUserManagedIdentity
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var azurePowerShellScript = new AzureNative.Resources.AzurePowerShellScript("azurePowerShellScript", new()
{
Arguments = "-Location 'westus' -Name \"*rg2\"",
AzPowerShellVersion = "1.7.0",
CleanupPreference = AzureNative.Resources.CleanupOptions.Always,
Kind = "AzurePowerShell",
Location = "westus",
ResourceGroupName = "script-rg",
RetentionInterval = "PT7D",
ScriptContent = "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
ScriptName = "MyDeploymentScript",
SupportingScriptUris = new[]
{
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script",
},
Timeout = "PT1H",
});
});
package main
import (
resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := resources.NewAzurePowerShellScript(ctx, "azurePowerShellScript", &resources.AzurePowerShellScriptArgs{
Arguments: pulumi.String("-Location 'westus' -Name \"*rg2\""),
AzPowerShellVersion: pulumi.String("1.7.0"),
CleanupPreference: pulumi.String(resources.CleanupOptionsAlways),
Kind: pulumi.String("AzurePowerShell"),
Location: pulumi.String("westus"),
ResourceGroupName: pulumi.String("script-rg"),
RetentionInterval: pulumi.String("PT7D"),
ScriptContent: pulumi.String("Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name"),
ScriptName: pulumi.String("MyDeploymentScript"),
SupportingScriptUris: pulumi.StringArray{
pulumi.String("https://uri1.to.supporting.script"),
pulumi.String("https://uri2.to.supporting.script"),
},
Timeout: pulumi.String("PT1H"),
})
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.azurenative.resources.AzurePowerShellScript;
import com.pulumi.azurenative.resources.AzurePowerShellScriptArgs;
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 azurePowerShellScript = new AzurePowerShellScript("azurePowerShellScript", AzurePowerShellScriptArgs.builder()
.arguments("-Location 'westus' -Name \"*rg2\"")
.azPowerShellVersion("1.7.0")
.cleanupPreference("Always")
.kind("AzurePowerShell")
.location("westus")
.resourceGroupName("script-rg")
.retentionInterval("PT7D")
.scriptContent("Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name")
.scriptName("MyDeploymentScript")
.supportingScriptUris(
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script")
.timeout("PT1H")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
azure_power_shell_script = azure_native.resources.AzurePowerShellScript("azurePowerShellScript",
arguments="-Location 'westus' -Name \"*rg2\"",
az_power_shell_version="1.7.0",
cleanup_preference=azure_native.resources.CleanupOptions.ALWAYS,
kind="AzurePowerShell",
location="westus",
resource_group_name="script-rg",
retention_interval="PT7D",
script_content="Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
script_name="MyDeploymentScript",
supporting_script_uris=[
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script",
],
timeout="PT1H")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const azurePowerShellScript = new azure_native.resources.AzurePowerShellScript("azurePowerShellScript", {
arguments: "-Location 'westus' -Name \"*rg2\"",
azPowerShellVersion: "1.7.0",
cleanupPreference: azure_native.resources.CleanupOptions.Always,
kind: "AzurePowerShell",
location: "westus",
resourceGroupName: "script-rg",
retentionInterval: "PT7D",
scriptContent: "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
scriptName: "MyDeploymentScript",
supportingScriptUris: [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script",
],
timeout: "PT1H",
});
resources:
azurePowerShellScript:
type: azure-native:resources:AzurePowerShellScript
properties:
arguments: -Location 'westus' -Name "*rg2"
azPowerShellVersion: 1.7.0
cleanupPreference: Always
kind: AzurePowerShell
location: westus
resourceGroupName: script-rg
retentionInterval: PT7D
scriptContent: Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name
scriptName: MyDeploymentScript
supportingScriptUris:
- https://uri1.to.supporting.script
- https://uri2.to.supporting.script
timeout: PT1H
Create AzurePowerShellScript Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AzurePowerShellScript(name: string, args: AzurePowerShellScriptArgs, opts?: CustomResourceOptions);
@overload
def AzurePowerShellScript(resource_name: str,
args: AzurePowerShellScriptArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AzurePowerShellScript(resource_name: str,
opts: Optional[ResourceOptions] = None,
az_power_shell_version: Optional[str] = None,
retention_interval: Optional[str] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
cleanup_preference: Optional[Union[str, CleanupOptions]] = None,
identity: Optional[ManagedServiceIdentityArgs] = None,
environment_variables: Optional[Sequence[EnvironmentVariableArgs]] = None,
arguments: Optional[str] = None,
primary_script_uri: Optional[str] = None,
container_settings: Optional[ContainerConfigurationArgs] = None,
force_update_tag: Optional[str] = None,
script_content: Optional[str] = None,
script_name: Optional[str] = None,
storage_account_settings: Optional[StorageAccountConfigurationArgs] = None,
supporting_script_uris: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
timeout: Optional[str] = None)
func NewAzurePowerShellScript(ctx *Context, name string, args AzurePowerShellScriptArgs, opts ...ResourceOption) (*AzurePowerShellScript, error)
public AzurePowerShellScript(string name, AzurePowerShellScriptArgs args, CustomResourceOptions? opts = null)
public AzurePowerShellScript(String name, AzurePowerShellScriptArgs args)
public AzurePowerShellScript(String name, AzurePowerShellScriptArgs args, CustomResourceOptions options)
type: azure-native:resources:AzurePowerShellScript
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 AzurePowerShellScriptArgs
- 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 AzurePowerShellScriptArgs
- 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 AzurePowerShellScriptArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AzurePowerShellScriptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AzurePowerShellScriptArgs
- 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 azurePowerShellScriptResource = new AzureNative.Resources.AzurePowerShellScript("azurePowerShellScriptResource", new()
{
Kind = "string",
AzPowerShellVersion = "string",
RetentionInterval = "string",
ResourceGroupName = "string",
Location = "string",
CleanupPreference = "string",
Identity = new AzureNative.Resources.Inputs.ManagedServiceIdentityArgs
{
Type = "string",
UserAssignedIdentities = new[]
{
"string",
},
},
EnvironmentVariables = new[]
{
new AzureNative.Resources.Inputs.EnvironmentVariableArgs
{
Name = "string",
SecureValue = "string",
Value = "string",
},
},
Arguments = "string",
PrimaryScriptUri = "string",
ContainerSettings = new AzureNative.Resources.Inputs.ContainerConfigurationArgs
{
ContainerGroupName = "string",
},
ForceUpdateTag = "string",
ScriptContent = "string",
ScriptName = "string",
StorageAccountSettings = new AzureNative.Resources.Inputs.StorageAccountConfigurationArgs
{
StorageAccountKey = "string",
StorageAccountName = "string",
},
SupportingScriptUris = new[]
{
"string",
},
Tags =
{
{ "string", "string" },
},
Timeout = "string",
});
example, err := resources.NewAzurePowerShellScript(ctx, "azurePowerShellScriptResource", &resources.AzurePowerShellScriptArgs{
Kind: pulumi.String("string"),
AzPowerShellVersion: pulumi.String("string"),
RetentionInterval: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
CleanupPreference: pulumi.String("string"),
Identity: &resources.ManagedServiceIdentityArgs{
Type: pulumi.String("string"),
UserAssignedIdentities: pulumi.StringArray{
pulumi.String("string"),
},
},
EnvironmentVariables: resources.EnvironmentVariableArray{
&resources.EnvironmentVariableArgs{
Name: pulumi.String("string"),
SecureValue: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Arguments: pulumi.String("string"),
PrimaryScriptUri: pulumi.String("string"),
ContainerSettings: &resources.ContainerConfigurationArgs{
ContainerGroupName: pulumi.String("string"),
},
ForceUpdateTag: pulumi.String("string"),
ScriptContent: pulumi.String("string"),
ScriptName: pulumi.String("string"),
StorageAccountSettings: &resources.StorageAccountConfigurationArgs{
StorageAccountKey: pulumi.String("string"),
StorageAccountName: pulumi.String("string"),
},
SupportingScriptUris: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeout: pulumi.String("string"),
})
var azurePowerShellScriptResource = new AzurePowerShellScript("azurePowerShellScriptResource", AzurePowerShellScriptArgs.builder()
.kind("string")
.azPowerShellVersion("string")
.retentionInterval("string")
.resourceGroupName("string")
.location("string")
.cleanupPreference("string")
.identity(ManagedServiceIdentityArgs.builder()
.type("string")
.userAssignedIdentities("string")
.build())
.environmentVariables(EnvironmentVariableArgs.builder()
.name("string")
.secureValue("string")
.value("string")
.build())
.arguments("string")
.primaryScriptUri("string")
.containerSettings(ContainerConfigurationArgs.builder()
.containerGroupName("string")
.build())
.forceUpdateTag("string")
.scriptContent("string")
.scriptName("string")
.storageAccountSettings(StorageAccountConfigurationArgs.builder()
.storageAccountKey("string")
.storageAccountName("string")
.build())
.supportingScriptUris("string")
.tags(Map.of("string", "string"))
.timeout("string")
.build());
azure_power_shell_script_resource = azure_native.resources.AzurePowerShellScript("azurePowerShellScriptResource",
kind="string",
az_power_shell_version="string",
retention_interval="string",
resource_group_name="string",
location="string",
cleanup_preference="string",
identity={
"type": "string",
"user_assigned_identities": ["string"],
},
environment_variables=[{
"name": "string",
"secure_value": "string",
"value": "string",
}],
arguments="string",
primary_script_uri="string",
container_settings={
"container_group_name": "string",
},
force_update_tag="string",
script_content="string",
script_name="string",
storage_account_settings={
"storage_account_key": "string",
"storage_account_name": "string",
},
supporting_script_uris=["string"],
tags={
"string": "string",
},
timeout="string")
const azurePowerShellScriptResource = new azure_native.resources.AzurePowerShellScript("azurePowerShellScriptResource", {
kind: "string",
azPowerShellVersion: "string",
retentionInterval: "string",
resourceGroupName: "string",
location: "string",
cleanupPreference: "string",
identity: {
type: "string",
userAssignedIdentities: ["string"],
},
environmentVariables: [{
name: "string",
secureValue: "string",
value: "string",
}],
arguments: "string",
primaryScriptUri: "string",
containerSettings: {
containerGroupName: "string",
},
forceUpdateTag: "string",
scriptContent: "string",
scriptName: "string",
storageAccountSettings: {
storageAccountKey: "string",
storageAccountName: "string",
},
supportingScriptUris: ["string"],
tags: {
string: "string",
},
timeout: "string",
});
type: azure-native:resources:AzurePowerShellScript
properties:
arguments: string
azPowerShellVersion: string
cleanupPreference: string
containerSettings:
containerGroupName: string
environmentVariables:
- name: string
secureValue: string
value: string
forceUpdateTag: string
identity:
type: string
userAssignedIdentities:
- string
kind: string
location: string
primaryScriptUri: string
resourceGroupName: string
retentionInterval: string
scriptContent: string
scriptName: string
storageAccountSettings:
storageAccountKey: string
storageAccountName: string
supportingScriptUris:
- string
tags:
string: string
timeout: string
AzurePowerShellScript Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AzurePowerShellScript resource accepts the following input properties:
- Az
Power stringShell Version - Azure PowerShell module version to be used.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- Arguments string
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- Cleanup
Preference string | Pulumi.Azure Native. Resources. Cleanup Options - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- Container
Settings Pulumi.Azure Native. Resources. Inputs. Container Configuration - Container settings.
- Environment
Variables List<Pulumi.Azure Native. Resources. Inputs. Environment Variable> - The environment variables to pass over to the script.
- 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.
- Identity
Pulumi.
Azure Native. Resources. Inputs. Managed Service Identity - Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- Location string
- The location of the ACI and the storage account for the deployment script.
- Primary
Script stringUri - Uri for the script. This is the entry point for the external script.
- Script
Content string - Script body.
- Script
Name string - Name of the deployment script.
- Storage
Account Pulumi.Settings Azure Native. Resources. Inputs. Storage Account Configuration - Storage Account settings.
- Supporting
Script List<string>Uris - Supporting files for the external script.
- Dictionary<string, string>
- Resource tags.
- Timeout string
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
- Az
Power stringShell Version - Azure PowerShell module version to be used.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- Arguments string
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- Cleanup
Preference string | CleanupOptions - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- Container
Settings ContainerConfiguration Args - Container settings.
- Environment
Variables []EnvironmentVariable Args - The environment variables to pass over to the script.
- 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.
- Identity
Managed
Service Identity Args - Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- Location string
- The location of the ACI and the storage account for the deployment script.
- Primary
Script stringUri - Uri for the script. This is the entry point for the external script.
- Script
Content string - Script body.
- Script
Name string - Name of the deployment script.
- Storage
Account StorageSettings Account Configuration Args - Storage Account settings.
- Supporting
Script []stringUris - Supporting files for the external script.
- map[string]string
- Resource tags.
- Timeout string
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
- az
Power StringShell Version - Azure PowerShell module version to be used.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- arguments String
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- cleanup
Preference String | CleanupOptions - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- container
Settings ContainerConfiguration - Container settings.
- environment
Variables List<EnvironmentVariable> - The environment variables to pass over to the script.
- 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.
- identity
Managed
Service Identity - Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- location String
- The location of the ACI and the storage account for the deployment script.
- primary
Script StringUri - Uri for the script. This is the entry point for the external script.
- script
Content String - Script body.
- script
Name String - Name of the deployment script.
- storage
Account StorageSettings Account Configuration - Storage Account settings.
- supporting
Script List<String>Uris - Supporting files for the external script.
- Map<String,String>
- Resource tags.
- timeout String
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
- az
Power stringShell Version - Azure PowerShell module version to be used.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- arguments string
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- cleanup
Preference string | CleanupOptions - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- container
Settings ContainerConfiguration - Container settings.
- environment
Variables EnvironmentVariable[] - The environment variables to pass over to the script.
- 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.
- identity
Managed
Service Identity - Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- location string
- The location of the ACI and the storage account for the deployment script.
- primary
Script stringUri - Uri for the script. This is the entry point for the external script.
- script
Content string - Script body.
- script
Name string - Name of the deployment script.
- storage
Account StorageSettings Account Configuration - Storage Account settings.
- supporting
Script string[]Uris - Supporting files for the external script.
- {[key: string]: string}
- Resource tags.
- timeout string
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
- az_
power_ strshell_ version - Azure PowerShell module version to be used.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- arguments str
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- cleanup_
preference str | CleanupOptions - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- container_
settings ContainerConfiguration Args - Container settings.
- environment_
variables Sequence[EnvironmentVariable Args] - The environment variables to pass over to the script.
- 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.
- identity
Managed
Service Identity Args - Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- location str
- The location of the ACI and the storage account for the deployment script.
- primary_
script_ struri - Uri for the script. This is the entry point for the external script.
- script_
content str - Script body.
- script_
name str - Name of the deployment script.
- storage_
account_ Storagesettings Account Configuration Args - Storage Account settings.
- supporting_
script_ Sequence[str]uris - Supporting files for the external script.
- Mapping[str, str]
- Resource tags.
- timeout str
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
- az
Power StringShell Version - Azure PowerShell module version to be used.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- 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. Duration is based on ISO 8601 pattern (for example P1D means one day).
- arguments String
- Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2'
- cleanup
Preference String | "Always" | "OnSuccess" | "On Expiration" - The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.
- container
Settings Property Map - Container settings.
- environment
Variables List<Property Map> - The environment variables to pass over to the script.
- 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.
- identity Property Map
- Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
- location String
- The location of the ACI and the storage account for the deployment script.
- primary
Script StringUri - Uri for the script. This is the entry point for the external script.
- script
Content String - Script body.
- script
Name String - Name of the deployment script.
- storage
Account Property MapSettings - Storage Account settings.
- supporting
Script List<String>Uris - Supporting files for the external script.
- Map<String>
- Resource tags.
- timeout String
- Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D
Outputs
All input properties are implicitly available as output properties. Additionally, the AzurePowerShellScript resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Name of this resource.
- Outputs Dictionary<string, object>
- List of script outputs.
- Provisioning
State string - State of the script execution. This only appears in the response.
- Status
Pulumi.
Azure Native. Resources. Outputs. Script Status Response - Contains the results of script execution.
- System
Data Pulumi.Azure Native. Resources. Outputs. System Data Response - The system metadata related to this resource.
- Type string
- Type of this resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Name of this resource.
- Outputs map[string]interface{}
- List of script outputs.
- Provisioning
State string - State of the script execution. This only appears in the response.
- Status
Script
Status Response - Contains the results of script execution.
- System
Data SystemData Response - The system metadata related to this resource.
- Type string
- Type of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Name of this resource.
- outputs Map<String,Object>
- List of script outputs.
- provisioning
State String - State of the script execution. This only appears in the response.
- status
Script
Status Response - Contains the results of script execution.
- system
Data SystemData Response - The system metadata related to this resource.
- type String
- Type of this resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Name of this resource.
- outputs {[key: string]: any}
- List of script outputs.
- provisioning
State string - State of the script execution. This only appears in the response.
- status
Script
Status Response - Contains the results of script execution.
- system
Data SystemData Response - The system metadata related to this resource.
- type string
- Type of this resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Name of this resource.
- outputs Mapping[str, Any]
- List of script outputs.
- provisioning_
state str - State of the script execution. This only appears in the response.
- status
Script
Status Response - Contains the results of script execution.
- system_
data SystemData Response - The system metadata related to this resource.
- type str
- Type of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Name of this resource.
- outputs Map<Any>
- List of script outputs.
- provisioning
State String - State of the script execution. This only appears in the response.
- status Property Map
- Contains the results of script execution.
- system
Data Property Map - The system metadata related to this resource.
- type String
- Type of this resource.
Supporting Types
CleanupOptions, CleanupOptionsArgs
- Always
- Always
- On
Success - OnSuccess
- On
Expiration - OnExpiration
- Cleanup
Options Always - Always
- Cleanup
Options On Success - OnSuccess
- Cleanup
Options On Expiration - OnExpiration
- Always
- Always
- On
Success - OnSuccess
- On
Expiration - OnExpiration
- Always
- Always
- On
Success - OnSuccess
- On
Expiration - OnExpiration
- ALWAYS
- Always
- ON_SUCCESS
- OnSuccess
- ON_EXPIRATION
- OnExpiration
- "Always"
- Always
- "On
Success" - OnSuccess
- "On
Expiration" - OnExpiration
ContainerConfiguration, ContainerConfigurationArgs
- Container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- Container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group StringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container_
group_ strname - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group StringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
ContainerConfigurationResponse, ContainerConfigurationResponseArgs
- Container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- Container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group StringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group stringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container_
group_ strname - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
- container
Group StringName - Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.
EnvironmentVariable, EnvironmentVariableArgs
- Name string
- The name of the environment variable.
- Secure
Value string - The value of the secure environment variable.
- Value string
- The value of the environment variable.
- Name string
- The name of the environment variable.
- Secure
Value string - The value of the secure environment variable.
- Value string
- The value of the environment variable.
- name String
- The name of the environment variable.
- secure
Value String - The value of the secure environment variable.
- value String
- The value of the environment variable.
- name string
- The name of the environment variable.
- secure
Value string - The value of the secure environment variable.
- value string
- The value of the environment variable.
- name str
- The name of the environment variable.
- secure_
value str - The value of the secure environment variable.
- value str
- The value of the environment variable.
- name String
- The name of the environment variable.
- secure
Value String - The value of the secure environment variable.
- value String
- The value of the environment variable.
EnvironmentVariableResponse, EnvironmentVariableResponseArgs
- Name string
- The name of the environment variable.
- Secure
Value string - The value of the secure environment variable.
- Value string
- The value of the environment variable.
- Name string
- The name of the environment variable.
- Secure
Value string - The value of the secure environment variable.
- Value string
- The value of the environment variable.
- name String
- The name of the environment variable.
- secure
Value String - The value of the secure environment variable.
- value String
- The value of the environment variable.
- name string
- The name of the environment variable.
- secure
Value string - The value of the secure environment variable.
- value string
- The value of the environment variable.
- name str
- The name of the environment variable.
- secure_
value str - The value of the secure environment variable.
- value str
- The value of the environment variable.
- name String
- The name of the environment variable.
- secure
Value String - The value of the secure environment variable.
- value String
- The value of the environment variable.
ErrorAdditionalInfoResponse, ErrorAdditionalInfoResponseArgs
ErrorDetailResponse, ErrorDetailResponseArgs
- Additional
Info List<Pulumi.Azure Native. Resources. Inputs. Error Additional Info Response> - The error additional info.
- Code string
- The error code.
- Details
List<Pulumi.
Azure Native. Resources. Inputs. Error Detail Response> - The error details.
- Message string
- The error message.
- Target string
- The error target.
- Additional
Info []ErrorAdditional Info Response - The error additional info.
- Code string
- The error code.
- Details
[]Error
Detail Response - The error details.
- Message string
- The error message.
- Target string
- The error target.
- additional
Info List<ErrorAdditional Info Response> - The error additional info.
- code String
- The error code.
- details
List<Error
Detail Response> - The error details.
- message String
- The error message.
- target String
- The error target.
- additional
Info ErrorAdditional Info Response[] - The error additional info.
- code string
- The error code.
- details
Error
Detail Response[] - The error details.
- message string
- The error message.
- target string
- The error target.
- additional_
info Sequence[ErrorAdditional Info Response] - The error additional info.
- code str
- The error code.
- details
Sequence[Error
Detail Response] - The error details.
- message str
- The error message.
- target str
- The error target.
- additional
Info List<Property Map> - The error additional info.
- code String
- The error code.
- details List<Property Map>
- The error details.
- message String
- The error message.
- target String
- The error target.
ErrorResponseResponse, ErrorResponseResponseArgs
- Additional
Info List<Pulumi.Azure Native. Resources. Inputs. Error Additional Info Response> - The error additional info.
- Code string
- The error code.
- Details
List<Pulumi.
Azure Native. Resources. Inputs. Error Response Response> - The error details.
- Error
Pulumi.
Azure Native. Resources. Inputs. Error Detail Response - The error object.
- Message string
- The error message.
- Target string
- The error target.
- Additional
Info []ErrorAdditional Info Response - The error additional info.
- Code string
- The error code.
- Details
[]Error
Response Response - The error details.
- Error
Error
Detail Response - The error object.
- Message string
- The error message.
- Target string
- The error target.
- additional
Info List<ErrorAdditional Info Response> - The error additional info.
- code String
- The error code.
- details
List<Error
Response Response> - The error details.
- error
Error
Detail Response - The error object.
- message String
- The error message.
- target String
- The error target.
- additional
Info ErrorAdditional Info Response[] - The error additional info.
- code string
- The error code.
- details
Error
Response Response[] - The error details.
- error
Error
Detail Response - The error object.
- message string
- The error message.
- target string
- The error target.
- additional_
info Sequence[ErrorAdditional Info Response] - The error additional info.
- code str
- The error code.
- details
Sequence[Error
Response Response] - The error details.
- error
Error
Detail Response - The error object.
- message str
- The error message.
- target str
- The error target.
- additional
Info List<Property Map> - The error additional info.
- code String
- The error code.
- details List<Property Map>
- The error details.
- error Property Map
- The error object.
- message String
- The error message.
- target String
- The error target.
ManagedServiceIdentity, ManagedServiceIdentityArgs
- Type
string | Pulumi.
Azure Native. Resources. Managed Service Identity Type - Type of the managed identity.
- User
Assigned List<string>Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- Type
string | Managed
Service Identity Type - Type of the managed identity.
- User
Assigned []stringIdentities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- type
String | Managed
Service Identity Type - Type of the managed identity.
- user
Assigned List<String>Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- type
string | Managed
Service Identity Type - Type of the managed identity.
- user
Assigned string[]Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- type
str | Managed
Service Identity Type - Type of the managed identity.
- user_
assigned_ Sequence[str]identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- type
String | "User
Assigned" - Type of the managed identity.
- user
Assigned List<String>Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
ManagedServiceIdentityResponse, ManagedServiceIdentityResponseArgs
- Tenant
Id string - ID of the Azure Active Directory.
- Type string
- Type of the managed identity.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Resources. Inputs. User Assigned Identity Response> - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- Tenant
Id string - ID of the Azure Active Directory.
- Type string
- Type of the managed identity.
- User
Assigned map[string]UserIdentities Assigned Identity Response - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- tenant
Id String - ID of the Azure Active Directory.
- type String
- Type of the managed identity.
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- tenant
Id string - ID of the Azure Active Directory.
- type string
- Type of the managed identity.
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- tenant_
id str - ID of the Azure Active Directory.
- type str
- Type of the managed identity.
- user_
assigned_ Mapping[str, Useridentities Assigned Identity Response] - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
- tenant
Id String - ID of the Azure Active Directory.
- type String
- Type of the managed identity.
- user
Assigned Map<Property Map>Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
ManagedServiceIdentityType, ManagedServiceIdentityTypeArgs
- User
Assigned - UserAssigned
- Managed
Service Identity Type User Assigned - UserAssigned
- User
Assigned - UserAssigned
- User
Assigned - UserAssigned
- USER_ASSIGNED
- UserAssigned
- "User
Assigned" - UserAssigned
ScriptStatusResponse, ScriptStatusResponseArgs
- Container
Instance stringId - ACI resource Id.
- End
Time string - End time of the script execution.
- Expiration
Time string - Time the deployment script resource will expire.
- Start
Time string - Start time of the script execution.
- Storage
Account stringId - Storage account resource Id.
- Error
Pulumi.
Azure Native. Resources. Inputs. Error Response Response - Error that is relayed from the script execution.
- Container
Instance stringId - ACI resource Id.
- End
Time string - End time of the script execution.
- Expiration
Time string - Time the deployment script resource will expire.
- Start
Time string - Start time of the script execution.
- Storage
Account stringId - Storage account resource Id.
- Error
Error
Response Response - Error that is relayed from the script execution.
- container
Instance StringId - ACI resource Id.
- end
Time String - End time of the script execution.
- expiration
Time String - Time the deployment script resource will expire.
- start
Time String - Start time of the script execution.
- storage
Account StringId - Storage account resource Id.
- error
Error
Response Response - Error that is relayed from the script execution.
- container
Instance stringId - ACI resource Id.
- end
Time string - End time of the script execution.
- expiration
Time string - Time the deployment script resource will expire.
- start
Time string - Start time of the script execution.
- storage
Account stringId - Storage account resource Id.
- error
Error
Response Response - Error that is relayed from the script execution.
- container_
instance_ strid - ACI resource Id.
- end_
time str - End time of the script execution.
- expiration_
time str - Time the deployment script resource will expire.
- start_
time str - Start time of the script execution.
- storage_
account_ strid - Storage account resource Id.
- error
Error
Response Response - Error that is relayed from the script execution.
- container
Instance StringId - ACI resource Id.
- end
Time String - End time of the script execution.
- expiration
Time String - Time the deployment script resource will expire.
- start
Time String - Start time of the script execution.
- storage
Account StringId - Storage account resource Id.
- error Property Map
- Error that is relayed from the script execution.
StorageAccountConfiguration, StorageAccountConfigurationArgs
- Storage
Account stringKey - The storage account access key.
- Storage
Account stringName - The storage account name.
- Storage
Account stringKey - The storage account access key.
- Storage
Account stringName - The storage account name.
- storage
Account StringKey - The storage account access key.
- storage
Account StringName - The storage account name.
- storage
Account stringKey - The storage account access key.
- storage
Account stringName - The storage account name.
- storage_
account_ strkey - The storage account access key.
- storage_
account_ strname - The storage account name.
- storage
Account StringKey - The storage account access key.
- storage
Account StringName - The storage account name.
StorageAccountConfigurationResponse, StorageAccountConfigurationResponseArgs
- Storage
Account stringKey - The storage account access key.
- Storage
Account stringName - The storage account name.
- Storage
Account stringKey - The storage account access key.
- Storage
Account stringName - The storage account name.
- storage
Account StringKey - The storage account access key.
- storage
Account StringName - The storage account name.
- storage
Account stringKey - The storage account access key.
- storage
Account stringName - The storage account name.
- storage_
account_ strkey - The storage account access key.
- storage_
account_ strname - The storage account name.
- storage
Account StringKey - The storage account access key.
- storage
Account StringName - The storage account name.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserAssignedIdentityResponse, UserAssignedIdentityResponseArgs
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this identity.
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this identity.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this identity.
- client
Id string - Client App Id associated with this identity.
- principal
Id string - Azure Active Directory principal ID associated with this identity.
- client_
id str - Client App Id associated with this identity.
- principal_
id str - Azure Active Directory principal ID associated with this identity.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this identity.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:resources:AzurePowerShellScript myresource1 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0