Gerencie o serviço de Azure Search com o PowerShellManage your Azure Search service with PowerShell

Você pode executar scripts e cmdlets do PowerShell no Windows, Linux, ou em Azure Cloud Shell para criar e configurar o Azure Search.You can run PowerShell cmdlets and scripts on Windows, Linux, or in Azure Cloud Shell to create and configure Azure Search. O Az.Search estende o módulo Azure PowerShell] com paridade completa para o APIs de REST de gerenciamento do Azure Search.The Az.Search module extends Azure PowerShell] with full parity to the Azure Search Management REST APIs. Com o Azure PowerShell e Az.Search, você pode executar as seguintes tarefas:With Azure PowerShell and Az.Search, you can perform the following tasks:

PowerShell não pode ser usado para alterar o nome, região ou camada do seu serviço.PowerShell cannot be used to change the name, region, or tier of your service. Recursos dedicados são alocados quando um serviço é criado.Dedicated resources are allocated when a service is created. Alteração do hardware subjacente (local ou tipo de nó) requer um novo serviço.Changing the underlying hardware (location or node type) requires a new service. Não há nenhuma APIs ou ferramentas para transferir o conteúdo de um serviço para outro.There are no tools or APIs for transferring content from one service to another. Todo o gerenciamento de conteúdo é por meio restante ou .NET APIs, e se você quiser mover índices, você precisará recriar e recarregá-los em um novo serviço.All content management is through REST or .NET APIs, and if you want to move indexes, you will need to recreate and reload them on a new service.

Embora não haja nenhum dedicados comandos do PowerShell para gerenciamento de conteúdo, você pode escrever um script do PowerShell que chama a REST ou .NET para criar e carregar índices.While there are no dedicated PowerShell commands for content management, you can write PowerShell script that calls REST or .NET to create and load indexes. O Az.Search módulo por si só não fornece essas operações.The Az.Search module by itself does not provide these operations.

Outras tarefas que não tem suportadas por meio do PowerShell ou qualquer outra API (somente portal) incluem:Other tasks not supported through PowerShell or any other API (portal-only) include:

Verificar as versões e carregar módulosCheck versions and load modules

Os exemplos neste artigo são interativos e exigem permissões elevadas.The examples in this article are interactive and require elevated permissions. O Azure PowerShell (o Az módulo) deve ser instalado.Azure PowerShell (the Az module) must be installed. Para obter mais informações, consulte Instalar o Azure PowerShell.For more information, see Install Azure PowerShell.

Verificação de versão do PowerShell (5.1 ou posterior)PowerShell version check (5.1 or later)

PowerShell local deve ser 5.1 ou posterior, em qualquer sistema operacional com suporte.Local PowerShell must be 5.1 or later, on any supported operating system.

$PSVersionTable.PSVersion

Carregar o Azure PowerShellLoad Azure PowerShell

Se você não tiver certeza se Az estiver instalado, execute o comando a seguir como uma etapa de verificação.If you aren't sure whether Az is installed, run the following command as a verification step.

Get-InstalledModule -Name Az

Alguns sistemas fazer não carregar automaticamente módulos.Some systems do not auto-load modules. Se você receber um erro comando anterior, tente carregar o módulo e se isso falhar, vá até as instruções de instalação para ver se você perdeu uma etapa.If you get an error on the previous command, try loading the module, and if that fails, go back to the installation instructions to see if you missed a step.

Import-Module -Name Az

Conectar-se ao Azure com um token de entrada do navegadorConnect to Azure with a browser sign-in token

Você pode usar suas credenciais de logon no portal para se conectar a uma assinatura no PowerShell.You can use your portal sign-in credentials to connect to a subscription in PowerShell. Como alternativa, você pode autenticar de forma não interativa com uma entidade de serviço.Alternatively you can authenticate non-interactively with a service principal.

Connect-AzAccount

Se você tiver várias assinaturas do Azure, defina sua assinatura do Azure.If you hold multiple Azure subscriptions, set your Azure subscription. Para ver uma lista de suas assinaturas atuais, execute este comando.To see a list of your current subscriptions, run this command.

Get-AzSubscription | sort SubscriptionName | Select SubscriptionName

Para especificar a assinatura, execute o comando a seguir.To specify the subscription, run the following command. No exemplo a seguir, o nome da assinatura é ContosoSubscription.In the following example, the subscription name is ContosoSubscription.

Select-AzSubscription -SubscriptionName ContosoSubscription

Listar todos os serviços do Azure Search em sua assinaturaList all Azure Search services in your subscription

Os comandos a seguir são de Az.Resources, retornando informações sobre os recursos existentes e os serviços já provisionados em sua assinatura.The following commands are from Az.Resources, returning information about existing resources and services already provisioned in your subscription. Se você não souber quantos serviços de pesquisa já foram criados, esses comandos retornam essa informação, economizando uma viagem para o portal.If you don't know how many search services are already created, these commands return that information, saving you a trip to the portal.

O primeiro comando retorna todos os serviços de pesquisa.The first command returns all search services.

Get-AzResource -ResourceType Microsoft.Search/searchServices | ft

Na lista de serviços, retorne informações sobre um recurso específico.From the list of services, return information about a specific resource.

Get-AzResource -ResourceName <service-name>

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output.

Name              : my-demo-searchapp
ResourceGroupName : demo-westus
ResourceType      : Microsoft.Search/searchServices
Location          : westus
ResourceId        : /subscriptions/<alpha-numeric-subscription-ID>/resourceGroups/demo-westus/providers/Microsoft.Search/searchServices/my-demo-searchapp

Importar Az.SearchImport Az.Search

Comandos do Az.Search não estão disponíveis até que você carrega o módulo.Commands from Az.Search are not available until you load the module.

Install-Module -Name Az.Search

Listar todos os comandos de Az.SearchList all Az.Search commands

Como uma etapa de verificação, retorne uma lista de comandos fornecidos no módulo.As a verification step, return a list of commands provided in the module.

Get-Command -Module Az.Search

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output.

CommandType     Name                                Version    Source
-----------     ----                                -------    ------
Cmdlet          Get-AzSearchAdminKeyPair            0.7.1      Az.Search
Cmdlet          Get-AzSearchQueryKey                0.7.1      Az.Search
Cmdlet          Get-AzSearchService                 0.7.1      Az.Search
Cmdlet          New-AzSearchAdminKey                0.7.1      Az.Search
Cmdlet          New-AzSearchQueryKey                0.7.1      Az.Search
Cmdlet          New-AzSearchService                 0.7.1      Az.Search
Cmdlet          Remove-AzSearchQueryKey             0.7.1      Az.Search
Cmdlet          Remove-AzSearchService              0.7.1      Az.Search
Cmdlet          Set-AzSearchService                 0.7.1      Az.Search

Obter informações do serviço de pesquisaGet search service information

Após Az.Search é importado e você sabe que o grupo de recursos que contém o serviço de pesquisa, execute Get-AzSearchService para retornar a definição de serviço, incluindo nome, a região, a camada e a réplica e Contagem de partições.After Az.Search is imported and you know the resource group containing your search service, run Get-AzSearchService to return the service definition, including name, region, tier, and replica and partition counts.

Get-AzSearchService -ResourceGroupName <resource-group-name>

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output.

Name              : my-demo-searchapp
ResourceGroupName : demo-westus
ResourceType      : Microsoft.Search/searchServices
Location          : West US
Sku               : Standard
ReplicaCount      : 1
PartitionCount    : 1
HostingMode       : Default
ResourceId        : /subscriptions/<alphanumeric-subscription-ID>/resourceGroups/demo-westus/providers/Microsoft.Search/searchServices/my-demo-searchapp

Criar ou excluir um serviçoCreate or delete a service

Novo AzSearchService é usado para criar um novo serviço de pesquisa.New-AzSearchService is used to create a new search service.

New-AzSearchService -ResourceGroupName "demo-westus" -Name "my-demo-searchapp" -Sku "Standard" -Location "West US" -PartitionCount 3 -ReplicaCount 3

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output.

ResourceGroupName : demo-westus
Name              : my-demo-searchapp
Id                : /subscriptions/<alphanumeric-subscription-ID>/demo-westus/providers/Microsoft.Search/searchServices/my-demo-searchapp
Location          : West US
Sku               : Standard
ReplicaCount      : 3
PartitionCount    : 3
HostingMode       : Default
Tags

Regenerar chaves de administradorRegenerate admin keys

Novo AzSearchAdminKey é usada para sobrepor admin chaves de API.New-AzSearchAdminKey is used to roll over admin API keys. Duas chaves admin são criadas com cada serviço para acesso autenticado.Two admin keys are created with each service for authenticated access. As chaves são necessárias em cada solicitação.Keys are required on every request. As duas chaves admin são funcionalmente equivalentes, a concessão de acesso de gravação completo para um serviço de pesquisa com a capacidade de recuperar todas as informações, ou criar e excluir qualquer objeto.Both admin keys are functionally equivalent, granting full write access to a search service with the ability to retrieve any information, or create and delete any object. Duas chaves existirem para que você pode usar um, substituindo a outra.Two keys exist so that you can use one while replacing the other.

Você só pode regenerar uma de cada vez, especificado como o primary ou secondary chave.You can only regenerate one at a time, specified as either the primary or secondary key. Para um serviço ininterrupto, lembre-se de atualizar todo o código de cliente para usar uma chave secundária enquanto sobrepor a chave primária.For uninterrupted service, remember to update all client code to use a secondary key while rolling over the primary key. Evite alterar as chaves enquanto operações estão em trânsito.Avoid changing the keys while operations are in flight.

Como você pode esperar, se você regenerar chaves sem atualizar o código do cliente, as solicitações usando a chave antiga falhará.As you might expect, if you regenerate keys without updating client code, requests using the old key will fail. Regenerar todas as novas chaves não prender você permanentemente fora de seu serviço, e você ainda pode acessar o serviço por meio do portal.Regenerating all new keys does not permanently lock you out of your service, and you can still access the service through the portal. Depois de regenerar chaves primárias e secundárias, você pode atualizar o código do cliente para usar as novas chaves e operações serão retomadas de acordo.After you regenerate primary and secondary keys, you can update client code to use the new keys and operations will resume accordingly.

Valores para as chaves de API são gerados pelo serviço.Values for the API keys are generated by the service. Você não pode fornecer uma chave personalizada para o Azure Search usar.You cannot provide a custom key for Azure Search to use. Da mesma forma, não há nenhum nome definido pelo usuário para as chaves de API do administrador.Similarly, there is no user-defined name for admin API-keys. Referências à chave corrigidas ou cadeias de caracteres primary ou secondary.References to the key are fixed strings, either primary or secondary.

New-AzSearchAdminKey -ResourceGroupName <resource-group-name> -ServiceName <search-service-name> -KeyKind Primary

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output. As duas chaves são retornadas, mesmo que você altere apenas um de cada vez.Both keys are returned even though you only change one at a time.

Primary                    Secondary
-------                    ---------
<alphanumeric-guid>        <alphanumeric-guid>  

Criar ou excluir as chaves de consultaCreate or delete query keys

Novo AzSearchQueryKey é usado para criar consulta chaves de API para acesso somente leitura dos aplicativos clientes para um índice de Azure Search.New-AzSearchQueryKey is used to create query API keys for read-only access from client apps to an Azure Search index. As chaves de consulta são usadas para autenticar em um índice específico a fim de recuperar os resultados da pesquisa.Query keys are used to authenticate to a specific index for the purpose of retrieving search results. As chaves de consulta não concedem acesso somente leitura a outros itens no serviço, como um índice, a fonte de dados ou o indexador.Query keys do not grant read-only access to other items on the service, such as an index, data source, or indexer.

Você não pode fornecer uma chave para o Azure Search usar.You cannot provide a key for Azure Search to use. Chaves de API são geradas pelo serviço.API keys are generated by the service.

New-AzSearchQueryKey -ResourceGroupName <resource-group-name> -ServiceName <search-service-name> -Name <query-key-name> 

Partições e réplicas de escalaScale replicas and partitions

Conjunto AzSearchService é usado para aumentar ou diminuir as réplicas e partições reajustar faturáveis recursos dentro de seu serviço.Set-AzSearchService is used to increase or decrease replicas and partitions to readjust billable resources within your service. Aumentar as réplicas ou partições adiciona à sua fatura, que tem ambos encargos fixos e variáveis.Increasing replicas or partitions adds to your bill, which has both fixed and variable charges. Se você tiver uma necessidade temporária para poder de processamento adicional, você pode aumentar as réplicas e partições para lidar com a carga de trabalho.If you have a temporary need for additional processing power, you can increase replicas and partitions to handle the workload. Na área de monitoramento na página Visão geral do portal tem blocos na latência da consulta, consultas por segundo e a limitação, que indica se a capacidade atual é adequada.The monitoring area in the Overview portal page has tiles on query latency, queries per second, and throttling, indicating whether current capacity is adequate.

Pode levar um tempo para adicionar ou remover a alocação de recursos.It can take a while to add or remove resourcing. Ajustes à capacidade ocorrem em segundo plano, permitindo que cargas de trabalho existentes continuar.Adjustments to capacity occur in the background, allowing existing workloads to continue. Capacidade adicional é usada para solicitações de entrada, assim que estiver pronto, sem nenhuma configuração adicional necessária.Additional capacity is used for incoming requests as soon as it's ready, with no additional configuration required.

Removendo a capacidade pode ser prejudicial.Removing capacity can be disruptive. Parar todos os trabalhos de indexação e indexador antes de reduzir a capacidade é recomendável para evitar solicitações ignoradas.Stopping all indexing and indexer jobs prior to reducing capacity is recommended to avoid dropped requests. Se isso não for viável, você pode considerar reduzindo a capacidade de forma incremental, uma réplica e partição por vez, até que os novos níveis de destino são atingidos.If that isn't feasible, you might consider reducing capacity incrementally, one replica and partition at a time, until your new target levels are reached.

Depois de enviar o comando, não há terminasse metade.Once you submit the command, there is no way to terminate it midway through. Você precisará aguardar até que o comando seja concluído antes de revisar as contagens.You will have to wait until the command is finished before revising the counts.

Set-AzSearchService -ResourceGroupName <resource-group-name> -Name <search-service-name> -PartitionCount 6 -ReplicaCount 6

Resultados devem ser semelhantes à seguinte saída.Results should look similar to the following output.

ResourceGroupName : demo-westus
Name              : my-demo-searchapp
Location          : West US
Sku               : Standard
ReplicaCount      : 6
PartitionCount    : 6
HostingMode       : Default
Id                : /subscriptions/65a1016d-0f67-45d2-b838-b8f373d6d52e/resourceGroups/demo-westus/providers/Microsoft.Search/searchServices/my-demo-searchapp

Próximas etapasNext steps

Criar uma índice, consultar um índice usando o portal, APIs REST ou o SDK do .NET.Build an index, query an index using the portal, REST APIs, or the .NET SDK.