Prefixes - Get

Referens

Service:: Peering

API Version:: 2021-01-01

Hämtar ett befintligt prefix med det angivna namnet under den angivna prenumerationen, resursgruppen och peeringtjänsten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
peeringServiceName	path	True	string	Namnet på peeringtjänsten.
prefixName	path	True	string	Namnet på prefixet.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Azure-prenumerations-ID:t.
api-version	query	True	string	Klient-API-versionen.
$expand	query		string	De egenskaper som ska utökas.

Svar

Name	Typ	Description
200 OK	PeeringServicePrefix	OK
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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"
}

Definitioner

Name	Description
ErrorDetail	Felinformationen som beskriver varför en åtgärd har misslyckats.
ErrorResponse	Felsvaret som anger varför en åtgärd har misslyckats.
learnedType	Den inlärda prefixtypen
PeeringServicePrefix	Prefixklassen för peeringtjänsten.
PeeringServicePrefixEvent	Information om händelsen som är associerad med ett prefix.
prefixValidationState	Prefixets valideringstillstånd.
provisioningState	Resursens etableringstillstånd.

ErrorDetail

Felinformationen som beskriver varför en åtgärd har misslyckats.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.

ErrorResponse

Felsvaret som anger varför en åtgärd har misslyckats.

Name	Typ	Description
error	ErrorDetail	Felinformationen som beskriver varför en åtgärd har misslyckats.

learnedType

Den inlärda prefixtypen

Name	Typ	Description
None	string
ViaServiceProvider	string
ViaSession	string

PeeringServicePrefix

Prefixklassen för peeringtjänsten.

Name	Typ	Description
id	string	Resursens ID.
name	string	Namnet på resursen.
properties.errorMessage	string	Felmeddelandet för valideringstillstånd
properties.events	PeeringServicePrefixEvent[]	Listan över händelser för peeringtjänstprefix
properties.learnedType	learnedType	Den inlärda prefixtypen
properties.peeringServicePrefixKey	string	Prefixnyckeln för peeringtjänsten
properties.prefix	string	Prefixet som din trafik kommer från.
properties.prefixValidationState	prefixValidationState	Prefixets valideringstillstånd
properties.provisioningState	provisioningState	Resursens etableringstillstånd.
type	string	Resurstypen.

PeeringServicePrefixEvent

Information om händelsen som är associerad med ett prefix.

Name	Typ	Description
eventDescription	string	Beskrivningen av händelsen som är associerad med ett prefix.
eventLevel	string	Nivån för händelsen som är associerad med ett prefix.
eventSummary	string	Sammanfattningen av händelsen som är associerad med ett prefix.
eventTimestamp	string	Tidsstämpeln för händelsen som är associerad med ett prefix.
eventType	string	Typen av händelse som är associerad med ett prefix.

prefixValidationState

Prefixets valideringstillstånd.

Name	Typ	Description
Failed	string
Invalid	string
None	string
Pending	string
Unknown	string
Verified	string
Warning	string

provisioningState

Resursens etableringstillstånd.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string