Microsoft.AVS privateClouds/scriptExecutions

ARM template resource definition

The privateClouds/scriptExecutions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/scriptExecutions resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/scriptExecutions",
  "apiVersion": "2022-05-01",
  "name": "string",
  "properties": {
    "failureReason": "string",
    "hiddenParameters": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ScriptExecutionParameter objects
      }
    ],
    "namedOutputs": {},
    "output": [ "string" ],
    "parameters": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ScriptExecutionParameter objects
      }
    ],
    "retention": "string",
    "scriptCmdletId": "string",
    "timeout": "string"
  }
}

ScriptExecutionParameter objects

Set the type property to specify the type of object.

For Credential, use:

  "type": "Credential",
  "password": "string",
  "username": "string"

For SecureValue, use:

  "type": "SecureValue",
  "secureValue": "string"

For Value, use:

  "type": "Value",
  "value": "string"

Property values

privateClouds/scriptExecutions

Name Description Value
type The resource type 'Microsoft.AVS/privateClouds/scriptExecutions'
apiVersion The resource api version '2022-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties The properties of a script execution resource ScriptExecutionProperties

ScriptExecutionProperties

Name Description Value
failureReason Error message if the script was able to run, but if the script itself had errors or powershell threw an exception string
hiddenParameters Parameters that will be hidden/not visible to ARM, such as passwords and credentials ScriptExecutionParameter[]
namedOutputs User-defined dictionary. object
output Standard output stream from the powershell execution string[]
parameters Parameters the script will accept ScriptExecutionParameter[]
retention Time to live for the resource. If not provided, will be available for 60 days string
scriptCmdletId A reference to the script cmdlet resource if user is running a AVS script string
timeout Time limit for execution string (required)

ScriptExecutionParameter

Name Description Value
name The parameter name string (required)
type Set the object type Credential
SecureValue
Value (required)

PSCredentialExecutionParameter

Name Description Value
type The type of execution parameter 'Credential' (required)
password password for login string
username username for login string

ScriptSecureStringExecutionParameter

Name Description Value
type The type of execution parameter 'SecureValue' (required)
secureValue A secure value for the passed parameter, not to be stored in logs string

ScriptStringExecutionParameter

Name Description Value
type The type of execution parameter 'Value' (required)
value The value for the passed parameter string