Private Endpoint Connections - Put

Actualiza la conexión de punto de conexión privado especificada asociada al almacén de claves.

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

Parámetros de identificador URI

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

Nombre de la conexión de punto de conexión privado asociada al almacén de claves.

resourceGroupName
path True
  • string

Nombre del grupo de recursos que contiene el almacén de claves.

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

vaultName
path True
  • string

Nombre del almacén de claves.

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

api-version
query True
  • string

Versión de api de cliente.

Cuerpo de la solicitud

Name Type Description
etag
  • string

Se modifica cada vez que se produce un cambio en el estado de la conexión de punto de conexión privado.

properties.privateEndpoint

Propiedades del objeto de punto de conexión privado.

properties.privateLinkServiceConnectionState

Estado de aprobación de la conexión de vínculo privado.

Respuestas

Name Type Description
200 OK

El estado de la conexión de punto de conexión privado se actualizó correctamente.

Headers

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

Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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

Definiciones

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

CloudError

Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

PrivateEndpoint

Propiedades del objeto de punto de conexión privado.

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

PrivateLinkServiceConnectionState

Objeto que representa el estado de aprobación de la conexión de vínculo privado.

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Name Type Description
None
  • string

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Name Type Description
error

Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Name Type Description
code
  • string

Código de error. Se trata de una mnemónica que se puede consumir mediante programación.

message
  • string

Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

PrivateEndpoint

Propiedades del objeto de punto de conexión privado.

Name Type Description
id
  • string

Identificador completo del recurso de punto de conexión privado.

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

Name Type Description
etag
  • string

Se modifica cada vez que se produce un cambio en el estado de la conexión de punto de conexión privado.

id
  • string

Identificador completo del recurso del almacén de claves.

location
  • string

Ubicación de Azure del recurso del almacén de claves.

name
  • string

Nombre del recurso del almacén de claves.

properties.privateEndpoint

Propiedades del objeto de punto de conexión privado.

properties.privateLinkServiceConnectionState

Estado de aprobación de la conexión de vínculo privado.

properties.provisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

tags
  • object

Etiquetas asignadas al recurso del almacén de claves.

type
  • string

Tipo de recurso del recurso del almacén de claves.

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

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

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

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

PrivateLinkServiceConnectionState

Objeto que representa el estado de aprobación de la conexión de vínculo privado.

Name Type Description
actionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

description
  • string

Motivo de aprobación o rechazo.

status

Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.