Private Endpoint Connections - Get

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-06-01-preview

Obter objeto de conexão de ponto de extremidade privado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-06-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataManagerForAgricultureResourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nome do recurso DataManagerForAgriculture.
privateEndpointConnectionName	path	True	string	Nome da conexão do ponto de extremidade privado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnection	Êxito
404 Not Found	ErrorResponse	Não encontrado
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

PrivateEndpointConnections_Get

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName?api-version=2023-06-01-preview

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName",
  "name": "privateEndpointConnectionName",
  "type": "Microsoft.AgFoodPlatform/farmBeats/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com",
      "actionsRequired": "None"
    },
    "provisioningState": "Succeeded"
  }
}

Código de status:: 404

{
  "error": {
    "code": "PrivateEndpointConnectionNotFound",
    "message": "Private endpoint connection resource 'privateEndpointConnectionName' for subscriptionId '11111111-2222-3333-4444-555555555555', resource group name 'examples-rg', resource type 'farmBeats' and resource name 'examples-farmbeatsResourceName' not found."
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrivateEndpoint

Objeto

O recurso de ponto de extremidade privado.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado.

PrivateEndpointConnection

Objeto

O recurso de conexão de ponto de extremidade privado.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupIds	string[]	As IDs de grupo para o recurso de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeração

O status da conexão do ponto de extremidade privado.

Valor	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objeto

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da conexão.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Private Endpoint Connections - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

PrivateEndpointConnections_Get

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

systemData