Private Endpoint Connections - Put

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Updates die angegebene private Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Name der privaten Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den Schlüsseltresor enthält.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vaultName	path	True	string	Der Name des Schlüsseltresors. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
etag	string	Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.
properties.privateEndpoint	PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Genehmigungsstatus der Private Link-Verbindung.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Der Status der Verbindung mit dem privaten Endpunkt wurde erfolgreich aktualisiert. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Name

Typ

Beschreibung

200 OK

PrivateEndpointConnection

Der Status der Verbindung mit dem privaten Endpunkt wurde erfolgreich aktualisiert.

Headers

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

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

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

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
PrivateEndpointConnection	Verbindungsressource für private Endpunkte.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Die verbindung mit dem privaten Endpunkt status.
PrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

Name	Typ	Beschreibung
None	string

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.