az network custom-ip prefix
Manage custom IP prefix resources.
Name | Description | Type | Status |
---|---|---|---|
az network custom-ip prefix create |
Create a custom IP prefix resource. |
Core | GA |
az network custom-ip prefix delete |
Delete a custom IP prefix resource. |
Core | GA |
az network custom-ip prefix list |
List custom IP prefix resources. |
Core | GA |
az network custom-ip prefix show |
Get the details of a custom IP prefix resource. |
Core | GA |
az network custom-ip prefix update |
Update a custom IP prefix resource. |
Core | GA |
az network custom-ip prefix wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
Create a custom IP prefix resource.
az network custom-ip prefix create --name
--resource-group
[--asn]
[--authorization-message]
[--cidr]
[--cip-prefix-parent]
[--express-route-advertise {0, 1, f, false, n, no, t, true, y, yes}]
[--geo {AFRI, APAC, AQ, EURO, GLOBAL, LATAM, ME, NAM, OCEANIA}]
[--is-parent {0, 1, f, false, n, no, t, true, y, yes}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--prefix-type {Child, Parent, Singular}]
[--signed-message]
[--tags]
[--zone]
Create a custom IP prefix resource.
az network custom-ip prefix create --location westus2 --name MyCustomIpPrefix --resource-group MyResourceGroup
The name of the custom IP prefix.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The ASN for CIDR advertising. Should be an integer as string.
Authorization message for WAN validation.
The prefix range in CIDR notation. Should include the start address and the prefix length.
The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
Whether to do express route advertise.
The Geo for CIDR advertising. Should be an Geo code.
Denotes that resource is being created as a Parent CustomIpPrefix.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Type of custom IP prefix. Should be Singular, Parent, or Child.
Signed message for WAN validation.
Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Space-separated list of availability zones into which to provision the resource. Allowed values: 1, 2, 3. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Delete a custom IP prefix resource.
az network custom-ip prefix delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Delete a custom IP prefix resource.
az network custom-ip prefix delete --name MyCustomIpPrefix --resource-group MyResourceGroup
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 custom IP prefix.
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
.
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.
List custom IP prefix resources.
az network custom-ip prefix list [--max-items]
[--next-token]
[--resource-group]
List custom IP prefix resources.
az network custom-ip prefix list --resource-group MyResourceGroup
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Get the details of a custom IP prefix resource.
az network custom-ip prefix show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]
Get the details of a custom IP prefix resource.
az network custom-ip prefix show --name MyCustomIpPrefix --resource-group MyResourceGroup --subscription MySubscription
Expand referenced resources. Default value is None.
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 custom IP prefix.
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.
Update a custom IP prefix resource.
az network custom-ip prefix update [--add]
[--authorization-message]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-internet-advertise {0, 1, f, false, n, no, t, true, y, yes}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--signed-message]
[--state {commission, decommission, deprovision, provision}]
[--subscription]
[--tags]
Update a custom IP prefix resource.
az network custom-ip prefix update --name MyCustomIpPrefix --resource-group MyResourceGroup --tags foo=bar
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>
.
Authorization message for WAN validation.
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 name of the custom IP prefix.
Whether to Advertise the range to Internet.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
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=<value>
.
Signed message for WAN validation.
Commissioned State of the custom ip prefix.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Place the CLI in a waiting state until a condition is met.
az network custom-ip prefix wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
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.
Expand referenced resources. Default value is None.
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 custom IP prefix.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: