Private Endpoint Connections - Put

Služba:

Key Vault

Verze rozhraní API:

2024-11-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-11-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 zdrojů, která obsahuje klíčové úložiště.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Název trezoru klíčů.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
etag	string	Změněno 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í privátního propojení

Odpovědi

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

Příklady

KeyVaultPutPrivateEndpointConnection

Ukázkový požadavek

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=2024-11-01

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

Ukázková odpověď

Stavový kód:

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, která indikuje, 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

Výčet

Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

Hodnota	Description
None

CloudError

Objekt

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

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

CloudErrorBody

Objekt

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

Name	Typ	Description
code	string	Kód chyby Jedná se o mnemotechnickou pomůcku, kterou lze programově využívat.
message	string	Uživatelsky přívětivá chybová hláška. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

PrivateEndpoint

Objekt

Vlastnosti objektu privátního koncového bodu.

Name	Typ	Description
id	string	Úplný identifikátor prostředku privátního koncového bodu.

PrivateEndpointConnection

Objekt

Prostředek připojení privátního koncového bodu.

Name	Typ	Description
etag	string	Změněno vždy, když dojde ke změně stavu připojení privátního koncového bodu.
id	string	Plně kvalifikovaný identifikátor prostředku trezoru klíčů.
location	string	Umístění prostředku trezoru klíčů v Azure.
name	string	Název prostředku trezoru klíčů.
properties.privateEndpoint	PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav schválení připojení privátního propojení
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu
tags	object	Značky přiřazené k prostředku trezoru klíčů.
type	string	Typ prostředku trezoru klíčů.

PrivateEndpointConnectionProvisioningState

Výčet

Aktuální stav zřizování.

Hodnota	Description
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu.

Hodnota	Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Objekt

Objekt, který představuje stav schválení připojení privátního propojení.

Name	Typ	Description
actionsRequired	ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů.