az horizondb

Note

Эта ссылка является частью расширения horizondb для Azure CLI (версия 2.17.1 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az horizondb . Подробнее о расширениях.

Управление Azure HorizonDB.

Команды

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

Создайте новый кластер Azure HorizonDB.

 Extension Общедоступная версия
az horizondb delete

Удалите кластер Azure HorizonDB.

 Extension Общедоступная версия
az horizondb list

Список кластеров HorizonDB Azure.

 Extension Общедоступная версия
az horizondb show

Отображение сведений о кластере Azure HorizonDB.

 Extension Общедоступная версия
az horizondb update

Обновите существующий кластер Azure HorizonDB.

 Extension Общедоступная версия

az horizondb create

Создайте новый кластер Azure HorizonDB.

az horizondb create --administrator-login
                    --administrator-login-password
                    [--acquire-policy-token]
                    [--change-reference]
                    [--location]
                    [--name]
                    [--replica-count]
                    [--resource-group]
                    [--tags]
                    [--v-cores]
                    [--version]
                    [--zone-placement-policy {BestEffort, Strict}]

Примеры

Создайте новый кластер HorizonDB.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3

Создайте кластер HorizonDB с политикой размещения зоны.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3 --zone-placement-policy Strict

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

--administrator-login -u

Имя входа администратора для кластера.

--administrator-login-password -p

Пароль для входа администратора.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--location -l

Location. Значения от az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--name -n

Имя кластера. Имя может содержать только строчные буквы, цифры и символ дефиса (-). Минимум 3 символа и не более 63 символов.

--replica-count -r

Количество реплик. Должно быть от 1 до 16 включительно.

--resource-group -g

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

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--v-cores

Количество v-ядер.

--version -v

Версия кластера HorizonDb.

--zone-placement-policy -z

Определяет, как реплики размещаются в разных зонах доступности.

Свойство Значение
Допустимые значения: BestEffort, Strict
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az horizondb delete

Удалите кластер Azure HorizonDB.

az horizondb delete [--acquire-policy-token]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Примеры

Удалите кластер Azure HorizonDB.

az horizondb delete --name examplecluster --resource-group exampleresourcegroup

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--ids

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

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Имя кластера. Имя может содержать только строчные буквы, цифры и символ дефиса (-). Минимум 3 символа и не более 63 символов.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
--yes -y

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

Свойство Значение
Значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az horizondb list

Список кластеров HorizonDB Azure.

az horizondb list [--resource-group]

Примеры

Список всех кластеров HorizonDB Azure в текущей подписке.

az horizondb list

Вывод списка кластеров HorizonDB Azure в группе ресурсов.

az horizondb list --resource-group exampleresourcegroup

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--resource-group -g

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

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

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az horizondb show

Отображение сведений о кластере Azure HorizonDB.

az horizondb show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Примеры

Отображение сведений о кластере Azure HorizonDB.

az horizondb show --name examplecluster --resource-group exampleresourcegroup

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--ids

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

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Имя кластера. Имя может содержать только строчные буквы, цифры и символ дефиса (-). Минимум 3 символа и не более 63 символов.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az horizondb update

Обновите существующий кластер Azure HorizonDB.

az horizondb update [--acquire-policy-token]
                    [--administrator-login-password]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--no-wait]
                    [--parameter-group]
                    [--resource-group]
                    [--subscription]
                    [--tags]
                    [--v-cores]

Примеры

Обновите существующий кластер HorizonDB, чтобы иметь 6 виртуальных ядер.

az horizondb update --name examplecluster --resource-group exampleresourcegroup --v-cores 6

Назначьте группу параметров существующему кластеру HorizonDB.

az horizondb update --name examplecluster --resource-group exampleresourcegroup --parameter-group /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/parameterGroups/{parameterGroup}

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--administrator-login-password -p

Пароль для входа администратора.

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--ids

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

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Имя кластера. Имя может содержать только строчные буквы, цифры и символ дефиса (-). Минимум 3 символа и не более 63 символов.

Свойство Значение
Группа параметров: Resource Id Arguments
--no-wait

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

Свойство Значение
Значение по умолчанию: False
--parameter-group

Идентификатор ресурса группы параметров.

--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--v-cores

Количество v-ядер.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Свойство Значение
Значение по умолчанию: False