Share via

az peering registered-prefix

  • Reference

Note

This reference is part of the peering extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az peering registered-prefix command. Learn more about extensions.

Peering registered-prefix.

Commands

Name Description Type Status
az peering registered-prefix create

Creates a new registered prefix with the specified name under the given subscription, resource group and peering.

 Extension GA
az peering registered-prefix delete

Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.

 Extension GA
az peering registered-prefix list

Lists all registered prefixes under the given subscription, resource group and peering.

 Extension GA
az peering registered-prefix show

Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.

 Extension GA
az peering registered-prefix update

Creates a new registered prefix with the specified name under the given subscription, resource group and peering.

 Extension GA

az peering registered-prefix create

Creates a new registered prefix with the specified name under the given subscription, resource group and peering.

az peering registered-prefix create --peering-name
                                    --registered-prefix-name
                                    --resource-group
                                    [--prefix]

Examples

Create or update a registered prefix for the peering

az peering registered-prefix create --peering-name "peeringName" --prefix "10.22.20.0/24" --registered-prefix-name "registeredPrefixName" --resource-group "rgName"

Required Parameters

--peering-name

The name of the peering.

--registered-prefix-name

The name of the registered prefix.

--resource-group -g

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

Optional Parameters

--prefix

The customer's prefix from which traffic originates.

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 peering registered-prefix delete

Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.

az peering registered-prefix delete --peering-name
                                    --registered-prefix-name
                                    --resource-group

Examples

Deletes a registered prefix associated with the peering

az peering registered-prefix delete --peering-name "peeringName" --registered-prefix-name "registeredPrefixName" --resource-group "rgName"

Required Parameters

--peering-name

The name of the peering.

--registered-prefix-name

The name of the registered prefix.

--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 peering registered-prefix list

Lists all registered prefixes under the given subscription, resource group and peering.

az peering registered-prefix list --peering-name
                                  --resource-group

Examples

List all the registered prefixes associated with the peering

az peering registered-prefix list --peering-name "peeringName" --resource-group "rgName"

Required Parameters

--peering-name

The name of the peering.

--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 peering registered-prefix show

Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.

az peering registered-prefix show --peering-name
                                  --registered-prefix-name
                                  --resource-group

Examples

Get a registered prefix associated with the peering

az peering registered-prefix show --peering-name "peeringName" --registered-prefix-name "registeredPrefixName" --resource-group "rgName"

Required Parameters

--peering-name

The name of the peering.

--registered-prefix-name

The name of the registered prefix.

--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 peering registered-prefix update

Creates a new registered prefix with the specified name under the given subscription, resource group and peering.

az peering registered-prefix update --peering-name
                                    --registered-prefix-name
                                    --resource-group
                                    [--prefix]

Examples

Create or update a registered prefix for the peering

az peering registered-prefix update --peering-name "peeringName" --prefix "10.22.20.0/24" --registered-prefix-name "registeredPrefixName" --resource-group "rgName"

Required Parameters

--peering-name

The name of the peering.

--registered-prefix-name

The name of the registered prefix.

--resource-group -g

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

Optional Parameters

--prefix

The customer's prefix from which traffic originates.

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.