Private Endpoint Connections - Put

Usługa:

Key Vault

Wersja interfejsu API:

2024-11-01

Aktualizuje określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
privateEndpointConnectionName	path	True	string	Nazwa połączenia prywatnego punktu końcowego skojarzonego z magazynem kluczy.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej magazyn kluczy.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nazwa magazynu kluczy.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
etag	string	Modyfikowane za każdym razem, gdy nastąpi zmiana stanu połączenia prywatnego punktu końcowego.
properties.privateEndpoint	PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia łącza prywatnego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnection	Stan połączenia z prywatnym punktem końcowym został pomyślnie zaktualizowany. Nagłówki Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

KeyVaultPutPrivateEndpointConnection

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
ActionsRequired	Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy.
CloudError	Odpowiedź o błędzie od dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault
PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia z prywatnym punktem końcowym.
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

ActionsRequired

Wyliczenie

Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy.

Wartość	Opis
None

CloudError

Objekt

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault

CloudErrorBody

Objekt

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonik, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

PrivateEndpoint

Objekt

Właściwości obiektu prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointConnection

Objekt

Zasób połączenia z prywatnym punktem końcowym.

Nazwa	Typ	Opis
etag	string	Modyfikowane za każdym razem, gdy nastąpi zmiana stanu połączenia prywatnego punktu końcowego.
id	string	W pełni kwalifikowany identyfikator zasobu magazynu kluczy.
location	string	Lokalizacja zasobu magazynu kluczy na platformie Azure.
name	string	Nazwa zasobu magazynu kluczy.
properties.privateEndpoint	PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia łącza prywatnego.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
tags	object	Tagi przypisane do zasobu magazynu kluczy.
type	string	Typ zasobu magazynu kluczy.

PrivateEndpointConnectionProvisioningState

Wyliczenie

Bieżący stan aprowizacji.

Wartość	Opis
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Wyliczenie

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Objekt

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

Nazwa	Typ	Opis
actionsRequired	ActionsRequired	Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy.
description	string	Przyczyna zatwierdzenia lub odrzucenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.