Gerenciar o serviço Pesquisa de IA do Azure com as APIs REST

• Portal
• PowerShell
• CLI do Azure
• REST API

Neste artigo, saiba como criar e configurar um serviço Pesquisa de IA do Azure usando as APIs REST de Gerenciamento. Somente as APIs REST de Gerenciamento têm a garantia de fornecer acesso antecipado aos recursos em versão prévia.

A API REST de Gerenciamento está disponível em versões estáveis e de versão prévia. Certifique-se de definir uma versão da API de visualização se você estiver acessando recursos de visualização.

• Criar ou atualizar um serviço
• Habilitar o controle de acesso baseado em função do Azure para o plano de dados
• Aplicar uma política de chaves gerenciada pelo cliente
• Desativar classificação semântica
• Desabilitar cargas de trabalho que enviam dados para recursos externos
• Crie uma chave de consulta
• Gerar novamente uma chave de administrador
• Listar conexões de ponto de extremidade privado
• Listar operações de pesquisa
• Excluir um serviço de pesquisa

Todas as APIs REST de Gerenciamento têm exemplos. Se uma tarefa não for abordada neste artigo, confira a referência de API.

Pré-requisitos

• Uma assinatura do Azure – Crie uma gratuitamente.

• Visual Studio Code com um cliente REST.

• CLI do Azure usado para obter um token de acesso. Você deve ser proprietário ou administrador da sua assinatura do Azure.

Obter um token de acesso

As chamadas à API REST de Gerenciamento são autenticadas por meio do Microsoft Entra ID. Você precisa fornecer um token de acesso na solicitação, juntamente com permissões para criar e configurar um recurso.

Você pode usar o CLI do Azure ou Azure PowerShell para criar um token de acesso.

1. Abra um shell de comando para a CLI do Azure.

2. Entre em sua assinatura do Azure.

   az login
   

3. Obtenha o ID do locatário e o ID da assinatura. Se você tiver vários locatários ou assinaturas, certifique-se de usar o correto.

   az account show
   

4. Obtenha um token de acesso.

   az account get-access-token --query accessToken --output tsv
   

Configurar o Visual Studio Code

Se você não estiver familiarizado com o cliente REST para Visual Studio Code, esta seção incluirá a instalação para que você possa concluir as tarefas neste início rápido.

1. Inicie o Visual Studio Code e selecione o bloco Extensões.

2. Pesquise o cliente REST e selecione Instalar.

   

3. Abra ou crie um novo arquivo nomeado com uma extensão de arquivo .rest ou .http.

4. Forneça variáveis para os valores recuperados na etapa anterior.

   @tenantId = PASTE-YOUR-TENANT-ID-HERE
   @subscriptionId = PASTE-YOUR-SUBSCRIPTION-ID-HERE
   @token = PASTE-YOUR-TOKEN-HERE
   

5. Verifique se a sessão está operacional listando os serviços de pesquisa na sua assinatura.

    ### List search services
    GET https://management.azure.com/subscriptions/{{subscriptionId}}/providers/Microsoft.Search/searchServices?api-version=2023-11-01
         Content-type: application/json
         Authorization: Bearer {{token}}
   

6. Selecione Enviar solicitação. Uma resposta deve aparecer em um painel adjacente. Se você tiver serviços de pesquisa existentes, eles serão listados. Caso contrário, a lista estará vazia, mas enquanto o código HTTP estiver 200 OK, você estará pronto para as próximas etapas.

   HTTP/1.1 200 OK
   Cache-Control: no-cache
   Pragma: no-cache
   Content-Length: 22068
   Content-Type: application/json; charset=utf-8
   Expires: -1
   x-ms-ratelimit-remaining-subscription-reads: 11999
   x-ms-request-id: f47d3562-a409-49d2-b9cd-6a108e07304c
   x-ms-correlation-request-id: f47d3562-a409-49d2-b9cd-6a108e07304c
   x-ms-routing-request-id: WESTUS2:20240314T012052Z:f47d3562-a409-49d2-b9cd-6a108e07304c
   Strict-Transport-Security: max-age=31536000; includeSubDomains
   X-Content-Type-Options: nosniff
   X-Cache: CONFIG_NOCACHE
   X-MSEdge-Ref: Ref A: 12401F1160FE4A3A8BB54D99D1FDEE4E Ref B: CO6AA3150217011 Ref C: 2024-03-14T01:20:52Z
   Date: Thu, 14 Mar 2024 01:20:52 GMT
   Connection: close
   
   {
     "value": [ . . . ]
   }
   

Criar ou atualizar um serviço

Crie ou atualize um serviço de pesquisa na assinatura atual. Este exemplo usa variáveis para o nome e a região do serviço de pesquisa, que ainda não foram definidos. Forneça os nomes diretamente ou adicione novas variáveis à coleção.

### Create a search service (provide an existing resource group)
@resource-group = my-rg
@search-service-name = my-search
PUT https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

    {
        "location": "North Central US",
        "sku": {
            "name": "basic"
        },
        "properties": {
            "replicaCount": 1,
            "partitionCount": 1,
            "hostingMode": "default"
        }
      }

Criar um serviço S3HD

Para criar um serviço S3HD, use uma combinação de propriedades sku e hostingMode. Defina sku como standard3 e "hostingMode" como HighDensity.

@resource-group = my-rg
@search-service-name = my-search
PUT https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

    {
        "location": "{{region}}",
        "sku": {
          "name": "standard3"
        },
        "properties": {
          "replicaCount": 1,
          "partitionCount": 1,
          "hostingMode": "HighDensity"
        }
    }

Configurar o acesso baseado em função para o plano de dados

Aplica-se a: Colaborador de Dados de Índice de Pesquisa, Leitor de Dados de Índice de Pesquisa, Colaborador do Serviço de Pesquisa

Nesta etapa, configure seu serviço de pesquisa para reconhecer um header de autorização em solicitações de dados que fornecem um token de acesso OAuth2.

Para usar o controle de acesso baseado em função para operações de plano de dados, defina authOptionscomoaadOrApiKey e envie a solicitação.

Para usar exclusivamente o controle de acesso baseado em função, desative a autenticação de chave de API seguindo com uma segunda solicitação, dessa vez configurando disableLocalAuth como verdadeiro.

PATCH https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

    {
        "properties": {
            "disableLocalAuth": false,
            "authOptions": {
                "aadOrApiKey": {
                    "aadAuthFailureMode": "http401WithBearerChallenge"
                }
            }
        }
    }

Aplicar uma política de chave gerenciada pelo cliente

Se você estiver usando a criptografia gerenciada pelo cliente, será possível habilitar "encryptionWithCMK" com "imposição" definido como "Habilitado" para que o serviço de pesquisa relate o próprio status de conformidade.

Quando você habilita essa política, as chamadas REST que criam objetos com dados confidenciais, como a cadeia de conexão em uma fonte de dados, falham caso uma chave de criptografia não seja fornecida: "Error creating Data Source: "CannotCreateNonEncryptedResource: The creation of non-encrypted DataSources is not allowed when encryption policy is enforced."

PATCH https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}
     
     {
        "properties": {
            "encryptionWithCmk": {
            "enforcement": "Disabled",
            "encryptionComplianceStatus": "Compliant"
            },
        }
    }

Desabilitar a classificação semântica

Embora a classificação semântica não esteja habilitada por padrão, é possível bloquear o recurso no nível do serviço.

### disable semantic ranking
PATCH https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}
     
     {
        "properties": {
            "semanticSearch": "Disabled"
        }
    }

Desabilitar cargas de trabalho que enviam dados para recursos externos

A Pesquisa de IA do Azure grava em fontes de dados externas ao atualizar um repositório de conhecimento, salvando o estado da sessão de depuração ou armazenando os enriquecimentos em cache. O exemplo a seguir desabilita essas cargas de trabalho no nível do serviço.

### disable-external-access
PATCH https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}
     
     {
        "properties": {
            "publicNetworkAccess": "Disabled"
        }
    }

Excluir um serviço de pesquisa

### delete a search service
DELETE https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

Listar chaves de API de administrador

### List admin keys
POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}/listAdminKeys?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

Regenerar chaves de API de administrador

Você só pode regenerar uma chave de API de administrador por vez.

### Regnerate admin keys
POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}/regenerateAdminKey/primary?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer 

Criar chaves de API de consulta

### Create a query key
@query-key-name = myQueryKey
POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}/createQueryKey/{name}?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

Listar conexões de ponto de extremidade privado

### List private endpoint connections
GET https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups/{{resource-group}}/providers/Microsoft.Search/searchServices/{{search-service-name}}/privateEndpointConnections?api-version=2023-11-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}

Listar operações de pesquisa

### List search operations
GET https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegroups?api-version=2021-04-01 HTTP/1.1
  Content-type: application/json
  Authorization: Bearer {{token}}

Próximas etapas

Após a configuração de um serviço de pesquisa, os próximos passos incluem criar um índice ou consultar um índice utilizando o portal, APIs REST, *ou um SDK do Azure.

• Criar um índice da Pesquisa de IA do Azure no portal do Azure
• Configurar um indexador para carregar dados de outros serviços
• Consultar um índice da Pesquisa de IA do Azure usando o Gerenciador de pesquisa no portal do Azure
• Como usar a Pesquisa de IA do Azure no .NET