Shared Private Link Resources - List By Service

Serviço:: Search Management

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

Obtém uma lista de todos os recursos de link privado compartilhados gerenciados pelo serviço especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?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	SharedPrivateLinkResourceListResult	A operação foi bem-sucedida. A resposta contém a lista de todos os recursos de link privado compartilhados gerenciados pelo serviço determinado.
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

ListSharedPrivateLinkResourcesByService

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

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.
SharedPrivateLinkResource	Descreve um recurso de link privado compartilhado gerenciado pelo serviço de pesquisa.
SharedPrivateLinkResourceListResult	Resposta que contém uma lista de recursos de link privado compartilhados.
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 Atualização, Exclusão, Falha, Êxito ou Incompleto.
SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. 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).

SharedPrivateLinkResource

Objeto

Descreve um recurso de link privado compartilhado gerenciado pelo 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	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"

SharedPrivateLinkResourceListResult

Objeto

Resposta que contém uma lista de recursos de link privado compartilhados.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de recursos de link privado compartilhado, se houver algum.
value	SharedPrivateLinkResource[]	A lista de recursos de link privado compartilhados.

SharedPrivateLinkResourceProperties

Objeto

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

Nome	Tipo	Description
groupId	string	A ID do grupo do provedor de recurso para o qual o recurso de link privado compartilhado é usado.
privateLinkResourceId	string	A ID do recurso para o qual o recurso de link privado compartilhado é usado.
provisioningState	SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Ê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 ao 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 de Kubernetes do Azure).
status	SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

SharedPrivateLinkResourceProvisioningState

Enumeração

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

Valor	Description
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Enumeração

Status do recurso de link privado compartilhado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desconectados.

Valor	Description
Pending
Approved
Rejected
Disconnected