Express Route Service Providers - List

Referência

Service:: ExpressRoute

API Version:: 2023-09-01

Obtém todos os provedores de serviço de rota expressa disponíveis.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Respostas

Nome	Tipo	Description
200 OK	ExpressRouteServiceProviderListResult	Solicitação bem-sucedida. A operação retorna uma lista de recursos do ExpressRouteServiceProvider.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List ExpressRoute providers

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/expressRouteServiceProviders?api-version=2023-09-01


/**
 * Samples for ExpressRouteServiceProviders List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteProviderList.json
     */
    /**
     * Sample code: List ExpressRoute providers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listExpressRouteProviders(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteServiceProviders()
            .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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python express_route_provider_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.express_route_service_providers.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteProviderList.json
if __name__ == "__main__":
    main()

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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteProviderList.json
func ExampleExpressRouteServiceProvidersClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewExpressRouteServiceProvidersClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExpressRouteServiceProviderListResult = armnetwork.ExpressRouteServiceProviderListResult{
		// 	Value: []*armnetwork.ExpressRouteServiceProvider{
		// 		{
		// 			Name: to.Ptr("providerName"),
		// 			Type: to.Ptr("Microsoft.Network/expressRouteServiceProviders"),
		// 			ID: to.Ptr("/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/"),
		// 			Properties: &armnetwork.ExpressRouteServiceProviderPropertiesFormat{
		// 				BandwidthsOffered: []*armnetwork.ExpressRouteServiceProviderBandwidthsOffered{
		// 					{
		// 						OfferName: to.Ptr("50Mbps"),
		// 						ValueInMbps: to.Ptr[int32](50),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("100Mbps"),
		// 						ValueInMbps: to.Ptr[int32](100),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("200Mbps"),
		// 						ValueInMbps: to.Ptr[int32](200),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("500Mbps"),
		// 						ValueInMbps: to.Ptr[int32](500),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("1Gbps"),
		// 						ValueInMbps: to.Ptr[int32](1000),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("2Gbps"),
		// 						ValueInMbps: to.Ptr[int32](2000),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("5Gbps"),
		// 						ValueInMbps: to.Ptr[int32](5000),
		// 					},
		// 					{
		// 						OfferName: to.Ptr("10Gbps"),
		// 						ValueInMbps: to.Ptr[int32](10000),
		// 				}},
		// 				PeeringLocations: []*string{
		// 					to.Ptr("peeringLocation1"),
		// 					to.Ptr("peeringLocation2")},
		// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				},
		// 		}},
		// 	}
	}
}

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

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all the available express route service providers.
 *
 * @summary Gets all the available express route service providers.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteProviderList.json
 */
async function listExpressRouteProviders() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.expressRouteServiceProviders.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteProviderList.json
// this example is just showing the usage of "ExpressRouteServiceProviders_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ExpressRouteServiceProvider item in subscriptionResource.GetExpressRouteServiceProvidersAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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": [
    {
      "name": "providerName",
      "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/",
      "type": "Microsoft.Network/expressRouteServiceProviders",
      "properties": {
        "provisioningState": "Succeeded",
        "peeringLocations": [
          "peeringLocation1",
          "peeringLocation2"
        ],
        "bandwidthsOffered": [
          {
            "offerName": "50Mbps",
            "valueInMbps": 50
          },
          {
            "offerName": "100Mbps",
            "valueInMbps": 100
          },
          {
            "offerName": "200Mbps",
            "valueInMbps": 200
          },
          {
            "offerName": "500Mbps",
            "valueInMbps": 500
          },
          {
            "offerName": "1Gbps",
            "valueInMbps": 1000
          },
          {
            "offerName": "2Gbps",
            "valueInMbps": 2000
          },
          {
            "offerName": "5Gbps",
            "valueInMbps": 5000
          },
          {
            "offerName": "10Gbps",
            "valueInMbps": 10000
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpressRouteServiceProvider	Um objeto ExpressRouteResourceProvider.
ExpressRouteServiceProviderBandwidthsOffered	Contém larguras de banda oferecidas em recursos do ExpressRouteServiceProvider.
ExpressRouteServiceProviderListResult	Resposta para a chamada de serviço da API ListExpressRouteServiceProvider.
ProvisioningState	O estado de provisionamento atual.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteServiceProvider

Um objeto ExpressRouteResourceProvider.

Nome	Tipo	Description
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.bandwidthsOffered	ExpressRouteServiceProviderBandwidthsOffered[]	Uma lista de larguras de banda oferecidas.
properties.peeringLocations	string[]	Uma lista de locais de emparelhamento.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso do provedor de serviços de rota expressa.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

ExpressRouteServiceProviderBandwidthsOffered

Contém larguras de banda oferecidas em recursos do ExpressRouteServiceProvider.

Nome	Tipo	Description
offerName	string	O OfferName.
valueInMbps	integer	O ValueInMbps.

ExpressRouteServiceProviderListResult

Resposta para a chamada de serviço da API ListExpressRouteServiceProvider.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de resultados.
value	ExpressRouteServiceProvider[]	Uma lista de recursos do ExpressRouteResourceProvider.

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string