Share via

az networkfabric ipextendedcommunity

  • Reference

Note

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

Manage Ip Extended Community Resource.

Commands

Name Description Type Status
az networkfabric ipextendedcommunity create

Create a Ip Extended Community resource.

 Extension GA
az networkfabric ipextendedcommunity delete

Delete the Ip Extended Community resource.

 Extension GA
az networkfabric ipextendedcommunity list

List all Ip Extended Communities in the provided resource group or subscription.

 Extension GA
az networkfabric ipextendedcommunity show

Show details of the provided Ip Extended Community resource.

 Extension GA
az networkfabric ipextendedcommunity update

Update to update certain properties of the IP Extended Community resource.

 Extension GA
az networkfabric ipextendedcommunity wait

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

 Extension GA

az networkfabric ipextendedcommunity create

Create a Ip Extended Community resource.

az networkfabric ipextendedcommunity create --ip-extended-community-rules
                                            --resource-group
                                            --resource-name
                                            [--annotation]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]

Examples

Create a Ip Extended Community

az networkfabric ipextendedcommunity create --resource-group "example-rg" --location "westus3" --resource-name "example-ipextendedcommunity" --ip-extended-community-rules "[{action:Permit,sequenceNumber:1234,routeTargets:['1024:219','1001:200']}]"

Help text for sub parameters under the specific parent can be viewed by using the shorthand syntax '??'. See https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md for more about shorthand syntax.

az networkfabric ipextendedcommunity create --ip-extended-community-rules "??"

Required Parameters

--ip-extended-community-rules

List of IP Extended Community Rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

Name of the IP Extended Community.

Optional Parameters

--annotation

Description for underlying resource.

--location -l

Location of Azure region When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 networkfabric ipextendedcommunity delete

Delete the Ip Extended Community resource.

az networkfabric ipextendedcommunity delete [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--resource-name]
                                            [--subscription]

Examples

Delete the Ip Extended Community

az networkfabric ipextendedcommunity delete --resource-group "example-rg" --resource-name "example-ipextendedcommunity"

Optional Parameters

--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
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

Name of the IP Extended Community.

--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 networkfabric ipextendedcommunity list

List all Ip Extended Communities in the provided resource group or subscription.

az networkfabric ipextendedcommunity list [--max-items]
                                          [--next-token]
                                          [--resource-group]

Examples

List the Ip Extended Communities for Resource Group

az networkfabric ipextendedcommunity list --resource-group "example-rg"

List the Ip Extended Communities for Subscription

az networkfabric ipextendedcommunity list --subscription "<subscriptionId>"

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.

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

--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 networkfabric ipextendedcommunity show

Show details of the provided Ip Extended Community resource.

az networkfabric ipextendedcommunity show [--ids]
                                          [--resource-group]
                                          [--resource-name]
                                          [--subscription]

Examples

Show the Ip Extended Community

az networkfabric ipextendedcommunity show --resource-group "example-rg" --resource-name "example-ipextendedcommunity"

Optional Parameters

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

Name of the IP Extended Community.

--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 networkfabric ipextendedcommunity update

Update to update certain properties of the IP Extended Community resource.

az networkfabric ipextendedcommunity update [--annotation]
                                            [--ids]
                                            [--ip-extended-community-rules]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--resource-name]
                                            [--subscription]
                                            [--tags]

Examples

Update IP Extended Community

az networkfabric ipextendedcommunity update --resource-group "example-rg" --resource-name "example-ipextendedcommunity" --ip-extended-community-rules "[{action:Permit,sequenceNumber:1234,routeTargets:['1024:219','1001:200']}]"

Optional Parameters

--annotation

Description for underlying resource.

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

--ip-extended-community-rules

List of IP Extended Community Rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

Name of the IP Extended Community.

--subscription

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

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 networkfabric ipextendedcommunity wait

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

az networkfabric ipextendedcommunity wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--resource-name]
                                          [--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
--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
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

Name of the IP Extended Community.

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