Private Endpoint Connections - Put

Uppdaterar den angivna privata slutpunktsanslutningen som är associerad med nyckelvalvet.

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

URI-parametrar

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

Namnet på den privata slutpunktsanslutning som är associerad med nyckelvalvet.

resourceGroupName
path True
  • string

Namnet på resursgruppen som innehåller nyckelvalvet.

subscriptionId
path True
  • string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

vaultName
path True
  • string

Namnet på nyckelvalvet.

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

api-version
query True
  • string

Klient-API-version.

Begärandetext

Name Type Description
etag
  • string

Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.

properties.privateEndpoint

Egenskaper för det privata slutpunktsobjektet.

properties.privateLinkServiceConnectionState

Godkännandetillstånd för den privata länkanslutningen.

Svar

Name Type Description
200 OK

Tillståndet för den privata slutpunktsanslutningen har uppdaterats.

Headers

  • Retry-After: integer
  • Azure-AsyncOperation: string
Other Status Codes

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Definitioner

ActionsRequired

Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.

CloudError

Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

PrivateEndpoint

Egenskaper för privata slutpunktsobjekt.

PrivateEndpointConnection

Anslutningsresurs för privat slutpunkt.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

PrivateLinkServiceConnectionState

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

ActionsRequired

Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.

Name Type Description
None
  • string

CloudError

Ett felsvar från Key Vault resursprovider

Name Type Description
error

Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name Type Description
code
  • string

Felkod. Detta är en mnemonic som kan användas programmatiskt.

message
  • string

Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

PrivateEndpoint

Egenskaper för privata slutpunktsobjekt.

Name Type Description
id
  • string

Fullständig identifierare för den privata slutpunktsresursen.

PrivateEndpointConnection

Anslutningsresurs för privat slutpunkt.

Name Type Description
etag
  • string

Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.

id
  • string

Fullständigt kvalificerad identifierare för nyckelvalvsresursen.

location
  • string

Azure-platsen för nyckelvalvsresursen.

name
  • string

Namnet på nyckelvalvsresursen.

properties.privateEndpoint

Egenskaper för det privata slutpunktsobjektet.

properties.privateLinkServiceConnectionState

Godkännandetillstånd för den privata länkanslutningen.

properties.provisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

tags
  • object

Taggar som tilldelats till nyckelvalvsresursen.

type
  • string

Resurstyp för nyckelvalvsresursen.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

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

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

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

PrivateLinkServiceConnectionState

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name Type Description
actionsRequired

Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.

description
  • string

Anledningen till godkännande eller avvisande.

status

Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.