az search service

  • Referência

Gerencie os serviços do Azure Search.

Comandos

Name Description Tipo Estado
az search service create

Crie um serviço de pesquisa no grupo de recursos determinado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

 Principal GA
az search service delete

Exclua um serviço de pesquisa no grupo de recursos determinado, juntamente com seus recursos associados.

 Principal GA
az search service list

Obtém uma lista de todos os serviços de Pesquisa em determinado grupo de recursos.

 Principal GA
az search service show

Obtenha o serviço de pesquisa com o nome fornecido no grupo de recursos determinado.

 Principal GA
az search service update

Atualize um serviço de pesquisa no grupo de recursos fornecido. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

 Principal GA
az search service wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Principal GA

az search service create

Editar

Crie um serviço de pesquisa no grupo de recursos determinado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

az search service create --name
                         --resource-group
                         --sku {basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2}
                         [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--hosting-mode {default, highDensity}]
                         [--identity-type {None, SystemAssigned}]
                         [--ip-rules]
                         [--location]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access {disabled, enabled}]
                         [--replica-count]
                         [--semantic-search {disabled, free, standard}]
                         [--tags]

Parâmetros Obrigatórios

--name --search-service-name -n

O nome do serviço de Pesquisa Cognitiva do Azure a ser criado ou atualizado. Os nomes dos serviços de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres. Os nomes de serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net). Não é possível alterar o nome do serviço após a criação do serviço.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--sku

O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições.'.

valores aceites: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Parâmetros Opcionais

--aad-auth-failure-mode

Descreve a resposta que a API do plano de dados de um serviço de Pesquisa enviaria para solicitações que falharam na autenticação.

valores aceites: http401WithBearerChallenge, http403
--auth-options

Alguma ajuda.

valores aceites: aadOrApiKey, apiKeyOnly
--disable-local-auth

Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.

valores aceites: default, highDensity
valor predefinido: default
--identity-type

O tipo de identidade.

valores aceites: None, SystemAssigned
--ip-rules

Alguma ajuda.

--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.

valor predefinido: 1
--public-access --public-network-access

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.

valores aceites: disabled, enabled
valor predefinido: enabled
--replica-count

O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.

valor predefinido: 1
--semantic-search

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs da Pesquisa Cognitiva do Azure em determinados locais.

valores aceites: disabled, free, standard
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az search service delete

Editar

Exclua um serviço de pesquisa no grupo de recursos determinado, juntamente com seus recursos associados.

az search service delete [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]
                         [--yes]

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --search-service-name -n

O nome do serviço de Pesquisa Cognitiva do Azure associado ao grupo de recursos especificado.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az search service list

Editar

Obtém uma lista de todos os serviços de Pesquisa em determinado grupo de recursos.

az search service list --resource-group

Parâmetros Obrigatórios

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az search service show

Editar

Obtenha o serviço de pesquisa com o nome fornecido no grupo de recursos determinado.

az search service show [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --search-service-name -n

O nome do serviço de Pesquisa Cognitiva do Azure associado ao grupo de recursos especificado.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az search service update

Editar

Atualize um serviço de pesquisa no grupo de recursos fornecido. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

az search service update [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--add]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                         [--identity-type {None, SystemAssigned}]
                         [--ids]
                         [--ip-rules]
                         [--name]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access {disabled, enabled}]
                         [--remove]
                         [--replica-count]
                         [--resource-group]
                         [--semantic-search {disabled, free, standard}]
                         [--set]
                         [--subscription]
                         [--tags]

Parâmetros Opcionais

--aad-auth-failure-mode

Descreve a resposta que a API do plano de dados de um serviço de Pesquisa enviaria para solicitações que falharam na autenticação.

valores aceites: http401WithBearerChallenge, http403
--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

--auth-options

Alguma ajuda.

valores aceites: aadOrApiKey, apiKeyOnly
--disable-local-auth

Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

O tipo de identidade.

valores aceites: None, SystemAssigned
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--ip-rules

Alguma ajuda.

--name --search-service-name -n

O nome do serviço de Pesquisa Cognitiva do Azure associado ao grupo de recursos especificado.

--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.

--public-access --public-network-access

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.

valores aceites: disabled, enabled
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

--replica-count

O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--semantic-search

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs da Pesquisa Cognitiva do Azure em determinados locais.

valores aceites: disabled, free, standard
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az search service wait

Editar

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az search service wait [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--name --search-service-name -n

O nome do serviço de Pesquisa Cognitiva do Azure associado ao grupo de recursos especificado.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.