Private Endpoint Connections - List By Service

Serviço:: Search Management

Versão da API:: 2023-11-01

Obtém uma lista de todas as conexões de ponto de extremidade privado no serviço especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
searchServiceName	path	True	string	O nome do serviço de pesquisa 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, das ferramentas de linha de comando ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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 maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	A operação foi bem-sucedida. A resposta contém a lista de todas as conexões de ponto de extremidade privado para o serviço especificado.
Other Status Codes	CloudError	Ocorreu um erro inesperado durante a operação.

Segurança

azure_auth

Fluxo de autorização do Microsoft Entra ID OAuth2.

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

ListPrivateEndpointConnectionsByService

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "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

Nome	Description
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 privado existente com o serviço de pesquisa.
PrivateEndpointConnectionListResult	Resposta que contém uma lista de conexões de ponto de extremidade privado.
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 do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto
PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão existente do Serviço de Link Privado com o Ponto de Extremidade Privado do Azure.
PrivateLinkServiceConnectionStatus	Status da conexão de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

CloudError

Objeto

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

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

CloudErrorBody

Objeto

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

Nome	Tipo	Description
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

Objeto

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

Nome	Tipo	Description
id	string	A ID do recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnection

Objeto

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

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada 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 privado existente com o serviço de pesquisa.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Objeto

Resposta que contém uma lista de conexões de ponto de extremidade privado.

Nome	Tipo	Description
nextLink	string	Solicitar URL que pode ser usada para consultar a próxima página de conexões de ponto de extremidade privado. Retornado quando o número total de conexões de ponto de extremidade privado solicitadas excede o tamanho máximo da página.
value	PrivateEndpointConnection[]	A lista de conexões de ponto de extremidade privado.

PrivateEndpointConnectionProperties

Objeto

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

Nome	Tipo	Description
groupId	string	A ID do grupo do provedor de recurso para o qual a conexão do serviço de link privado serve.
privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão existente do Serviço de Link Privado com o Ponto de Extremidade Privado do Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto

PrivateLinkServiceConnectionProvisioningState

Enumeração

O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto

Valor	Description
Updating	A conexão de serviço de link privado está em processo de criação junto com outros recursos para que ela 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 falhou ao ser provisionada ou excluída.
Succeeded	A conexão de serviço de link privado terminou 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

Objeto

Descreve o estado atual de uma conexão existente do Serviço de Link Privado com o Ponto de Extremidade Privado do Azure.

Nome	Tipo	Valor padrão	Description
actionsRequired	string	None	Uma descrição de todas as ações extras que podem 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 de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

PrivateLinkServiceConnectionStatus

Enumeração

Status da conexão de serviço de link privado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

Valor	Description
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 privado é aprovada e está pronta para uso.
Rejected	A conexão de ponto de extremidade privado foi rejeitada e não pode ser usada.
Disconnected	A conexão de ponto de extremidade privado foi removida do serviço.