Peering Service Locations - List

Reference

Service:: Peering

API Version:: 2021-01-01

Lists all of the available locations for peering service.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceLocations?api-version=2021-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceLocations?country={country}&api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	The client API version.
country	query		string	The country of interest, in which the locations are to be present.

Responses

Name	Type	Description
200 OK	PeeringServiceLocationListResult	OK
Other Status Codes	ErrorResponse	Error response describing why the operation has failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List peering service locations

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Peering/peeringServiceLocations?api-version=2021-01-01

/** Samples for PeeringServiceLocations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/ListPeeringServiceLocationsBySubscription.json
     */
    /**
     * Sample code: List peering service locations.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void listPeeringServiceLocations(com.azure.resourcemanager.peering.PeeringManager manager) {
        manager.peeringServiceLocations().list(null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "country": "country1",
        "state": "state1"
      },
      "name": "peeringServiceLocation1",
      "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceLocations/peeringServiceLocation1",
      "type": "Microsoft.Peering/peeringServiceLocations"
    },
    {
      "properties": {
        "country": "country2",
        "state": "state2"
      },
      "name": "peeringServiceLocation2",
      "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceLocations/peeringServiceLocation2",
      "type": "Microsoft.Peering/peeringServiceLocations"
    }
  ]
}

Definitions

Name	Description
ErrorDetail	The error detail that describes why an operation has failed.
ErrorResponse	The error response that indicates why an operation has failed.
PeeringServiceLocation	The peering service location.
PeeringServiceLocationListResult	The paginated list of peering service locations.

ErrorDetail

The error detail that describes why an operation has failed.

Name	Type	Description
code	string	The error code.
message	string	The error message.

ErrorResponse

The error response that indicates why an operation has failed.

Name	Type	Description
error	ErrorDetail	The error detail that describes why an operation has failed.

PeeringServiceLocation

The peering service location.

Name	Type	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties.azureRegion	string	Azure region for the location
properties.country	string	Country of the customer
properties.state	string	State of the customer
type	string	The type of the resource.

PeeringServiceLocationListResult

The paginated list of peering service locations.

Name	Type	Description
nextLink	string	The link to fetch the next page of peering service locations.
value	PeeringServiceLocation[]	The list of peering service locations.