Private Endpoint Connections - Put

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=2021-10-01

Parametry identyfikatora URI

Name In Required Type Description
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ą Microsoft Azure subskrypcji. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

vaultName
path True
  • string

Nazwa magazynu kluczy.

Regex pattern: ^[a-zA-Z0-9-]{3,24}$

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

Name Type Description
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

Name Type Description
200 OK

Stan połączenia prywatnego punktu końcowego został pomyślnie zaktualizowany.

Headers

  • Retry-After: integer
  • Azure-AsyncOperation: string
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=2021-10-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

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

CloudError

Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź na błąd dostawcy zasobów Key Vault

PrivateEndpoint

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

PrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

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

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

Name Type Description
None
  • string

CloudError

Odpowiedź na błąd dostawcy zasobów Key Vault

Name Type Description
error

Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź na błąd dostawcy zasobów Key Vault

Name Type Description
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.

Name Type Description
id
  • string

Pełny identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

Name Type Description
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.

Name Type Description
Creating
  • string
Deleting
  • string
Disconnected
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
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.