Private Endpoint Connections - Put

Referência

Serviço:: Key Vault

Versão da API:: 2022-07-01

Atualiza 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 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 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.

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

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python put_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_endpoint_connections.put(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
        properties={
            "etag": "",
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "My name is Joe and I'm approving this.",
                    "status": "Approved",
                }
            },
        },
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/putPrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 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

Nome	Description
ActionsRequired	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
CloudError	Uma resposta de erro do provedor de recursos do Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos do Key Vault
PrivateEndpoint	Propriedades de 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 do 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 que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

Valor	Description
None

CloudError

Objeto

Uma resposta de erro do provedor de recursos do Key Vault

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

CloudErrorBody

Objeto

Uma resposta de erro do provedor de recursos do Key Vault

Nome	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.