Private Endpoint Connections - Put

服务:

Key Vault

API 版本:

2024-11-01

更新与密钥保管库关联的指定专用终结点连接。

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

URI 参数

名称	在	必需	类型	说明
privateEndpointConnectionName	path	True	string	与密钥保管库关联的专用终结点连接的名称。
resourceGroupName	path	True	string	包含 Key Vault 的资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	密钥保管库的名称。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
etag	string	每当专用终结点连接状态发生更改时修改。
properties.privateEndpoint	PrivateEndpoint	专用终结点对象的属性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用链接连接的审批状态。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	专用终结点连接的状态已成功更新。 标头 Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	描述作失败的原因的错误响应。

示例

KeyVaultPutPrivateEndpointConnection

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
CloudError	来自 Key Vault 资源提供程序的错误响应
CloudErrorBody	来自 Key Vault 资源提供程序的错误响应
PrivateEndpoint	专用终结点对象属性。
PrivateEndpointConnection	专用终结点连接资源。
PrivateEndpointConnectionProvisioningState	当前预配状态。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	表示专用链接连接的审批状态的对象。

ActionsRequired

枚举

一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。

值	说明
None

CloudError

对象

来自 Key Vault 资源提供程序的错误响应

名称	类型	说明
error	CloudErrorBody	来自 Key Vault 资源提供程序的错误响应

CloudErrorBody

对象

来自 Key Vault 资源提供程序的错误响应

名称	类型	说明
code	string	错误代码。 这是一个可以通过编程方式使用的助记符。
message	string	用户友好的错误消息。 该消息通常是本地化的，可能因服务版本而异。

PrivateEndpoint

对象

专用终结点对象属性。

名称	类型	说明
id	string	专用终结点资源的完整标识符。

PrivateEndpointConnection

对象

专用终结点连接资源。

名称	类型	说明
etag	string	每当专用终结点连接状态发生更改时修改。
id	string	密钥保管库资源的完全限定标识符。
location	string	密钥保管库资源的 Azure 位置。
name	string	密钥保管库资源的名称。
properties.privateEndpoint	PrivateEndpoint	专用终结点对象的属性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用链接连接的审批状态。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
tags	object	分配给密钥保管库资源的标记。
type	string	密钥保管库资源的资源类型。

PrivateEndpointConnectionProvisioningState

枚举

当前预配状态。

值	说明
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

枚举

专用终结点连接状态。

值	说明
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

对象

表示专用链接连接的审批状态的对象。

名称	类型	说明
actionsRequired	ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准或拒绝的原因。
status	PrivateEndpointServiceConnectionStatus	指示密钥保管库所有者是否已批准、拒绝或删除连接。