Peering Service Providers - List

Service:

Peering

API Version:

2021-01-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceProviders?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.

Responses

Name	Type	Description
200 OK	PeeringServiceProviderListResult	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 providers

Sample Request

HTTP

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

Java

/** Samples for PeeringServiceProviders List. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/ListPeeringServiceProviders.json
     */
    /**
     * Sample code: List peering service providers.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void listPeeringServiceProviders(com.azure.resourcemanager.peering.PeeringManager manager) {
        manager.peeringServiceProviders().list(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": {
        "serviceProviderName": "peeringServiceProvider1",
        "peeringLocations": [
          "peeringLocation1",
          "peeringLocation2"
        ]
      },
      "name": "peeringServiceProvider1",
      "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider1",
      "type": "Microsoft.Peering/peeringServiceProviders"
    },
    {
      "properties": {
        "serviceProviderName": "peeringServiceProvider2",
        "peeringLocations": [
          "peeringLocation1",
          "peeringLocation2"
        ]
      },
      "name": "peeringServiceProvider2",
      "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider2",
      "type": "Microsoft.Peering/peeringServiceProviders"
    }
  ]
}

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.
PeeringServiceProvider	PeeringService provider
PeeringServiceProviderListResult	The paginated list of peering service providers.

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.

PeeringServiceProvider

PeeringService provider

Name	Type	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties.peeringLocations	string[]	The list of locations at which the service provider peers with Microsoft.
properties.serviceProviderName	string	The name of the service provider.
type	string	The type of the resource.

PeeringServiceProviderListResult

The paginated list of peering service providers.

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