Share via

az peering service 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 service prefix command. Learn more about extensions.

Peering service prefix.

Commands

Name Description Type Status
az peering service prefix create

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

 Extension GA
az peering service prefix delete

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

 Extension GA
az peering service prefix list

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

 Extension GA
az peering service prefix show

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

 Extension GA
az peering service prefix update

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

 Extension GA

az peering service prefix create

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

az peering service prefix create --peering-service-name
                                 --prefix-name
                                 --resource-group
                                 [--peering-service-prefix-key]
                                 [--prefix]

Examples

Create or update a prefix for the peering service

az peering service prefix create --peering-service-name "peeringServiceName" --peering-service-prefix-key "00000000-0000-0000-0000-000000000000" --prefix "192.168.1.0/24" --prefix-name "peeringServicePrefixName" --resource-group "rgName"

Required Parameters

--peering-service-name

The name of the peering service.

--prefix-name

The name of the prefix.

--resource-group -g

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

Optional Parameters

--peering-service-prefix-key

The peering service prefix key.

--prefix

The prefix from which your 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 service prefix delete

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

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

Examples

Delete a prefix associated with the peering service

az peering service prefix delete --peering-service-name "peeringServiceName" --prefix-name "peeringServicePrefixName" --resource-group "rgName"

Required Parameters

--peering-service-name

The name of the peering service.

--prefix-name

The name of the 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 service prefix list

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

az peering service prefix list --peering-service-name
                               --resource-group
                               [--expand]

Examples

List all the prefixes associated with the peering service

az peering service prefix list --peering-service-name "peeringServiceName" --resource-group "rgName"

Required Parameters

--peering-service-name

The name of the peering service.

--resource-group -g

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

Optional Parameters

--expand

The properties to be expanded.

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 service prefix show

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

az peering service prefix show --peering-service-name
                               --prefix-name
                               --resource-group
                               [--expand]

Examples

Get a prefix associated with the peering service

az peering service prefix show --peering-service-name "peeringServiceName" --prefix-name "peeringServicePrefixName" --resource-group "rgName"

Required Parameters

--peering-service-name

The name of the peering service.

--prefix-name

The name of the prefix.

--resource-group -g

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

Optional Parameters

--expand

The properties to be expanded.

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 service prefix update

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

az peering service prefix update --peering-service-name
                                 --prefix-name
                                 --resource-group
                                 [--peering-service-prefix-key]
                                 [--prefix]

Examples

Create or update a prefix for the peering service

az peering service prefix update --peering-service-name "peeringServiceName" --peering-service-prefix-key "00000000-0000-0000-0000-000000000000" --prefix "192.168.1.0/24" --prefix-name "peeringServicePrefixName" --resource-group "rgName"

Required Parameters

--peering-service-name

The name of the peering service.

--prefix-name

The name of the prefix.

--resource-group -g

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

Optional Parameters

--peering-service-prefix-key

The peering service prefix key.

--prefix

The prefix from which your 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.