az peering service

  • 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 command. Learn more about extensions.

Peering service.

Commands

Name Description Type Status
az peering service country

Peering service country.

 Extension GA
az peering service country list

Lists all of the available countries for peering service.

 Extension GA
az peering service create

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

 Extension GA
az peering service delete

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

 Extension GA
az peering service list

Lists all of the peerings under the given subscription.

 Extension GA
az peering service location

Peering service location.

 Extension GA
az peering service location list

Lists all of the available locations for peering service.

 Extension GA
az peering service prefix

Peering service prefix.

 Extension GA
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 provider

Peering service provider.

 Extension GA
az peering service provider list

Lists all of the available peering service locations for the specified kind of peering.

 Extension GA
az peering service show

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

 Extension GA
az peering service update

Updates tags for a peering service with the specified name under the given subscription and resource group.

 Extension GA

az peering service create

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

az peering service create --location
                          --peering-service-name
                          --resource-group
                          [--peering-service-location]
                          [--peering-service-provider]
                          [--sku]
                          [--tags]

Examples

Create a peering service

az peering service create --location "eastus" --peering-service-location "state1" --peering-service-provider "serviceProvider1" --peering-service-name "peeringServiceName" --resource-group "rgName"

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

--peering-service-location

The PeeringServiceLocation of the Customer.

--peering-service-provider

The MAPS Provider Name.

--sku

The SKU that defines the type of the peering service. Expect value: name=xx.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

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

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

Examples

Delete a peering service

az peering service delete --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>.

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 list

Lists all of the peerings under the given subscription.

az peering service list [--resource-group]

Examples

List peering services in a resource group

az peering service list --resource-group "rgName"

Optional Parameters

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

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

az peering service show --peering-service-name
                        --resource-group

Examples

Get a peering service

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

Required Parameters

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

Updates tags for a peering service with the specified name under the given subscription and resource group.

az peering service update --peering-service-name
                          --resource-group
                          [--tags]

Examples

Update peering service tags

az peering service update --peering-service-name "peeringServiceName" --resource-group "rgName" --tags tags={"tag0":"value0","tag1":"value1"}

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.