Partilhar via

Private Link Resources - List Supported

  • Referência
Serviço:
Search Management
Versão da API:
2023-11-01

Obtém uma lista de todos os tipos de recursos de ligação privada suportados para o serviço fornecido.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?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.
subscriptionId
 path True

string

O identificador exclusivo de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API de 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

PrivateLinkResourcesResult

A operação foi efetuada com êxito. A resposta contém a lista de todos os tipos de recursos de ligação privada suportados para o serviço fornecido.
Other Status Codes

CloudError

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

ListSupportedPrivateLinkResources

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService",
      "name": "searchService",
      "type": "Microsoft.Search/searchServices/privateLinkResources",
      "properties": {
        "groupId": "searchService",
        "requiredMembers": [
          "searchService"
        ],
        "requiredZoneNames": [
          "privatelink.search.windows.net"
        ],
        "shareablePrivateLinkResourceTypes": [
          {
            "name": "blob",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "groupId": "blob",
              "description": "Azure Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "table",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "groupId": "table",
              "description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "Sql",
            "properties": {
              "type": "Microsoft.DocumentDB/databaseAccounts",
              "groupId": "Sql",
              "description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)."
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.Sql/servers",
              "groupId": "sqlServer",
              "description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)."
            }
          },
          {
            "name": "vault",
            "properties": {
              "type": "Microsoft.KeyVault/vaults",
              "groupId": "vault",
              "description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.DBforMySQL/servers",
              "groupId": "mysqlServer",
              "description": "Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)."
            }
          },
          {
            "name": "site",
            "properties": {
              "type": "Microsoft.Web/sites",
              "groupId": "sites",
              "description": "Azure Cognitive Search indexers can connect to App Services when executing custom web api skills that can be present in a skillset (optional) attached to the indexer."
            }
          }
        ]
      }
    }
  ]
}

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

Descreve um recurso de ligação privada suportado para o serviço de pesquisa.
PrivateLinkResourceProperties

Descreve as propriedades de um recurso de ligação privada suportado para o serviço de pesquisa. Para uma determinada versão da API, isto representa os groupIds "suportados" ao criar um recurso de ligação privada partilhado.
PrivateLinkResourcesResult

Resposta que contém uma lista de Recursos Private Link suportados.
ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.
ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.

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

PrivateLinkResource

Descreve um recurso de ligação privada suportado para o 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

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de ligação privada suportado para o serviço de pesquisa.
type

string

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

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de ligação privada suportado para o serviço de pesquisa. Para uma determinada versão da API, isto representa os groupIds "suportados" ao criar um recurso de ligação privada partilhado.

Name Tipo Description
groupId

string

O ID de grupo do recurso de ligação privada.
requiredMembers

string[]

A lista de membros necessários do recurso de ligação privada.
requiredZoneNames

string[]

A lista dos nomes de zona DNS necessários do recurso de ligação privada.
shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

A lista de recursos que estão integrados no serviço de ligação privada e que são suportados pela pesquisa.

PrivateLinkResourcesResult

Resposta que contém uma lista de Recursos Private Link suportados.

Name Tipo Description
value

PrivateLinkResource[]

A lista de Recursos Private Link suportados.

ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.

Name Tipo Description
description

string

A descrição do tipo de recurso que foi integrado no serviço de ligação privada e que é suportada pela pesquisa.
groupId

string

O ID do grupo do fornecedor de recursos para o recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.
type

string

O tipo de fornecedor de recursos para o recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.

ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.

Name Tipo Description
name

string

O nome do tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.
properties

ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado no serviço de ligação privada e que é suportado pela pesquisa.