Private Endpoint Connections - List By Service
Obtém uma lista de todas as ligações de ponto final 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. |
search
|
path | True |
string |
O nome do serviço de pesquisa associado ao grupo de recursos especificado. |
subscription
|
path | True |
string |
O identificador exclusivo de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API Resource Manager do Azure, das ferramentas de linha de comandos ou do portal. |
api-version
|
query | True |
string |
A versão da API a utilizar para cada pedido. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Um valor GUID gerado pelo cliente que identifica este pedido. Se for especificado, isto será incluído nas informações de resposta como forma de controlar o pedido. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A operação foi efetuada com êxito. A resposta contém a lista de todas as ligações de ponto final privado para o serviço especificado. |
|
Other Status Codes |
Ocorreu um erro inesperado durante a operação. |
Segurança
azure_auth
Microsoft Entra ID fluxo de autorização OAuth2.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ListPrivateEndpointConnectionsByService
Pedido de amostra
Resposta da amostra
{
"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
Name | Description |
---|---|
Cloud |
Contém informações sobre um erro de API. |
Cloud |
Descreve um erro específico da API com um código de erro e uma mensagem. |
Private |
O recurso de ponto final privado do fornecedor Microsoft.Network. |
Private |
Descreve uma ligação de ponto final privado existente ao serviço de pesquisa. |
Private |
Resposta que contém uma lista de ligações de Ponto Final Privado. |
Private |
Descreve as propriedades de uma ligação de Ponto Final Privado existente ao serviço de pesquisa. |
Private |
O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto |
Private |
Descreve o estado atual de uma ligação do Serviço Private Link existente ao Ponto Final Privado do Azure. |
Private |
Estado da ligação do serviço de ligação privada. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desligado. |
CloudError
Contém informações sobre um erro de API.
Name | Tipo | Description |
---|---|---|
error |
Descreve um erro específico da API com um código de erro e uma mensagem. |
CloudErrorBody
Descreve um erro específico da API com um código de erro e uma mensagem.
Name | 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 estado HTTP. Pode ser utilizado para processar programaticamente casos de erro específicos. |
details |
Contém erros aninhados relacionados com este erro. |
|
message |
string |
Uma mensagem que descreve o erro em detalhe e fornece informações de depuração. |
target |
string |
O destino do erro específico (por exemplo, o nome da propriedade em erro). |
PrivateEndpoint
O recurso de ponto final privado do fornecedor Microsoft.Network.
Name | Tipo | Description |
---|---|---|
id |
string |
O ID de recurso do recurso de ponto final privado do fornecedor Microsoft.Network. |
PrivateEndpointConnection
Descreve uma ligação de ponto final privado existente ao serviço de pesquisa.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties |
Descreve as propriedades de uma ligação de ponto final privado existente ao serviço de pesquisa. |
|
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionListResult
Resposta que contém uma lista de ligações de Ponto Final Privado.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
URL do pedido que pode ser utilizado para consultar a página seguinte de ligações de ponto final privado. Devolvido quando o número total de ligações de ponto final privado pedido exceder o tamanho máximo da página. |
value |
A lista de ligações de Ponto Final Privado. |
PrivateEndpointConnectionProperties
Descreve as propriedades de uma ligação de Ponto Final Privado existente ao serviço de pesquisa.
Name | Tipo | Description |
---|---|---|
groupId |
string |
O ID de grupo do fornecedor do recurso para o qual se destina a ligação de serviço de ligação privada. |
privateEndpoint |
O recurso de ponto final privado do fornecedor Microsoft.Network. |
|
privateLinkServiceConnectionState |
Descreve o estado atual de uma ligação do Serviço Private Link existente ao Ponto Final Privado do Azure. |
|
provisioningState |
O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto |
PrivateLinkServiceConnectionProvisioningState
O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto
Name | Tipo | Description |
---|---|---|
Canceled |
string |
O pedido de aprovisionamento para o recurso de ligação do serviço de ligação do private link foi cancelado |
Deleting |
string |
A ligação do serviço de ligação privada está a ser eliminada. |
Failed |
string |
A ligação do serviço de ligação privada não foi aprovisionada ou eliminada. |
Incomplete |
string |
O pedido de aprovisionamento para o recurso de ligação do serviço de ligação de ligação privada foi aceite, mas o processo de criação ainda não começou. |
Succeeded |
string |
A ligação do serviço de ligação privada terminou o aprovisionamento e está pronta para aprovação. |
Updating |
string |
A ligação do serviço de ligação privada está a ser criada juntamente com outros recursos para que fique totalmente funcional. |
PrivateLinkServiceConnectionState
Descreve o estado atual de uma ligação do Serviço Private Link existente ao Ponto Final Privado do Azure.
Name | Tipo | Default value | Description |
---|---|---|---|
actionsRequired |
string |
None |
Uma descrição de quaisquer ações adicionais que possam ser necessárias. |
description |
string |
A descrição do estado de ligação do serviço de ligação privada. |
|
status |
Estado da ligação do serviço de ligação privada. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desligado. |
PrivateLinkServiceConnectionStatus
Estado da ligação do serviço de ligação privada. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desligado.
Name | Tipo | Description |
---|---|---|
Approved |
string |
A ligação de ponto final privado é aprovada e está pronta para ser utilizada. |
Disconnected |
string |
A ligação de ponto final privado foi removida do serviço. |
Pending |
string |
A ligação de ponto final privado foi criada e está pendente de aprovação. |
Rejected |
string |
A ligação de ponto final privado foi rejeitada e não pode ser utilizada. |