Express Route Provider Port - Express Route Provider Port

Odwołanie

Service:: ExpressRoute

API Version:: 2023-09-01

Pobiera szczegóły portu dostawcy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
providerport	path	True	string	Nazwa portu dostawcy.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ExpressRouteProviderPort	Żądanie powiodło się. Operacja zwraca szczegóły poszczególnych zasobów portów dostawcy. Jeśli nie ma portu, zwracany jest pusty wynik.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ExpressRouteProviderPort

Sample Request

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

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_port.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_provider_port(
        providerport="abc",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/expressRouteProviderPort.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/expressRouteProviderPort.json
func ExampleManagementClient_ExpressRouteProviderPort() {
	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)
	}
	res, err := clientFactory.NewManagementClient().ExpressRouteProviderPort(ctx, "abc", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExpressRouteProviderPort = armnetwork.ExpressRouteProviderPort{
	// 	Type: to.Ptr("Microsoft.Network/expressRouteProviderPort"),
	// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1"),
	// 	Location: to.Ptr("uswest"),
	// 	Etag: to.Ptr("W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\""),
	// 	Properties: &armnetwork.ExpressRouteProviderPortProperties{
	// 		OverprovisionFactor: to.Ptr[int32](4),
	// 		PeeringLocation: to.Ptr("SiliconValley"),
	// 		PortBandwidthInMbps: to.Ptr[int32](4000),
	// 		PortPairDescriptor: to.Ptr("bvtazureixpportpair1"),
	// 		PrimaryAzurePort: to.Ptr("bvtazureixp01"),
	// 		RemainingBandwidthInMbps: to.Ptr[int32](1500),
	// 		SecondaryAzurePort: to.Ptr("bvtazureixp01"),
	// 		UsedBandwidthInMbps: to.Ptr[int32](2500),
	// 	},
	// }
}

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 Retrieves detail of a provider port.
 *
 * @summary Retrieves detail of a provider port.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/expressRouteProviderPort.json
 */
async function expressRouteProviderPort() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const providerport = "abc";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteProviderPort(providerport);
  console.log(result);
}

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.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/expressRouteProviderPort.json
// this example is just showing the usage of "ExpressRouteProviderPort" 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 ExpressRouteProviderPortResource created on azure
// for more information of creating ExpressRouteProviderPortResource, please refer to the document of ExpressRouteProviderPortResource
string subscriptionId = "subid";
string providerport = "abc";
ResourceIdentifier expressRouteProviderPortResourceId = ExpressRouteProviderPortResource.CreateResourceIdentifier(subscriptionId, providerport);
ExpressRouteProviderPortResource expressRouteProviderPort = client.GetExpressRouteProviderPortResource(expressRouteProviderPortResourceId);

// invoke the operation
ExpressRouteProviderPortResource result = await expressRouteProviderPort.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ExpressRouteProviderPortData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1",
  "type": "Microsoft.Network/expressRouteProviderPort",
  "location": "uswest",
  "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
  "properties": {
    "portPairDescriptor": "bvtazureixpportpair1",
    "primaryAzurePort": "bvtazureixp01",
    "secondaryAzurePort": "bvtazureixp01",
    "peeringLocation": "SiliconValley",
    "overprovisionFactor": 4,
    "portBandwidthInMbps": 4000,
    "usedBandwidthInMbps": 2500,
    "remainingBandwidthInMbps": 1500
  }
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
ExpressRouteProviderPort	Zasób ExpressRouteProviderPort.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ExpressRouteProviderPort

Zasób ExpressRouteProviderPort.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu
properties.overprovisionFactor	integer	Współczynnik nadmiernej aprowizacji dla pary portów.
properties.peeringLocation	string	Lokalizacja komunikacji równorzędnej pary portów.
properties.portBandwidthInMbps	integer	Przepustowość portu w Mb/s
properties.portPairDescriptor	string	Nazwa pary portów.
properties.primaryAzurePort	string	Nazwa portu podstawowego.
properties.remainingBandwidthInMbps	integer	Pozostała przepustowość portu w Mb/s
properties.secondaryAzurePort	string	Nazwa portu pomocniczego.
properties.usedBandwidthInMbps	integer	Używana przepustowość portu w Mb/s
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

Express Route Provider Port - Express Route Provider Port

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

ExpressRouteProviderPort

Sample Request

Sample Response

Definicje

CloudError

CloudErrorBody

ExpressRouteProviderPort

Dodatkowe zasoby