Compartilhar 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 link privado com suporte para o serviço especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?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 por meio da API do Gerenciador de Recursos do Azure ou por meio 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 para uma assinatura do Microsoft Azure. Você pode obter esse valor da API de Resource Manager do Azure, 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 de GUID gerado pelo cliente que identifica esta 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

PrivateLinkResourcesResult

A operação foi realizada com êxito. A resposta contém a lista de todos os tipos de recursos de link privado com suporte para o serviço especificado.
Other Status Codes

CloudError

Erro inesperado durante operação.

Segurança

azure_auth

Microsoft Entra ID fluxo de autorização 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

ListSupportedPrivateLinkResources

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

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

Descreve um recurso de link privado com suporte para o serviço de pesquisa.
PrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado com suporte para o serviço de pesquisa. Para uma determinada versão da API, isso representa as groupIds 'com suporte' ao criar um recurso de link privado compartilhado.
PrivateLinkResourcesResult

Resposta que contém uma lista de recursos de Link Privado com suporte.
ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.
ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.

CloudError

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

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

PrivateLinkResource

Descreve um recurso de link privado com suporte para o 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

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado com suporte para o serviço de pesquisa.
type

string

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

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado com suporte para o serviço de pesquisa. Para uma determinada versão da API, isso representa as groupIds 'com suporte' ao criar um recurso de link privado compartilhado.

Nome Tipo Description
groupId

string

A ID do grupo do recurso de link privado.
requiredMembers

string[]

A lista de membros necessários do recurso de link privado.
requiredZoneNames

string[]

A lista de nomes de zona DNS necessários do recurso de link privado.
shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

A lista de recursos integrados ao serviço de link privado e que têm suporte na pesquisa.

PrivateLinkResourcesResult

Resposta que contém uma lista de recursos de Link Privado com suporte.

Nome Tipo Description
value

PrivateLinkResource[]

A lista de recursos de Link Privado com suporte.

ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.

Nome Tipo Description
description

string

A descrição do tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.
groupId

string

A ID do grupo do provedor de recursos para o recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.
type

string

O tipo de provedor de recursos para o recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.

ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.

Nome Tipo Description
name

string

O nome do tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.
properties

ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado e que é compatível com a pesquisa.