az vmware script-execution

Note

This reference is part of the vmware extension for the Azure CLI (version 2.11.0 or higher). The extension will automatically install the first time you run an az vmware script-execution command. Learn more about extensions.

Commands to manage script executions in a private cloud.

Commands

az vmware script-execution create	Create or update a script execution in a private cloud.
az vmware script-execution delete	Delete a script execution in a private cloud.
az vmware script-execution list	List script executions in a private cloud.
az vmware script-execution show	Get an script execution by name in a private cloud.

az vmware script-execution create

Create or update a script execution in a private cloud.

az vmware script-execution create --name
                                  --private-cloud
                                  --resource-group
                                  --timeout
                                  [--failure-reason]
                                  [--hidden-parameter]
                                  [--named-outputs]
                                  [--out]
                                  [--parameter]
                                  [--retention]
                                  [--script-cmdlet-id]

Examples

Create a script execution.

az vmware script-execution create --resource-group group1 --private-cloud cloud1 --name addSsoServer --script-cmdlet-id "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource" --timeout P0Y0M0DT0H60M60S --retention P0Y0M60DT0H60M60S --parameter name=DomainName type=Value value=placeholderDomain.local --parameter name=BaseUserDN type=Value "value=DC=placeholder, DC=placeholder" --hidden-parameter name=Password type=SecureValue secureValue=PlaceholderPassword

Required Parameters

--name -n

Name of the script execution.

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--timeout

Time limit for execution.

Optional Parameters

--failure-reason

Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.

--hidden-parameter

Parameters that will be hidden/not visible to ARM, such as passwords and credentials.

--named-outputs

User-defined dictionary.

--out

Standard output stream from the powershell execution.

--parameter -p

Parameters the script will accept.

--retention

Time to live for the resource. If not provided, will be available for 60 days.

--script-cmdlet-id

A reference to the script cmdlet resource if user is running a AVS script.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az vmware script-execution delete

Delete a script execution in a private cloud.

az vmware script-execution delete --name
                                  --private-cloud
                                  --resource-group
                                  [--yes]

Examples

Delete a script execution.

az vmware script-execution delete --resource-group group1 --private-cloud cloud1 --name addSsoServer

Required Parameters

--name -n

Name of the script execution.

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--yes

Delete without confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az vmware script-execution list

List script executions in a private cloud.

az vmware script-execution list --private-cloud
                                --resource-group

Examples

List script executions.

az vmware script-execution list --resource-group group1 --private-cloud cloud1

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az vmware script-execution show

Get an script execution by name in a private cloud.

az vmware script-execution show --name
                                --private-cloud
                                --resource-group

Examples

Show a script execution.

az vmware script-execution show --resource-group group1 --private-cloud cloud1 --name addSsoServer

Required Parameters

--name -n

Name of the script execution.

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.