Private Endpoint Connections - Put
Aktualizacje 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=2022-07-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
private
|
path | True |
string |
Nazwa połączenia prywatnego punktu końcowego skojarzonego z magazynem kluczy. |
resource
|
path | True |
string |
Nazwa grupy zasobów zawierającej magazyn kluczy. |
subscription
|
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. |
vault
|
path | True |
string |
Nazwa magazynu kluczy. Regex pattern: |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
etag |
string |
Zmodyfikowane za każdym razem, gdy wystąpi zmiana stanu połączenia prywatnego punktu końcowego. |
properties.privateEndpoint |
Właściwości obiektu prywatnego punktu końcowego. |
|
properties.privateLinkServiceConnectionState |
Stan zatwierdzenia połączenia z łączem prywatnym. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Stan połączenia prywatnego punktu końcowego został pomyślnie zaktualizowany. Headers
|
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Przykłady
KeyVaultPutPrivateEndpointConnection
Sample Request
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."
}
}
}
Sample Response
{
"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 |
---|---|
Actions |
Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta. |
Cloud |
Odpowiedź na błąd dostawcy zasobów Key Vault |
Cloud |
Odpowiedź na błąd dostawcy zasobów Key Vault |
Private |
Właściwości obiektu prywatnego punktu końcowego. |
Private |
Zasób połączenia prywatnego punktu końcowego. |
Private |
Bieżący stan aprowizacji. |
Private |
Stan połączenia prywatnego punktu końcowego. |
Private |
Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego. |
ActionsRequired
Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.
Nazwa | Typ | Opis |
---|---|---|
None |
string |
CloudError
Odpowiedź na błąd dostawcy zasobów Key Vault
Nazwa | Typ | Opis |
---|---|---|
error |
Odpowiedź na błąd dostawcy zasobów Key Vault |
CloudErrorBody
Odpowiedź na błąd dostawcy zasobów Key Vault
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. Jest to mnemonic, 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
Właściwości obiektu prywatnego punktu końcowego.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Pełny identyfikator zasobu prywatnego punktu końcowego. |
PrivateEndpointConnection
Zasób połączenia prywatnego punktu końcowego.
Nazwa | Typ | Opis |
---|---|---|
etag |
string |
Zmodyfikowane za każdym razem, gdy wystąpi zmiana stanu połączenia prywatnego punktu końcowego. |
id |
string |
W pełni kwalifikowany identyfikator zasobu magazynu kluczy. |
location |
string |
Lokalizacja platformy Azure zasobu magazynu kluczy. |
name |
string |
Nazwa zasobu magazynu kluczy. |
properties.privateEndpoint |
Właściwości obiektu prywatnego punktu końcowego. |
|
properties.privateLinkServiceConnectionState |
Stan zatwierdzenia połączenia z łączem prywatnym. |
|
properties.provisioningState |
Stan aprowizacji połączenia prywatnego punktu końcowego. |
|
tags |
object |
Tagi przypisane do zasobu magazynu kluczy. |
type |
string |
Typ zasobu magazynu kluczy. |
PrivateEndpointConnectionProvisioningState
Bieżący stan aprowizacji.
Nazwa | Typ | Opis |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
Stan połączenia prywatnego punktu końcowego.
Nazwa | Typ | Opis |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.
Nazwa | Typ | Opis |
---|---|---|
actionsRequired |
Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta. |
|
description |
string |
Przyczyna zatwierdzenia lub odrzucenia. |
status |
Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy. |