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

az deployment mg

  • Ссылка

Управление развертыванием шаблона Azure Resource Manager в группе управления.

Команды

Имя Описание Тип Состояние
az deployment mg cancel

Отмена развертывания в группе управления.

 Ядро ГА
az deployment mg create

Запустите развертывание в группе управления.

 Ядро ГА
az deployment mg delete

Удаление развертывания в группе управления.

 Ядро ГА
az deployment mg export

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

 Ядро ГА
az deployment mg list

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

 Ядро ГА
az deployment mg show

Отображение развертывания в группе управления.

 Ядро ГА
az deployment mg validate

Проверьте, является ли шаблон допустимым в группе управления.

 Ядро ГА
az deployment mg wait

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

 Ядро ГА
az deployment mg what-if

Выполните операцию развертывания What-If в области группы управления.

 Ядро ГА

az deployment mg cancel

Изменить

Отмена развертывания в группе управления.

az deployment mg cancel --management-group-id
                        --name

Примеры

Отмена развертывания в группе управления.

az deployment mg cancel -m testmg -n deployment01

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

--management-group-id -m

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

--name -n

Имя развертывания.

Глобальные параметры
--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 deployment mg create

Изменить

Запустите развертывание в группе управления.

Укажите только один из файлов --template-file | --template-URI URI | --template-spec для ввода шаблона ARM.

az deployment mg create --location
                        --management-group-id
                        [--confirm-with-what-if]
                        [--handle-extended-json-format]
                        [--mode {Complete, Incremental}]
                        [--name]
                        [--no-prompt {false, true}]
                        [--no-wait]
                        [--parameters]
                        [--proceed-if-no-change]
                        [--query-string]
                        [--template-file]
                        [--template-spec]
                        [--template-uri]
                        [--what-if]
                        [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                        [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

Примеры

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

az deployment mg create --management-group-id testrg --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

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

az deployment mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

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

--location -l

Расположение для хранения метаданных развертывания.

--management-group-id -m

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

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

--confirm-with-what-if -c

Перед выполнением развертывания выполните команду What-If развертывания. Затем он предложит подтвердить изменения ресурсов перед продолжением.

--handle-extended-json-format -j
Не рекомендуется

Параметр --handle-extended-json-format/-j не рекомендуется и будет удален в будущем выпуске.

Поддержка обработки расширенного содержимого шаблона, включая многостроочное и примечания в развертывании.

--mode

Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.

Допустимые значения: Complete, Incremental
Default value: Incremental
--name -n

Имя развертывания.

--no-prompt

Параметр отключения запроса отсутствующих параметров для шаблона ARM. Если значение равно true, запрос, требующий от пользователей предоставления отсутствующих параметров, будет игнорироваться. Значение по умолчанию — false.

Допустимые значения: false, true
Default value: False
--no-wait

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

Default value: False
--parameters -p

Укажите значения параметров развертывания.

Параметры могут быть предоставлены из файла с помощью синтаксиса @{path}, строки JSON или пар <KEY=VALUE>. Параметры вычисляются в порядке, поэтому при назначении значения дважды используется последнее значение. Рекомендуется сначала указать файл параметров, а затем переопределить выборочно с помощью синтаксиса KEY=VALUE.

--proceed-if-no-change

Укажите команде выполнить развертывание, если результат What-If не содержит изменений ресурсов. Применимо, если задано значение --confirm-with-what-if.

--query-string -q

Строка запроса (маркер SAS), используемая с универсальным кодом шаблона в случае связанных шаблонов.

--template-file -f

Путь к файлу шаблона или Bicep-файлу.

--template-spec -s

Идентификатор ресурса спецификации шаблона.

--template-uri -u

Универсальный код ресурса (URI) в файл шаблона.

--what-if -w

Укажите команду для запуска развертывания What-If.

--what-if-exclude-change-types -x

Разделенный пробелами список типов изменений ресурсов, которые следует исключить из What-If результатов. Применимо, если задано значение --confirm-with-what-if.

Допустимые значения: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--what-if-result-format -r

Формат результатов What-If. Применимо при установке --confirm-with-what-if.

Допустимые значения: FullResourcePayloads, ResourceIdOnly
Default value: FullResourcePayloads
Глобальные параметры
--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 deployment mg delete

Изменить

Удаление развертывания в группе управления.

az deployment mg delete --management-group-id
                        --name
                        [--no-wait]

Примеры

Удаление развертывания в группе управления.

az deployment mg delete -m testmg -n deployment01

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

--management-group-id -m

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

--name -n

Имя развертывания.

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

--no-wait

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

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 deployment mg export

Изменить

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

az deployment mg export --management-group-id
                        --name

Примеры

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

az deployment mg export --management-group-id testmg --name MyDeployment

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

--management-group-id -m

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

--name -n

Имя развертывания.

Глобальные параметры
--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 deployment mg list

Изменить

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

az deployment mg list --management-group-id
                      [--filter]

Примеры

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

az deployment mg list -m testmg

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

--management-group-id -m

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

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

--filter
Предварительный просмотр

Выражение фильтра с помощью нотации OData. Вы можете использовать --filter "provisioningState eq "{state}" для фильтрации подготовкиState. Чтобы получить дополнительные сведения, посетите https://learn.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.

Глобальные параметры
--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 deployment mg show

Изменить

Отображение развертывания в группе управления.

az deployment mg show --management-group-id
                      --name

Примеры

Отображение развертывания в группе управления.

az deployment mg show -m testmg -n deployment01

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

--management-group-id -m

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

--name -n

Имя развертывания.

Глобальные параметры
--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 deployment mg validate

Изменить

Проверьте, является ли шаблон допустимым в группе управления.

Укажите только один из файлов --template-file | --template-URI URI | --template-spec для ввода шаблона ARM.

az deployment mg validate --location
                          --management-group-id
                          [--handle-extended-json-format]
                          [--name]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--query-string]
                          [--template-file]
                          [--template-spec]
                          [--template-uri]

Примеры

Проверьте, является ли шаблон допустимым в группе управления.

az deployment mg validate --management-group-id testmg --location WestUS --template-file {template-file}

Проверьте, является ли шаблон допустимым в группе управления. (автоматическое создание)

az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

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

--location -l

Расположение для хранения метаданных развертывания.

--management-group-id -m

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

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

--handle-extended-json-format -j
Не рекомендуется

Параметр --handle-extended-json-format/-j не рекомендуется и будет удален в будущем выпуске.

Поддержка обработки расширенного содержимого шаблона, включая многостроочное и примечания в развертывании.

--name -n

Имя развертывания.

--no-prompt

Параметр отключения запроса отсутствующих параметров для шаблона ARM. Если значение равно true, запрос, требующий от пользователей предоставления отсутствующих параметров, будет игнорироваться. Значение по умолчанию — false.

Допустимые значения: false, true
Default value: False
--parameters -p

Укажите значения параметров развертывания.

Параметры могут быть предоставлены из файла с помощью синтаксиса @{path}, строки JSON или пар <KEY=VALUE>. Параметры вычисляются в порядке, поэтому при назначении значения дважды используется последнее значение. Рекомендуется сначала указать файл параметров, а затем переопределить выборочно с помощью синтаксиса KEY=VALUE.

--query-string -q

Строка запроса (маркер SAS), используемая с универсальным кодом шаблона в случае связанных шаблонов.

--template-file -f

Путь к файлу шаблона или Bicep-файлу.

--template-spec -s

Идентификатор ресурса спецификации шаблона.

--template-uri -u

Универсальный код ресурса (URI) в файл шаблона.

Глобальные параметры
--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 deployment mg wait

Изменить

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

az deployment mg wait --management-group-id
                      --name
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--timeout]
                      [--updated]

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

--management-group-id -m

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

--name -n

Имя развертывания.

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

--created

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

Default value: False
--custom

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

--deleted

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

Default value: False
--exists

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

Default value: False
--interval

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

Default value: 30
--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 для полных журналов отладки.

az deployment mg what-if

Изменить

Выполните операцию развертывания What-If в области группы управления.

Укажите только один из файлов --template-file | --template-URI URI | --template-spec для ввода шаблона ARM.

az deployment mg what-if --location
                         --management-group-id
                         [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                         [--name]
                         [--no-pretty-print]
                         [--no-prompt {false, true}]
                         [--parameters]
                         [--query-string]
                         [--result-format {FullResourcePayloads, ResourceIdOnly}]
                         [--template-file]
                         [--template-spec]
                         [--template-uri]

Примеры

Выполните операцию развертывания What-If в группе управления.

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Выполните операцию развертывания What-If в группе управления с форматом ResourceIdOnly.

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Выполните операцию развертывания What-If в группе управления без довольной печати результата.

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

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

--location -l

Расположение для хранения метаданных развертывания.

--management-group-id -m

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

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

--exclude-change-types -x

Разделенный пробелами список типов изменений ресурсов, которые следует исключить из What-If результатов.

Допустимые значения: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--name -n

Имя развертывания.

--no-pretty-print

Отключите довольно печать для What-If результатов. При установке будет использоваться тип выходного формата.

--no-prompt

Параметр отключения запроса отсутствующих параметров для шаблона ARM. Если значение равно true, запрос, требующий от пользователей предоставления отсутствующих параметров, будет игнорироваться. Значение по умолчанию — false.

Допустимые значения: false, true
Default value: False
--parameters -p

Укажите значения параметров развертывания.

Параметры могут быть предоставлены из файла с помощью синтаксиса @{path}, строки JSON или пар <KEY=VALUE>. Параметры вычисляются в порядке, поэтому при назначении значения дважды используется последнее значение. Рекомендуется сначала указать файл параметров, а затем переопределить выборочно с помощью синтаксиса KEY=VALUE.

--query-string -q

Строка запроса (маркер SAS), используемая с универсальным кодом шаблона в случае связанных шаблонов.

--result-format -r

Формат результатов What-If.

Допустимые значения: FullResourcePayloads, ResourceIdOnly
Default value: FullResourcePayloads
--template-file -f

Путь к файлу шаблона или Bicep-файлу.

--template-spec -s

Идентификатор ресурса спецификации шаблона.

--template-uri -u

Универсальный код ресурса (URI) в файл шаблона.

Глобальные параметры
--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 для полных журналов отладки.