Private Endpoint Connections - Put

Reference

Service:: Key Vault

API Version:: 2022-07-01

Aktualizace zadané připojení privátního koncového bodu přidruženého k trezoru klíčů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
privateEndpointConnectionName	path	True	string	Název připojení privátního koncového bodu přidruženého k trezoru klíčů.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje trezor klíčů.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
vaultName	path	True	string	Název trezoru klíčů. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
etag	string	Upraví se vždy, když dojde ke změně stavu připojení privátního koncového bodu.
properties.privateEndpoint	PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav schválení připojení private link.

Odpovědi

Name	Typ	Description
200 OK	PrivateEndpointConnection	Stav připojení privátního koncového bodu se úspěšně aktualizoval. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

PrivateEndpointConnection

Stav připojení privátního koncového bodu se úspěšně aktualizoval.

Headers

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Příklady

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

Definice

Name	Description
ActionsRequired	Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
PrivateEndpointConnection	Prostředek připojení privátního koncového bodu.
PrivateEndpointConnectionProvisioningState	Aktuální stav zřizování.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.

ActionsRequired

Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

Name	Typ	Description
None	string

CloudError

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Toto je mnemotechnická funkce, kterou je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.