Поделиться через

az search service

  • Ссылка

Управление службами поиска Azure.

Команды

Имя Описание Тип Состояние
az search service create

Создайте службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.

 Ядро ГА
az search service delete

Удалите службу поиска в данной группе ресурсов, а также связанные с ней ресурсы.

 Ядро ГА
az search service list

Возвращает список всех служб поиска в заданной группе ресурсов.

 Ядро ГА
az search service show

Получите службу поиска с заданным именем в данной группе ресурсов.

 Ядро ГА
az search service update

Обновите службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.

 Ядро ГА
az search service wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие.

 Ядро ГА

az search service create

Изменить

Создайте службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.

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]

Обязательные параметры

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

Имя службы Когнитивного поиска Azure для создания или обновления. Имена служб поиска должны содержать только строчные буквы, цифры или дефисы, не могут использовать тире в качестве первых двух или последних символов, не могут содержать последовательные дефисы и должны содержать от 2 до 60 символов в длину. Имена служб поиска должны быть глобально уникальными, так как они являются частью URI службы (https://<name>.search.windows.net). Невозможно изменить имя службы после создания службы.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--sku

Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. "storage_optimized_l2": поддерживает 2TB на секцию до 12 секций."

Допустимые значения: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Необязательные параметры

--aad-auth-failure-mode

Описывает, какой ответ будет отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.

Допустимые значения: http401WithBearerChallenge, http403
--auth-options

Некоторые справки.

Допустимые значения: aadOrApiKey, apiKeyOnly
--disable-local-auth

Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.

Допустимые значения: default, highDensity
Default value: default
--identity-type

Тип удостоверения.

Допустимые значения: None, SystemAssigned
--ip-rules

Некоторые справки.

--location -l

Географическое расположение, в котором находится ресурс, если он не указан, будет использоваться расположение группы ресурсов.

--no-wait

Не дождитесь завершения длительной операции.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.

Default value: 1
--public-access --public-network-access

Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.

Допустимые значения: disabled, enabled
Default value: enabled
--replica-count

Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.

Default value: 1
--semantic-search

Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU Когнитивного поиска Azure в определенных расположениях.

Допустимые значения: disabled, free, standard
--tags

Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az search service delete

Изменить

Удалите службу поиска в данной группе ресурсов, а также связанные с ней ресурсы.

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

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

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

Имя службы Когнитивного поиска Azure, связанной с указанной группой ресурсов.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--yes -y

Не запрашивайте подтверждение.

Default value: False
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az search service list

Изменить

Возвращает список всех служб поиска в заданной группе ресурсов.

az search service list --resource-group

Обязательные параметры

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az search service show

Изменить

Получите службу поиска с заданным именем в данной группе ресурсов.

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

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

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

Имя службы Когнитивного поиска Azure, связанной с указанной группой ресурсов.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az search service update

Изменить

Обновите службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.

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]

Необязательные параметры

--aad-auth-failure-mode

Описывает, какой ответ будет отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.

Допустимые значения: http401WithBearerChallenge, http403
--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

--auth-options

Некоторые справки.

Допустимые значения: aadOrApiKey, apiKeyOnly
--disable-local-auth

Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Тип удостоверения.

Допустимые значения: None, SystemAssigned
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--ip-rules

Некоторые справки.

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

Имя службы Когнитивного поиска Azure, связанной с указанной группой ресурсов.

--no-wait

Не дождитесь завершения длительной операции.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.

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

Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.

Допустимые значения: disabled, enabled
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> ИЛИ --remove propertyToRemove.

--replica-count

Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--semantic-search

Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU Когнитивного поиска Azure в определенных расположениях.

Допустимые значения: disabled, free, standard
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--tags

Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az search service wait

Изменить

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие.

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

Необязательные параметры

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--interval

Интервал опроса в секундах.

Default value: 30
--name --search-service-name -n

Имя службы Когнитивного поиска Azure, связанной с указанной группой ресурсов.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.