Compartilhar via

az search service

  • Referência

Gerenciar serviços do Azure Search.

Comandos

Nome Description Tipo Status
az search service create

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

 Núcleo GA
az search service delete

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

 Núcleo GA
az search service list

Obtém uma lista de todos os serviços de pesquisa no grupo de recursos especificado.

 Núcleo GA
az search service show

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

 Núcleo GA
az search service update

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

 Núcleo GA
az search service wait

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

 Núcleo GA

az search service create

Editar

Crie um serviço de pesquisa no grupo de recursos especificado. 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 Exigidos

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

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

--resource-group -g

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

--sku

A SKU do serviço de pesquisa. Os valores válidos incluem: 'gratuito': serviço compartilhado. 'basic': 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': dá suporte a 1 TB por partição, até 12 partições. 'storage_optimized_l2': dá suporte a 2 TB por partição, até 12 partições.'.

Valores aceitos: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Parâmetros Opcionais

--aad-auth-failure-mode

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

Valores aceitos: http401WithBearerChallenge, http403
--auth-options

Ajuda.

Valores aceitos: 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 poderá ser definido como true se 'dataPlaneAuthOptions' estiver definido.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Aplicável somente para o SKU standard3. 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 é "padrão" ou "highDensity". Para todos os outros SKUs, esse valor deve ser "padrão".

Valores aceitos: default, highDensity
Valor padrão: default
--identity-type

O tipo de identidade.

Valores aceitos: None, SystemAssigned
--ip-rules

Ajuda.

--location -l

A localização geográfica em que o recurso reside Quando não for especificado, o local do grupo de recursos será usado.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valores aceitos: 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ão válidos apenas para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.

Valor padrão: 1
--public-access --public-network-access

Esse valor pode ser definido como "habilitado" para evitar alterações significativas em modelos e recursos de clientes existentes. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.

Valores aceitos: disabled, enabled
Valor padrão: enabled
--replica-count

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

Valor padrão: 1
--semantic-search

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

Valores aceitos: disabled, free, standard
--tags

Marcas de recurso. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az search service delete

Editar

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

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az search service list

Editar

Obtém uma lista de todos os serviços de pesquisa no grupo de recursos especificado.

az search service list --resource-group

Parâmetros Exigidos

--resource-group -g

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 fornecido.

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az search service update

Editar

Atualize um serviço de pesquisa no grupo de recursos especificado. 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 qual resposta a API do plano de dados de um serviço de Pesquisa enviaria para solicitações que falharam na autenticação.

Valores aceitos: 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 or JSON string>.

--auth-options

Ajuda.

Valores aceitos: 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 poderá ser definido como true se 'dataPlaneAuthOptions' estiver definido.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--force-string

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

O tipo de identidade.

Valores aceitos: None, SystemAssigned
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--ip-rules

Ajuda.

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

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valores aceitos: 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ão válidos apenas 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 em modelos e recursos de clientes existentes. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.

Valores aceitos: disabled, enabled
--remove

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

--replica-count

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

--resource-group -g

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 determinados SKUs do Azure Cognitive Search em determinados locais.

Valores aceitos: disabled, free, standard
--set

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Marcas de recurso. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 padrão: False
--custom

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

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name --search-service-name -n

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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