Private Endpoint Connections - Put

Обновляет указанное подключение к частной конечной точке, связанное с хранилищем ключей.

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

Параметры URI

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

Имя подключения частной конечной точки, связанного с хранилищем ключей.

resourceGroupName
path True
  • string

Имя группы ресурсов, содержащей хранилище ключей.

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.

vaultName
path True
  • string

Имя хранилища ключей.

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

api-version
query True
  • string

Версия клиентского API.

Текст запроса

Name Type Description
etag
  • string

Изменяется при каждом изменении состояния подключения к частной конечной точке.

properties.privateEndpoint

Свойства объекта частной конечной точки.

properties.privateLinkServiceConnectionState

Состояние утверждения подключения приватного канала.

Ответы

Name Type Description
200 OK

Состояние подключения к частной конечной точке было успешно обновлено.

Headers

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

Ответ об ошибке, описывающий причину сбоя операции.

Примеры

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

Определения

ActionsRequired

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.

CloudError

Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

Ответ об ошибке от поставщика ресурсов Key Vault

PrivateEndpoint

Свойства объекта частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

Объект, представляющий состояние утверждения подключения приватного канала.

ActionsRequired

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.

Name Type Description
None
  • string

CloudError

Ответ об ошибке от поставщика ресурсов Key Vault

Name Type Description
error

Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

Ответ об ошибке от поставщика ресурсов Key Vault

Name Type Description
code
  • string

Код ошибки. Это mnemonic, который можно использовать программным способом.

message
  • string

Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться от версии службы.

PrivateEndpoint

Свойства объекта частной конечной точки.

Name Type Description
id
  • string

Полный идентификатор ресурса частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Name Type Description
etag
  • string

Изменяется при каждом изменении состояния подключения к частной конечной точке.

id
  • string

Полный идентификатор ресурса хранилища ключей.

location
  • string

Расположение ресурса хранилища ключей в Azure.

name
  • string

Имя ресурса хранилища ключей.

properties.privateEndpoint

Свойства объекта частной конечной точки.

properties.privateLinkServiceConnectionState

Состояние утверждения подключения приватного канала.

properties.provisioningState

Состояние подготовки подключения к частной конечной точке.

tags
  • object

Теги, назначенные ресурсу хранилища ключей.

type
  • string

Тип ресурса хранилища ключей.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

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

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

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

PrivateLinkServiceConnectionState

Объект, представляющий состояние утверждения подключения приватного канала.

Name Type Description
actionsRequired

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.

description
  • string

Причина утверждения или отклонения.

status

Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.