Share via

az scvmm cloud

Note

This reference is part of the scvmm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az scvmm cloud command. Learn more about extensions.

Manage Arc for SCVMM Cloud resources.

Commands

Name Description Type Status
az scvmm cloud create

Create cloud resource.

 Extension GA
az scvmm cloud delete

Delete cloud resource.

 Extension GA
az scvmm cloud list

Retrieve a list of clouds.

 Extension GA
az scvmm cloud show

Get details of a cloud.

 Extension GA
az scvmm cloud update

Update cloud resource.

 Extension GA
az scvmm cloud wait

Place the CLI in a waiting state until a condition of the cloud is met.

 Extension GA

az scvmm cloud create

Create cloud resource.

az scvmm cloud create --custom-___location
                      --___location
                      --name
                      --resource-group
                      [--inventory-item]
                      [--no-wait]
                      [--tags]
                      [--uuid]
                      [--vmmserver]

Examples

Create a cloud

az scvmm cloud create --subscription contoso-sub --resource-group contoso-rg --___location eastus --custom-___location contoso-cl --vmmserver contoso-vmmserver --inventory-item 01234567-0123-0123-0123-0123456789ab --name contoso-cloud

Required Parameters

--custom-___location

Name or ID of the custom ___location that will manage this resource.

--___location -l

Location. Values from: az account list-locations. You can configure the default ___location using az configure --defaults ___location=<___location>.

--name -n

Name of the resource.

--resource-group -g

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

Optional Parameters

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

--inventory-item -i

Name or ID of the inventory item.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--uuid

The ID of the resource created in the VMM.

--vmmserver -v

Name or ID of the vmmserver that is managing this resource.

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 scvmm cloud delete

Delete cloud resource.

az scvmm cloud delete [--force]
                      [--ids]
                      [--name]
                      [--no-wait]
                      [--resource-group]
                      [--subscription]
                      [--yes]

Examples

Delete a cloud by ARM ID

az scvmm cloud delete --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/clouds/contoso-cloud

Delete a cloud by name

az scvmm cloud delete --subscription contoso-sub --resource-group contoso-rg --name contoso-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.

--force

Force the resource to be deleted from azure.

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

Name of the resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--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
--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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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

az scvmm cloud list

Retrieve a list of clouds.

az scvmm cloud list [--resource-group]

Examples

Retrieve a list of clouds present in a resource group

az scvmm cloud list --subscription contoso-sub --resource-group contoso-rg

Retrieve a list of clouds present in a subscription

az scvmm cloud list --subscription contoso-sub

Optional Parameters

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

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

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 scvmm cloud show

Get details of a cloud.

az scvmm cloud show [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

Examples

Get details of a cloud by ARM ID

az scvmm cloud show --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/clouds/contoso-cloud

Get details of a cloud by name

az scvmm cloud show --subscription contoso-sub --resource-group contoso-rg --name contoso-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.

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

Name of the resource.

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

az scvmm cloud update

Update cloud resource.

az scvmm cloud update [--ids]
                      [--name]
                      [--no-wait]
                      [--resource-group]
                      [--subscription]
                      [--tags]

Examples

Update a cloud by ARM ID

az scvmm cloud update --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/clouds/contoso-cloud --tags department=Sales

Update a cloud by name

az scvmm cloud update --subscription contoso-sub --resource-group contoso-rg --name contoso-cloud --tags department=Sales

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

Name of the resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--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
--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
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

az scvmm cloud wait

Place the CLI in a waiting state until a condition of the cloud is met.

az scvmm cloud wait --cloud-name
                    --resource-group
                    [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--interval]
                    [--timeout]
                    [--updated]

Required Parameters

--cloud-name

Name of the Cloud.

--resource-group -g

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

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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