Prefixes - Create Or Update

Referenz

Service:: Peering

API Version:: 2021-01-01

Erstellt ein neues Präfix mit dem angegebenen Namen unter dem angegebenen Abonnement, der Ressourcengruppe und dem Peeringdienst.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
peeringServiceName	path	True	string	Der Name des Peeringdiensts.
prefixName	path	True	string	Der Name des Präfixes.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Die Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.peeringServicePrefixKey	string	Der Peeringdienstpräfixschlüssel
properties.prefix	string	Das Präfix, aus dem Ihr Datenverkehr stammt.

Antworten

Name	Typ	Beschreibung
200 OK	PeeringServicePrefix	OK
201 Created	PeeringServicePrefix	Erstellt
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Create or update a prefix for the peering service

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

{
  "properties": {
    "prefix": "192.168.1.0/24",
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000"
  }
}

/** Samples for Prefixes CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/CreatePeeringServicePrefix.json
     */
    /**
     * Sample code: Create or update a prefix for the peering service.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void createOrUpdateAPrefixForThePeeringService(
        com.azure.resourcemanager.peering.PeeringManager manager) {
        manager
            .prefixes()
            .define("peeringServicePrefixName")
            .withExistingPeeringService("rgName", "peeringServiceName")
            .withPrefix("192.168.1.0/24")
            .withPeeringServicePrefixKey("00000000-0000-0000-0000-000000000000")
            .create();
    }
}

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": "Failed",
    "learnedType": "None",
    "errorMessage": "Prefix is not announced by the service provider to Microsoft.",
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
    "provisioningState": "Succeeded"
  },
  "name": "peeringServicePrefixName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName"
}

Status code:: 201

{
  "properties": {
    "prefix": "192.168.1.0/24",
    "prefixValidationState": "Failed",
    "learnedType": "None",
    "errorMessage": "Prefix is not announced by the service provider to Microsoft.",
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
    "provisioningState": "Succeeded"
  },
  "name": "peeringServicePrefixName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName"
}

Definitionen

Name	Beschreibung
ErrorDetail	Das Fehlerdetails, das beschreibt, warum ein Vorgang fehlgeschlagen ist.
ErrorResponse	Die Fehlerantwort, die angibt, warum ein Vorgang fehlgeschlagen ist.
learnedType	Der gelernte Präfixtyp
PeeringServicePrefix	Die Präfixklasse des Peeringdiensts.
PeeringServicePrefixEvent	Die Details des Ereignisses, das einem Präfix zugeordnet ist.
prefixValidationState	Der Präfixvalidierungsstatus.
provisioningState	Der Bereitstellungsstatus der Ressource.

ErrorDetail

Das Fehlerdetails, das beschreibt, warum ein Vorgang fehlgeschlagen ist.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.

ErrorResponse

Die Fehlerantwort, die angibt, warum ein Vorgang fehlgeschlagen ist.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerdetails, das beschreibt, warum ein Vorgang fehlgeschlagen ist.

learnedType

Der gelernte Präfixtyp

Name	Typ	Beschreibung
None	string
ViaServiceProvider	string
ViaSession	string

PeeringServicePrefix

Die Präfixklasse des Peeringdiensts.

Name	Typ	Beschreibung
id	string	Die ID der Ressource.
name	string	Der Name der Ressource.
properties.errorMessage	string	Die Fehlermeldung für den Überprüfungsstatus
properties.events	PeeringServicePrefixEvent[]	Die Liste der Ereignisse für das Peeringdienstpräfix
properties.learnedType	learnedType	Der gelernte Präfixtyp
properties.peeringServicePrefixKey	string	Der Peeringdienstpräfixschlüssel
properties.prefix	string	Das Präfix, aus dem Ihr Datenverkehr stammt.
properties.prefixValidationState	prefixValidationState	Der Präfixüberprüfungsstatus
properties.provisioningState	provisioningState	Der Bereitstellungsstatus der Ressource.
type	string	Der Typ der Ressource.

PeeringServicePrefixEvent

Die Details des Ereignisses, das einem Präfix zugeordnet ist.

Name	Typ	Beschreibung
eventDescription	string	Die Beschreibung des Ereignisses, das einem Präfix zugeordnet ist.
eventLevel	string	Die Ebene des Ereignisses, das einem Präfix zugeordnet ist.
eventSummary	string	Die Zusammenfassung des Ereignisses, das einem Präfix zugeordnet ist.
eventTimestamp	string	Der Zeitstempel des Ereignisses, das einem Präfix zugeordnet ist.
eventType	string	Der Typ des Ereignisses, das einem Präfix zugeordnet ist.

prefixValidationState

Der Präfixvalidierungsstatus.

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

provisioningState

Der Bereitstellungsstatus der Ressource.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string