Share via

az connectedvmware vcenter

Note

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

Vcenter resource.

Commands

Name Description Type Status
az connectedvmware vcenter connect

Create vcenter resource.

 Extension GA
az connectedvmware vcenter delete

Delete vcenter resource.

 Extension GA
az connectedvmware vcenter inventory-item

Inventory item resource.

 Extension GA
az connectedvmware vcenter inventory-item list

Retrieve a list of inventory item given by resource group and vcenter name.

 Extension GA
az connectedvmware vcenter inventory-item show

Get details of a inventory item by inventory item name or id, resource-group and vcenter name.

 Extension GA
az connectedvmware vcenter list

Retrieve a list of vcenter resource of given resource group.

 Extension GA
az connectedvmware vcenter show

Get details of a vcenter resource by id, resource-group, vcenter name or subscription.

 Extension GA

az connectedvmware vcenter connect

Create vcenter resource.

az connectedvmware vcenter connect --custom-___location
                                   --___location
                                   [--fqdn]
                                   [--ids]
                                   [--name]
                                   [--no-wait]
                                   [--password]
                                   [--port]
                                   [--resource-group]
                                   [--subscription]
                                   [--tags]
                                   [--username]

Examples

Connect to vcenter

az connectedvmware vcenter connect --custom-___location "custom ___location name"                --fqdn "vcenter fqdn/ip" --username "vcenter user name" --password "vcenter password"                --resource-group "resource group name" --___location "___location name" --name "vcenter name"

Required Parameters

--custom-___location -c

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

Optional Parameters

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

--fqdn

FQDN/IP address of the vCenter.

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

Username password credentials to use for connecting to the vCenter.

--port

The port of the vCenter.

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

--username

Username to use for connecting to the vCenter.

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 connectedvmware vcenter delete

Delete vcenter resource.

az connectedvmware vcenter delete [--force]
                                  [--ids]
                                  [--name]
                                  [--no-wait]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Examples

Delete vcenter resource

az connectedvmware vcenter delete --ids "resource id" --name "vcenter name"                --resource-group "resource group name" --subscription "Name or ID of subscription"

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

Whether force delete or not.

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

Retrieve a list of vcenter resource of given resource group.

az connectedvmware vcenter list [--resource-group]

Examples

Retrieve a list of vcenter resource

az connectedvmware vcenter list --resource-group "resource 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.

--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 connectedvmware vcenter show

Get details of a vcenter resource by id, resource-group, vcenter name or subscription.

az connectedvmware vcenter show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Get details of a vcenter resource

az connectedvmware vcenter show --ids "resource id" --name "vcenter name"                    --resource-group "resource group name" --subscription "Name or ID of subscription"

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