Private Endpoint Connections - Put

Met à jour la connexion de point de terminaison privé spécifiée associée au coffre de clés.

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

Paramètres URI

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

Nom de la connexion de point de terminaison privé associée au coffre de clés.

resourceGroupName
path True
  • string

Nom du groupe de ressources qui contient le coffre de clés.

subscriptionId
path True
  • string

Informations d’identification de l’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

vaultName
path True
  • string

Nom du coffre de clés.

Regex pattern: ^[a-zA-Z0-9-]{3,24}$

api-version
query True
  • string

Version de l’API cliente.

Corps de la demande

Name Type Description
etag
  • string

Modifié chaque fois qu’il existe une modification de l’état de la connexion de point de terminaison privé.

properties.privateEndpoint

Propriétés de l’objet de point de terminaison privé.

properties.privateLinkServiceConnectionState

État d’approbation de la connexion de liaison privée.

Réponses

Name Type Description
200 OK

L’état de la connexion de point de terminaison privé a été mis à jour avec succès.

Headers

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

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

KeyVaultPutPrivateEndpointConnection

Sample Request

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=2021-10-01

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

Sample Response

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

Définitions

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

PrivateEndpoint

Propriétés de l’objet point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

PrivateEndpointServiceConnectionStatus

État de connexion du point de terminaison privé.

PrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Name Type Description
None
  • string

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

Name Type Description
error

Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Name Type Description
code
  • string

Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programme.

message
  • string

Message d’erreur convivial. Le message est généralement localisé et peut varier avec la version du service.

PrivateEndpoint

Propriétés de l’objet point de terminaison privé.

Name Type Description
id
  • string

Identificateur complet de la ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Name Type Description
etag
  • string

Modifié chaque fois qu’il existe une modification de l’état de la connexion de point de terminaison privé.

id
  • string

Identificateur complet de la ressource key vault.

location
  • string

Emplacement Azure de la ressource key vault.

name
  • string

Nom de la ressource de coffre de clés.

properties.privateEndpoint

Propriétés de l’objet de point de terminaison privé.

properties.privateLinkServiceConnectionState

État d’approbation de la connexion de liaison privée.

properties.provisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

tags
  • object

Étiquettes affectées à la ressource key vault.

type
  • string

Type de ressource de la ressource de coffre de clés.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Name Type Description
Creating
  • string
Deleting
  • string
Disconnected
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PrivateEndpointServiceConnectionStatus

État de connexion du point de terminaison privé.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

Name Type Description
actionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description
  • string

Motif de l’approbation ou du rejet.

status

Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.