Compartir a través de

az search service

  • Referencia

Administración de servicios de Azure Search.

Comandos

Nombre Description Tipo Estado
az search service create

Cree un servicio de búsqueda en el grupo de recursos especificado. Si el servicio de búsqueda ya existe, todas las propiedades se actualizarán con los valores especificados.

 Núcleo GA
az search service delete

Elimine un servicio de búsqueda en el grupo de recursos determinado, junto con sus recursos asociados.

 Núcleo GA
az search service list

Obtiene una lista de todos los servicios de búsqueda del grupo de recursos especificado.

 Núcleo GA
az search service show

Obtenga el servicio de búsqueda con el nombre especificado en el grupo de recursos especificado.

 Núcleo GA
az search service update

Actualice un servicio de búsqueda en el grupo de recursos especificado. Si el servicio de búsqueda ya existe, todas las propiedades se actualizarán con los valores especificados.

 Núcleo GA
az search service wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

 Núcleo GA

az search service create

Editar

Cree un servicio de búsqueda en el grupo de recursos especificado. Si el servicio de búsqueda ya existe, todas las propiedades se actualizarán con los valores especificados.

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 requeridos

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

Nombre del servicio Azure Cognitive Search para crear o actualizar. Los nombres del servicio de búsqueda solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud. Los nombres de servicio de búsqueda deben ser únicos globalmente, ya que forman parte del URI del servicio (https://<name>.search.windows.net). No se puede cambiar el nombre del servicio después de crear el servicio.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--sku

SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. "storage_optimized_l2": admite 2 TB por partición, hasta 12 particiones".

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

Parámetros opcionales

--aad-auth-failure-mode

Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación.

Valores aceptados: http401WithBearerChallenge, http403
--auth-options

Ayuda.

Valores aceptados: aadOrApiKey, apiKeyOnly
--disable-local-auth

Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions".

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

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".

Valores aceptados: default, highDensity
Valor predeterminado: default
--identity-type

Tipo de identidad.

Valores aceptados: None, SystemAssigned
--ip-rules

Algo de ayuda.

--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Número de particiones en el servicio de búsqueda; si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3.

Valor predeterminado: 1
--public-access --public-network-access

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.

Valores aceptados: disabled, enabled
Valor predeterminado: enabled
--replica-count

Número de réplicas en el servicio de búsqueda. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica.

Valor predeterminado: 1
--semantic-search

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure Cognitive Search en determinadas ubicaciones.

Valores aceptados: disabled, free, standard
--tags

Etiquetas de recursos. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.

az search service delete

Editar

Elimine un servicio de búsqueda en el grupo de recursos determinado, junto con sus recursos asociados.

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

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

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

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicite confirmación.

Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.

az search service list

Editar

Obtiene una lista de todos los servicios de búsqueda del grupo de recursos especificado.

az search service list --resource-group

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.

az search service show

Editar

Obtenga el servicio de búsqueda con el nombre especificado en el grupo de recursos especificado.

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

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

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

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.

az search service update

Editar

Actualice un servicio de búsqueda en el grupo de recursos especificado. Si el servicio de búsqueda ya existe, todas las propiedades se actualizarán con los valores especificados.

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 opcionales

--aad-auth-failure-mode

Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación.

Valores aceptados: http401WithBearerChallenge, http403
--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

--auth-options

Ayuda.

Valores aceptados: aadOrApiKey, apiKeyOnly
--disable-local-auth

Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions".

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

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

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

Tipo de identidad.

Valores aceptados: None, SystemAssigned
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--ip-rules

Algo de ayuda.

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

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Número de particiones en el servicio de búsqueda; si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3.

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

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.

Valores aceptados: disabled, enabled
--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

--replica-count

Número de réplicas en el servicio de búsqueda. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--semantic-search

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure Cognitive Search en determinadas ubicaciones.

Valores aceptados: disabled, free, standard
--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas de recursos. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.

az search service wait

Editar

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

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

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30
--name --search-service-name -n

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Use --debug para registros de depuración completos.