Private Endpoint Connections - Put

Service:

Key Vault

API Version:

2022-07-01

Aggiornamenti la connessione dell'endpoint privato specificata associata all'insieme di credenziali delle chiavi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
privateEndpointConnectionName	path	True	string	Nome della connessione all'endpoint privato associata all'insieme di credenziali delle chiavi.
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'insieme di credenziali delle chiavi.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
vaultName	path	True	string	Nome dell'insieme di credenziali delle chiavi. Regex pattern: ^[a-zA-Z0-9-]{3,24}$
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
properties.privateEndpoint	PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di approvazione della connessione di collegamento privato.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	Lo stato della connessione all'endpoint privato è stato aggiornato correttamente. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

KeyVaultPutPrivateEndpointConnection

Sample Request

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

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

Python

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

Sample Response

Status code:

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

Definizioni

Nome	Descrizione
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
CloudError	Risposta di errore da Key Vault provider di risorse
CloudErrorBody	Risposta di errore da Key Vault provider di risorse
PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
PrivateEndpointConnection	Risorsa di connessione dell'endpoint privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning corrente.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.

ActionsRequired

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

Nome	Tipo	Descrizione
None	string

CloudError

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore da Key Vault provider di risorse

CloudErrorBody

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore descrittivo. Il messaggio viene in genere localizzato e può variare con la versione del servizio.

PrivateEndpoint

Proprietà dell'oggetto endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa dell'endpoint privato.

PrivateEndpointConnection

Risorsa di connessione dell'endpoint privato.

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
id	string	Identificatore completo della risorsa dell'insieme di credenziali delle chiavi.
location	string	Posizione di Azure della risorsa dell'insieme di credenziali delle chiavi.
name	string	Nome della risorsa dell'insieme di credenziali delle chiavi.
properties.privateEndpoint	PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di approvazione della connessione di collegamento privato.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
tags	object	Tag assegnati alla risorsa dell'insieme di credenziali delle chiavi.
type	string	Tipo di risorsa della risorsa dell'insieme di credenziali delle chiavi.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.

Nome	Tipo	Descrizione
actionsRequired	ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
description	string	Motivo dell'approvazione o del rifiuto.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.