Private Endpoint Connections - Create Or Update

Erstellt oder aktualisiert PrivateEndpointConnections des Dienstnamespaces.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
namespaceName
path True

string

Der Namespacename

RegEx-Muster: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

privateEndpointConnectionName
path True

string

Der Name von PrivateEndpointConnection

resourceGroupName
path True

string

Name der Ressourcengruppe innerhalb des Azure-Abonnements.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
properties.privateEndpoint

PrivateEndpoint

Die Ressource "Privater Endpunkt" für diese Verbindung.

properties.privateLinkServiceConnectionState

ConnectionState

Details zum Status der Verbindung.

properties.provisioningState

EndPointProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

Antworten

Name Typ Beschreibung
200 OK

PrivateEndpointConnection

Status der erfolgreichen Erstellung der PrivateEndPoint-Verbindung.

201 Created

PrivateEndpointConnection

Anforderung zum Aktualisieren des Status der Akzeptierten PrivateEndPoint-Verbindung.

202 Accepted

PrivateEndpointConnection

Anforderung zum Aktualisieren des Status der Akzeptierten PrivateEndPoint-Verbindung.

Other Status Codes

ErrorResponse

EventHub-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

NameSpacePrivateEndPointConnectionCreate

Beispielanforderung

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Definitionen

Name Beschreibung
ConnectionState

ConnectionState-Informationen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

EndPointProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

PrivateEndpoint

PrivateEndpoint-Informationen.

PrivateEndpointConnection

Eigenschaften von PrivateEndpointConnection.

PrivateLinkConnectionStatus

Status der Verbindung.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ConnectionState

ConnectionState-Informationen.

Name Typ Beschreibung
description

string

Beschreibung des Verbindungsstatus.

status

PrivateLinkConnectionStatus

Status der Verbindung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

EndPointProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

PrivateEndpoint

PrivateEndpoint-Informationen.

Name Typ Beschreibung
id

string

Der ARM-Bezeichner für den privaten Endpunkt.

PrivateEndpointConnection

Eigenschaften von PrivateEndpointConnection.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.privateEndpoint

PrivateEndpoint

Die Ressource "Privater Endpunkt" für diese Verbindung.

properties.privateLinkServiceConnectionState

ConnectionState

Details zum Status der Verbindung.

properties.provisioningState

EndPointProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

systemData

systemData

Die Systemmetadaten zu dieser Ressource.

type

string

Der Typ der Ressource. Z.B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status der Verbindung.

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Identitätstyp, der die Ressource zuletzt geändert hat.

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.