Prefixes - Get

Odwołanie

Service:: Peering

API Version:: 2021-01-01

Pobiera istniejący prefiks o określonej nazwie w ramach danej subskrypcji, grupy zasobów i usługi komunikacji równorzędnej.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}?api-version=2021-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}?$expand={$expand}&api-version=2021-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
peeringServiceName	path	True	string	Nazwa usługi komunikacji równorzędnej.
prefixName	path	True	string	Nazwa prefiksu.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API klienta.
$expand	query		string	Właściwości do rozwinięcia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PeeringServicePrefix	OK
Other Status Codes	ErrorResponse	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

Get a prefix associated with the peering service

GET https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName?api-version=2021-01-01

/** Samples for Prefixes Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/GetPeeringServicePrefix.json
     */
    /**
     * Sample code: Get a prefix associated with the peering service.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void getAPrefixAssociatedWithThePeeringService(
        com.azure.resourcemanager.peering.PeeringManager manager) {
        manager
            .prefixes()
            .getWithResponse(
                "rgName", "peeringServiceName", "peeringServicePrefixName", 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

{
  "properties": {
    "prefix": "192.168.1.0/24",
    "prefixValidationState": "Verified",
    "learnedType": "ViaServiceProvider",
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
    "provisioningState": "Succeeded"
  },
  "name": "peeringServicePrefixName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName"
}

Definicje

Nazwa	Opis
ErrorDetail	Szczegóły błędu opisujące, dlaczego operacja nie powiodła się.
ErrorResponse	Odpowiedź na błąd wskazująca, dlaczego operacja nie powiodła się.
learnedType	Typ poznanego prefiksu
PeeringServicePrefix	Klasa prefiksu usługi peering Service.
PeeringServicePrefixEvent	Szczegóły zdarzenia skojarzonego z prefiksem.
prefixValidationState	Stan weryfikacji prefiksu.
provisioningState	Stan aprowizacji zasobu.

ErrorDetail

Szczegóły błędu opisujące, dlaczego operacja nie powiodła się.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.

ErrorResponse

Odpowiedź na błąd wskazująca, dlaczego operacja nie powiodła się.

Nazwa	Typ	Opis
error	ErrorDetail	Szczegóły błędu opisujące, dlaczego operacja nie powiodła się.

learnedType

Typ poznanego prefiksu

Nazwa	Typ	Opis
None	string
ViaServiceProvider	string
ViaSession	string

PeeringServicePrefix

Klasa prefiksu usługi peering Service.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.errorMessage	string	Komunikat o błędzie stanu weryfikacji
properties.events	PeeringServicePrefixEvent[]	Lista zdarzeń dla prefiksu usługi komunikacji równorzędnej
properties.learnedType	learnedType	Typ poznanego prefiksu
properties.peeringServicePrefixKey	string	Klucz prefiksu usługi peering Service
properties.prefix	string	Prefiks, z którego pochodzi ruch.
properties.prefixValidationState	prefixValidationState	Stan weryfikacji prefiksu
properties.provisioningState	provisioningState	Stan aprowizacji zasobu.
type	string	Typ zasobu.

PeeringServicePrefixEvent

Szczegóły zdarzenia skojarzonego z prefiksem.

Nazwa	Typ	Opis
eventDescription	string	Opis zdarzenia skojarzonego z prefiksem.
eventLevel	string	Poziom zdarzenia skojarzonego z prefiksem.
eventSummary	string	Podsumowanie zdarzenia skojarzonego z prefiksem.
eventTimestamp	string	Sygnatura czasowa zdarzenia skojarzonego z prefiksem.
eventType	string	Typ zdarzenia skojarzonego z prefiksem.

prefixValidationState

Stan weryfikacji prefiksu.

Nazwa	Typ	Opis
Failed	string
Invalid	string
None	string
Pending	string
Unknown	string
Verified	string
Warning	string

provisioningState

Stan aprowizacji zasobu.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string