Private Endpoint Connections - Get

服务:

Data Replication

API 版本:

2024-09-01

获取专用终结点连接详细信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-09-01

URI 参数

名称	在	必需	类型	说明
privateEndpointConnectionName	path	True	string pattern: ^[a-zA-Z0-9]*$	专用终结点连接名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
vaultName	path	True	string pattern: ^[a-zA-Z0-9]*$	保管库名称。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Gets the Private Endpoint Connection

示例请求

HTTP

GET https://management.azure.com/subscriptions/930CEC23-4430-4513-B855-DBA237E2F3BF/resourceGroups/rgswagger_2024-09-01/providers/Microsoft.DataReplication/replicationVaults/4/privateEndpointConnections/vbkm?api-version=2024-09-01

示例响应

状态代码:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataReplication/replicationVaults/vault1/privateEndpointConnections/connection1",
  "name": "kadsmyhrosefybpbwvwxs",
  "type": "ztysngp",
  "properties": {
    "provisioningState": "Canceled",
    "privateEndpoint": {
      "id": "cwcdqoynostmqwdwy"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "y",
      "actionsRequired": "afwbq"
    }
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
PrivateEndpoint	表示链接到专用终结点连接的专用终结点网络资源。
PrivateEndpointConnection	表示专用终结点连接。
PrivateEndpointConnectionResponseProperties	表示专用终结点连接响应属性。
PrivateEndpointConnectionStatus	获取或设置状态。
PrivateLinkServiceConnectionState	表示专用链接服务连接状态。
ProvisioningState	获取或设置电子邮件配置的预配状态。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

PrivateEndpoint

Object

表示链接到专用终结点连接的专用终结点网络资源。

名称	类型	说明
id	string	获取或设置 id。

PrivateEndpointConnection

Object

表示专用终结点连接。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	PrivateEndpointConnectionResponseProperties	此资源的资源特定属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionResponseProperties

Object

表示专用终结点连接响应属性。

名称	类型	说明
privateEndpoint	PrivateEndpoint	表示链接到专用终结点连接的专用终结点网络资源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	表示专用链接服务连接状态。
provisioningState	ProvisioningState	获取或设置专用终结点连接的预配状态。

PrivateEndpointConnectionStatus

枚举

获取或设置状态。

值	说明
Approved	已批准状态。
Disconnected	断开连接状态。
Pending	待处理状态。
Rejected	已拒绝状态。

PrivateLinkServiceConnectionState

Object

表示专用链接服务连接状态。

名称	类型	说明
actionsRequired	string	获取或设置所需的作。
description	string	获取或设置说明。
status	PrivateEndpointConnectionStatus	获取或设置状态。

ProvisioningState

枚举

获取或设置电子邮件配置的预配状态。

值	说明
Canceled	资源创建已取消
Creating	正在创建资源。
Deleting	正在删除资源。
Deleted	资源已被删除。
Failed	资源创建失败。
Succeeded	资源创建/更新成功。
Updating	资源正在更新中。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。