Shared Private Link Resources - Get

Serviço:: Search Management

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

Obtém os detalhes do recurso de link privado compartilhado gerenciado pelo serviço de pesquisa no grupo de recursos fornecido.

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	Obrigatório	Tipo	Descrição
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	O nome do serviço de pesquisa associado ao grupo de recursos especificado.
sharedPrivateLinkResourceName	path	True	string	O nome do recurso de link privado compartilhado gerenciado pelo serviço de pesquisa dentro do 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 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	SharedPrivateLinkResource	A definição do recurso de link privado compartilhado 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 o recurso de link privado compartilhado.

Segurança

azure_auth

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

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

SharedPrivateLinkResourceGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "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	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.
SharedPrivateLinkResource	Descreve um recurso de link privado compartilhado gerenciado pelo serviço de pesquisa.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado pelo serviço de pesquisa.
SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito ou Incompleto.
SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. 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.

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

SharedPrivateLinkResource

Object

Descreve um recurso de link privado compartilhado gerenciado pelo serviço de pesquisa.

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	SharedPrivateLinkResourceProperties	Descreve as propriedades de um Recurso de Link Privado Compartilhado gerenciado pelo serviço de pesquisa.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado pelo serviço de pesquisa.

Name	Tipo	Descrição
groupId	string	A id de grupo do provedor de recurso para o qual o recurso de link privado compartilhado se destina.
privateLinkResourceId	string	A id do recurso para o qual o recurso de link privado compartilhado se destina.
provisioningState	SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito ou Incompleto.
requestMessage	string	A mensagem de solicitação para solicitar a aprovação do recurso de link privado compartilhado.
resourceRegion	string	Opcional. Pode ser usado para especificar o local do Azure Resource Manager do recurso para o qual um link privado compartilhado deve ser criado. Isso só é necessário para os recursos cuja configuração de DNS é regional (como o Serviço Kubernetes do Azure).
status	SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

SharedPrivateLinkResourceProvisioningState

Enumeração

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito ou Incompleto.

Valor	Descrição
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Enumeração

Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Valor	Descrição
Pending
Approved
Rejected
Disconnected