Private Endpoint Connection - Create Or Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Erstellt eine neue private Endpunktverbindung oder aktualisiert eine vorhandene.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Name der privaten Endpunktverbindung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
id	string	Private Endpoint Connection Resource Id.
properties	Properties	Der Verbindungsstatus der privaten Endpunktverbindung.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Die Anforderung für private Endpunktverbindung wurde abgeschlossen.
202 Accepted		Anfordern, private Endpunktverbindung zu genehmigen oder abzulehnen. Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft werden kann. Header location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

PrivateEndpointConnection

Die Anforderung für private Endpunktverbindung wurde abgeschlossen.

202 Accepted

Anfordern, private Endpunktverbindung zu genehmigen oder abzulehnen. Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft werden kann.

Header

location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementApproveOrRejectPrivateEndpointConnection

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "The Private Endpoint Connection is approved."
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Statuscode:: 200

{
  "name": "privateEndpointConnectionName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
  "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Succeeded",
      "description": "The request has been approved."
    }
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointConnectionRequest	Eine Anforderung zum Genehmigen oder Ablehnen einer privaten Endpunktverbindung
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
Properties	Der Verbindungsstatus der privaten Endpunktverbindung.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.