Share via

az vmware script-cmdlet

Note

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

Commands to list and show script cmdlet resources.

Commands

Name Description Type Status
az vmware script-cmdlet list

List script cmdlet resources available for a private cloud to create a script execution resource on a private cloud.

 Extension GA
az vmware script-cmdlet show

Get information about a script cmdlet resource in a specific package on a private cloud.

 Extension GA

az vmware script-cmdlet list

List script cmdlet resources available for a private cloud to create a script execution resource on a private cloud.

az vmware script-cmdlet list --private-cloud
                             --resource-group
                             --script-package
                             [--max-items]
                             [--next-token]

Examples

List script cmdlet resources.

az vmware script-cmdlet list --resource-group group1 --private-cloud cloud1 --script-package package@1.0.2

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>.

--script-package -p

Name of the script package in the private cloud.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az vmware script-cmdlet show

Get information about a script cmdlet resource in a specific package on a private cloud.

az vmware script-cmdlet show [--ids]
                             [--name --script-cmdlet-name]
                             [--private-cloud]
                             [--resource-group]
                             [--script-package]
                             [--subscription]

Examples

Show a script cmdlet.

az vmware script-cmdlet show --resource-group group1 --private-cloud cloud1 --script-package package@1.0.2 --script-cmdlet-name New-ExternalSsoDomain

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --script-cmdlet-name -n

Name of the script cmdlet resource in the script package in the private cloud.

Property Value
Parameter group: Resource Id Arguments
--private-cloud -c

Name of the private cloud.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--script-package -p

Name of the script package in the private cloud.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False