Private Endpoint Connections - Put

Servizio:: Key Vault

Versione API:: 2024-11-01

Aggiorna la connessione all'endpoint privato specificata associata all'insieme di credenziali delle chiavi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
privateEndpointConnectionName	path	True	string	Nome della connessione all'endpoint privato associata all'insieme di credenziali delle chiavi.
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'insieme di credenziali delle chiavi.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nome dell'insieme di credenziali delle chiavi.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
properties.privateEndpoint	PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di approvazione della connessione al collegamento privato.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	Lo stato della connessione all'endpoint privato è stato aggiornato correttamente. Intestazioni Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

PrivateEndpointConnection

Lo stato della connessione all'endpoint privato è stato aggiornato correttamente.

Intestazioni

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

KeyVaultPutPrivateEndpointConnection

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
    }
  }
}

Definizioni

Nome	Descrizione
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.
CloudError	Risposta di errore dal provider di risorse Key Vault
CloudErrorBody	Risposta di errore dal provider di risorse Key Vault
PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
PrivateEndpointConnection	Risorsa di connessione all'endpoint privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning corrente.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione di collegamento privato.

ActionsRequired

Enumerazione

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.

Valore	Descrizione
None

CloudError

Oggetto

Risposta di errore dal provider di risorse Key Vault

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal provider di risorse Key Vault

CloudErrorBody

Oggetto

Risposta di errore dal provider di risorse Key Vault

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un tasto mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore di facile utilizzo. Il messaggio è in genere localizzato e può variare in base alla versione del servizio.