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)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (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

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: 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	Получает или задает идентификатор.

PrivateEndpointConnection

Object

Представляет собой подключение к частной конечной точке.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	PrivateEndpointConnectionResponseProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
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	Тип удостоверения, которое последним изменило ресурс.