Private Endpoint Connections - Put

Tjänst:

Key Vault

API-version:

2024-11-01

Uppdaterar den angivna privata slutpunktsanslutningen som är associerad med nyckelvalvet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
privateEndpointConnectionName	path	True	string	Namnet på den privata slutpunktsanslutningen som är associerad med nyckelvalvet.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller nyckelvalvet.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Namnet på nyckelvalvet.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
properties.privateEndpoint	PrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.

Svar

Name	Typ	Description
200 OK	PrivateEndpointConnection	Tillståndet för anslutningen till den privata slutpunkten har uppdaterats. Sidhuvuden Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

KeyVaultPutPrivateEndpointConnection

Exempelbegäran

HTTP

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=2024-11-01

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
CloudError	Ett felsvar från 密钥保管库 resursprovidern
CloudErrorBody	Ett felsvar från 密钥保管库 resursprovidern
PrivateEndpoint	Egenskaper för objekt för privat slutpunkt.
PrivateEndpointConnection	Anslutningsresurs för privat slutpunkt.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

ActionsRequired

Uppräkning

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

Värde	Description
None

CloudError

Objekt

Ett felsvar från 密钥保管库 resursprovidern

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från 密钥保管库 resursprovidern

CloudErrorBody

Objekt

Ett felsvar från 密钥保管库 resursprovidern

Name	Typ	Description
code	string	Felkod. Detta är en mnemonik som kan användas programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

PrivateEndpoint

Objekt

Egenskaper för objekt för privat slutpunkt.

Name	Typ	Description
id	string	Fullständig identifierare för den privata slutpunktsresursen.

PrivateEndpointConnection

Objekt

Anslutningsresurs för privat slutpunkt.

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
id	string	Fullständigt kvalificerad identifierare för nyckelvalvsresursen.
location	string	Azure-platsen för nyckelvalvsresursen.
name	string	Namnet på nyckelvalvsresursen.
properties.privateEndpoint	PrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
tags	object	Taggar som tilldelats nyckelvalvsresursen.
type	string	Resurstyp för nyckelvalvsresursen.

PrivateEndpointConnectionProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Objekt

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Anledningen till godkännande eller avvisande.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.