Private Endpoint Connections - Get

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

Obtém os detalhes da conexão de ponto de extremidade privado com o serviço de pesquisa no grupo de recursos fornecido.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-03-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
privateEndpointConnectionName	path	True	string	O nome da conexão de ponto de extremidade privado com o serviço Azure AI Search com o grupo de recursos especificado.
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma forma de rastrear a solicitação.

Respostas

Name	Tipo	Descrição
200 OK	PrivateEndpointConnection	A definição da conexão de ponto de extremidade privado foi recuperada com êxito e está na resposta.
Other Status Codes	CloudError	HTTP 404 (Não encontrado): Não foi possível encontrar a assinatura, o grupo de recursos, o serviço de pesquisa ou a conexão de ponto de extremidade privado.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

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

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

PrivateEndpointConnectionGet

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2024-03-01-preview

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "",
      "actionsRequired": "None"
    }
  }
}

Definições

Name	Descrição
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
PrivateEndpointConnection	Descreve uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.
PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.
PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.
PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
PrivateLinkServiceConnectionStatus	Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

CloudError

Object

Contém informações sobre um erro de API.

Name	Tipo	Descrição
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

Descreve um erro de API específico com um código de erro e uma mensagem.

Name	Tipo	Descrição
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

PrivateEndpoint

Object

O recurso de ponto de extremidade privado do provedor Microsoft.Network.

Name	Tipo	Descrição
id	string	A ID do recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnection

Object

Descreve uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.

Name	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.

Name	Tipo	Descrição
groupId	string	A ID de grupo do recurso do Azure para o qual o serviço de link privado é destinado.
privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
provisioningState	PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.

PrivateLinkServiceConnectionProvisioningState

Enumeração

O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.

Valor	Descrição
Updating	A conexão do serviço de link privado está em processo de criação junto com outros recursos para que seja totalmente funcional.
Deleting	A conexão do serviço de link privado está em processo de exclusão.
Failed	A conexão do serviço de link privado não pôde ser provisionada ou excluída.
Succeeded	A conexão de serviço de link privado concluiu o provisionamento e está pronta para aprovação.
Incomplete	A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi aceita, mas o processo de criação ainda não começou.
Canceled	A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada.

PrivateLinkServiceConnectionState

Object

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.

Name	Tipo	Valor predefinido	Descrição
actionsRequired	string	None	Uma descrição de quaisquer ações adicionais que possam ser necessárias.
description	string		A descrição do estado de conexão do serviço de link privado.
status	PrivateLinkServiceConnectionStatus		Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

PrivateLinkServiceConnectionStatus

Enumeração

Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Valor	Descrição
Pending	A conexão de ponto de extremidade privado foi criada e está pendente de aprovação.
Approved	A conexão de ponto de extremidade privada foi aprovada e está pronta para uso.
Rejected	A conexão de ponto de extremidade privada foi rejeitada e não pode ser usada.
Disconnected	A conexão de ponto de extremidade privado foi removida do serviço.