Private Endpoint Connections - Put

Serviço:: Key Vault

Versão da API:: 2024-11-01

Atualiza a conexão de ponto de extremidade privada especificada associada ao cofre de chaves.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
privateEndpointConnectionName	path	True	string	Nome da conexão de ponto de extremidade privada associada ao cofre de chaves.
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o cofre de chaves.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	O nome do cofre de chaves.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Tipo	Description
etag	string	Modificado sempre que há uma alteração no estado da conexão de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprovação da conexão de link privado.

Respostas

Name	Tipo	Description
200 OK	PrivateEndpointConnection	O estado da conexão de ponto de extremidade privado foi atualizado com êxito. Cabeçalhos Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

PrivateEndpointConnection

O estado da conexão de ponto de extremidade privado foi atualizado com êxito.

Cabeçalhos

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Exemplos

KeyVaultPutPrivateEndpointConnection

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  }
}

Definições

Name	Description
ActionsRequired	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
PrivateEndpointConnection	Recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.

ActionsRequired

Enumeração

Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.

Valor	Description
None

CloudError

Object

Uma resposta de erro do provedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Object

Uma resposta de erro do provedor de recursos Key Vault

Name	Tipo	Description
code	string	Código de erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem é normalmente localizada e pode variar com a versão do serviço.