Share via


az vmware global-reach-connection

Note

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

Commands to manage global reach connections in a private cloud.

Commands

Name Description Type Status
az vmware global-reach-connection create

Create a global reach connection in a private cloud.

Extension GA
az vmware global-reach-connection delete

Delete a global reach connection in a private cloud.

Extension GA
az vmware global-reach-connection list

List global reach connections in a private cloud.

Extension GA
az vmware global-reach-connection show

Get a global reach connection by name in a private cloud.

Extension GA
az vmware global-reach-connection wait

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

Extension GA

az vmware global-reach-connection create

Create a global reach connection in a private cloud.

az vmware global-reach-connection create --global-reach-connection-name
                                         --private-cloud
                                         --resource-group
                                         [--authorization-key]
                                         [--express-route-id]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--peer-express-route-circuit]

Required Parameters

--global-reach-connection-name --name -n

Name of the global reach connection in the private cloud.

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

--authorization-key

Authorization key from the peer express route used for the global reach connection.

--express-route-id

The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peer-express-route-circuit

Identifier of the ExpressRoute Circuit to peer with in the global reach connection.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 global-reach-connection delete

Delete a global reach connection in a private cloud.

az vmware global-reach-connection delete [--global-reach-connection-name]
                                         [--ids]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--private-cloud]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Optional Parameters

--global-reach-connection-name --name -n

Name of the global reach connection in the private cloud.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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>.

--subscription

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

--yes -y

Do not prompt for confirmation.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 global-reach-connection list

List global reach connections in a private cloud.

az vmware global-reach-connection list --private-cloud
                                       --resource-group
                                       [--max-items]
                                       [--next-token]

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

Optional Parameters

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

--next-token

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 global-reach-connection show

Get a global reach connection by name in a private cloud.

az vmware global-reach-connection show [--global-reach-connection-name]
                                       [--ids]
                                       [--private-cloud]
                                       [--resource-group]
                                       [--subscription]

Optional Parameters

--global-reach-connection-name --name -n

Name of the global reach connection in the private cloud.

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

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 global-reach-connection wait

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

az vmware global-reach-connection wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--global-reach-connection-name]
                                       [--ids]
                                       [--interval]
                                       [--private-cloud]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--global-reach-connection-name --name -n

Name of the global reach connection in the private cloud.

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

--interval

Polling interval in seconds.

Default value: 30
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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

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