Shared Private Link Resources - Get

Obtém os detalhes do recurso de ligação privada partilhado gerido pelo serviço de pesquisa no grupo de recursos especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
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.

searchServiceName
path True

string

O nome do serviço de pesquisa associado ao grupo de recursos especificado.

sharedPrivateLinkResourceName
path True

string

O nome do recurso de ligação privada partilhado gerido pelo serviço de pesquisa no grupo de recursos especificado.

subscriptionId
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

SharedPrivateLinkResource

A definição do recurso de ligação privada partilhada foi obtida com êxito e está na resposta.

Other Status Codes

CloudError

HTTP 404 (Não Encontrado): não foi possível localizar a subscrição, o grupo de recursos, o serviço de pesquisa ou o recurso de ligação privada partilhado.

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

SharedPrivateLinkResourceGet

Pedido de amostra

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

Resposta da amostra

{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

Definições

Name Description
CloudError

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

CloudErrorBody

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

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado gerido pelo serviço de pesquisa.

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Private Link Partilhado existente gerido pelo serviço de pesquisa.

SharedPrivateLinkResourceProvisioningState

O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado. 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

CloudErrorBody

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

CloudErrorBody[]

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).

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado gerido pelo 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

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Private Link Partilhado gerido pelo serviço de pesquisa.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Private Link Partilhado existente gerido pelo serviço de pesquisa.

Name Tipo Description
groupId

string

O ID de grupo do fornecedor do recurso para o qual se destina o recurso de ligação privada partilhada.

privateLinkResourceId

string

O ID de recurso do recurso para o recurso de ligação privada partilhada destina-se a.

provisioningState

SharedPrivateLinkResourceProvisioningState

O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.

requestMessage

string

A mensagem de pedido para pedir a aprovação do recurso de ligação privada partilhada.

resourceRegion

string

Opcional. Pode ser utilizado para especificar o Azure Resource Manager localização do recurso para o qual será criada uma ligação privada partilhada. Isto só é necessário para os recursos cuja configuração DNS seja regional (por exemplo, Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desligado.

SharedPrivateLinkResourceProvisioningState

O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.

Name Tipo Description
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desligado.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string