Shared Private Link Resources - Get

Serviço:: Search Management

Versão da API:: 2026-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=2026-11-01

Parâmetros do URI

Nome	Em	Obrigatório	Tipo	Descrição
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não faz distinção entre maiúsculas e minúsculas.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Pesquisa de IA do Azure associado ao grupo de recursos especificado.
sharedPrivateLinkResourceName	path	True	string	O nome do recurso de ligação privada partilhado gerido pelo serviço Pesquisa de IA do Azure dentro do grupo de recursos especificado.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Nome	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

Nome	Tipo	Descrição
200 OK	SharedPrivateLinkResource	Operação do Azure concluída com sucesso.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Nome	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

SharedPrivateLinkResourceGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Nome	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.
createdByType	O tipo de identidade que criou o recurso.
SharedPrivateLinkResource	Descreve um recurso de ligação privada partilhado gerido pelo serviço Pesquisa de IA do Azure.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de ligação privada partilhado existente, gerido pelo serviço Pesquisa de IA do Azure.
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.
systemData	Metadados referentes à criação e última modificação do recurso.

CloudError

Object

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

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

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

SharedPrivateLinkResource

Object

Descreve um recurso de ligação privada partilhado gerido pelo serviço Pesquisa de IA do Azure.

Nome	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/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 Pesquisa de IA do Azure.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

Descreve as propriedades de um recurso de ligação privada partilhado existente, gerido pelo serviço Pesquisa de IA do Azure.

Nome	Tipo	Descrição
groupId	string	A ID de grupo do provedor de recurso para o qual o recurso de link privado compartilhado é destinado.
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 para solicitar a aprovação do recurso de link privado compartilhado.
resourceRegion	string	Optional. Pode ser usado para especificar o local do Azure Resource Manager do recurso para o qual um link privado compartilhado está sendo 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	O recurso de link privado compartilhado está em processo de criação junto com outros recursos para que seja totalmente funcional.
Deleting	O recurso de link privado compartilhado está em processo de exclusão.
Failed	O recurso de link privado compartilhado não pôde ser provisionado ou excluído.
Succeeded	O recurso de link privado compartilhado concluiu o provisionamento e está pronto para aprovação.
Incomplete	A solicitação de provisionamento para o recurso de link privado compartilhado foi aceita, mas o processo de criação ainda não começou.

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	O recurso de link privado compartilhado foi criado e está pendente de aprovação.
Approved	O recurso de link privado compartilhado foi aprovado e está pronto para uso.
Rejected	O recurso de link privado compartilhado foi rejeitado e não pode ser usado.
Disconnected	O recurso de link privado compartilhado foi removido do serviço.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.