Freigeben über


Private Endpoint Connections - Put

Updates die angegebene private Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
privateEndpointConnectionName
path True

string

Name der privaten Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den Schlüsseltresor enthält.

subscriptionId
path True

string

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

vaultName
path True

string

Der Name des Schlüsseltresors.

RegEx-Muster: ^[a-zA-Z0-9-]{3,24}$

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
etag

string

Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.

properties.privateEndpoint

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Genehmigungsstatus der Private Link-Verbindung.

Antworten

Name Typ Beschreibung
200 OK

PrivateEndpointConnection

Der Status der Verbindung mit dem privaten Endpunkt wurde erfolgreich aktualisiert.

Header

  • Retry-After: integer
  • Azure-AsyncOperation: string
Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

KeyVaultPutPrivateEndpointConnection

Beispielanforderung

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?api-version=2022-07-01

{
  "etag": "",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this."
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this.",
      "actionsRequired": "None"
    }
  }
}

Definitionen

Name Beschreibung
ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

PrivateEndpointConnection

Verbindungsressource für private Endpunkte.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

PrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

Name Typ Beschreibung
None

string

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name Typ Beschreibung
error

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name Typ Beschreibung
code

string

Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.

message

string

Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

Name Typ Beschreibung
id

string

Vollständiger Bezeichner der privaten Endpunktressource.

PrivateEndpointConnection

Verbindungsressource für private Endpunkte.

Name Typ Beschreibung
etag

string

Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.

id

string

Vollqualifizierter Bezeichner der Schlüsseltresorressource.

location

string

Azure-Speicherort der Schlüsseltresorressource.

name

string

Name der Schlüsseltresorressource.

properties.privateEndpoint

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Genehmigungsstatus der Private Link-Verbindung.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

tags

object

Tags, die der Schlüsseltresorressource zugewiesen sind.

type

string

Ressourcentyp der Schlüsseltresorressource.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

Name Typ Beschreibung
actionsRequired

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

description

string

Der Grund für die Genehmigung oder Ablehnung.

status

PrivateEndpointServiceConnectionStatus

Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.