Compartilhar via


Private Endpoint Connections - Put

Atualizações a conexão de ponto de extremidade privado especificada associada ao cofre de chaves.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
privateEndpointConnectionName
path True

string

Nome da conexão de ponto de extremidade privado 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. A ID da assinatura faz parte do URI para cada chamada de serviço.

vaultName
path True

string

O nome do cofre de chaves.

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

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Tipo Description
etag

string

Modificado sempre que houver 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

Nome 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 que descreve por que a operação falhou.

Exemplos

KeyVaultPutPrivateEndpointConnection

Solicitação de exemplo

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=2022-07-01

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

Resposta de exemplo

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

Nome Description
ActionsRequired

Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no 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

A conexão de ponto de extremidade privado status.

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da conexão de link privado.

ActionsRequired

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

Nome Tipo Description
None

string

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome Tipo Description
error

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome Tipo Description
code

string

Código do erro. Este é um mnemônico que pode ser consumido programaticamente.

message

string

Mensagem de erro amigável. Normalmente, a mensagem é localizada e pode variar com a versão do serviço.

PrivateEndpoint

Propriedades do objeto de ponto de extremidade privado.

Nome Tipo Description
id

string

Identificador completo do recurso de ponto de extremidade privado.

PrivateEndpointConnection

Recurso de conexão de ponto de extremidade privado.

Nome Tipo Description
etag

string

Modificado sempre que houver uma alteração no estado da conexão de ponto de extremidade privado.

id

string

Identificador totalmente qualificado do recurso do cofre de chaves.

location

string

Local do Azure do recurso do cofre de chaves.

name

string

Nome do recurso do cofre de chaves.

properties.privateEndpoint

PrivateEndpoint

Propriedades do objeto de ponto de extremidade privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado de aprovação da conexão de link privado.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Estado de provisionamento da conexão de ponto de extremidade privado.

tags

object

Marcas atribuídas ao recurso do cofre de chaves.

type

string

Tipo de recurso do recurso do cofre de chaves.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Nome Tipo Description
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

A conexão de ponto de extremidade privado status.

Nome Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da conexão de link privado.

Nome Tipo Description
actionsRequired

ActionsRequired

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

description

string

O motivo da aprovação ou rejeição.

status

PrivateEndpointServiceConnectionStatus

Indica se a conexão foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.