az network manager group
Note
This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az network manager group command. Learn more about extensions.
Manage networkgroup with network.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network manager group create |
Create a network group. |
Extension | GA |
| az network manager group delete |
Delete a network group. |
Extension | GA |
| az network manager group list |
List the specified network group. |
Extension | GA |
| az network manager group show |
Get the specified network group. |
Extension | GA |
| az network manager group static-member |
Manage static members with network manager group. |
Extension | GA |
| az network manager group static-member create |
Create a static member. |
Extension | GA |
| az network manager group static-member delete |
Delete a static member. |
Extension | GA |
| az network manager group static-member list |
List the static members within a specific network group. |
Extension | GA |
| az network manager group static-member show |
Get the specified static member. |
Extension | GA |
| az network manager group update |
Update a network group. |
Extension | GA |
| az network manager group wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network manager group create
Create a network group.
az network manager group create --name
--network-manager-name
--resource-group
[--description]
[--if-match]Examples
Create/Update Azure Virtual Network Manager Network Group
az network manager group create --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --description "A sample group" --resource-group "rg1"Required Parameters
The name of the network group.
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
A description of the network group.
The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
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 network manager group delete
Delete a network group.
az network manager group delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--network-manager-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete Azure Virtual Network Manager Group
az network manager group delete --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --resource-group "rg1" --forceRequired Parameters
Optional Parameters
Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.
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 network group.
The name of the network manager.
Do not wait for the long-running operation to finish.
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 network manager group list
List the specified network group.
az network manager group list --network-manager-name
--resource-group
[--max-items]
[--next-token]
[--skip-token]
[--top]Examples
List Azure Virtual Network Manager Network Groups
az network manager group list --network-manager-name "testNetworkManager" --resource-group "rg1"Required Parameters
The name of the network manager.
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.
SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
An optional query parameter which specifies the maximum number of records to be returned by the server.
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 network manager group show
Get the specified network group.
az network manager group show [--ids]
[--name]
[--network-manager-name]
[--resource-group]
[--subscription]Examples
Get Azure Virtual Network Manager Network Group
az network manager group show --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --resource-group "rg1"Required Parameters
Optional Parameters
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 network group.
The name of the network manager.
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 network manager group update
Update a network group.
az network manager group update [--add]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--if-match]
[--name]
[--network-manager-name]
[--remove]
[--resource-group]
[--set]
[--subscription]Examples
Required Parameters
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
A description of the network group.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
The name of the network group.
The name of the network manager.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
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 network manager group wait
Place the CLI in a waiting state until a condition is met.
az network manager group wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--network-manager-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Required Parameters
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.
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 network group.
The name of the network manager.
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.
