az vmware global-reach-connection
Note
This reference is part of the vmware extension for the Azure CLI (version 2.51.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
Name of the global reach connection in the private cloud.
The name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Authorization key from the peer express route used for the global reach connection.
The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection.
Do not wait for the long-running operation to finish.
Identifier of the ExpressRoute Circuit to peer with in the global reach connection.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Name of the global reach connection in the private cloud.
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.
Do not wait for the long-running operation to finish.
The name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
The name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Name of the global reach connection in the private cloud.
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.
The name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Name of the global reach connection in the private cloud.
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.
Polling interval in seconds.
The name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for