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


az deployment group

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

Команды

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

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

Core GA
az deployment group create

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

Core GA
az deployment group delete

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

Core GA
az deployment group export

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

Core GA
az deployment group list

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

Core GA
az deployment group show

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

Core GA
az deployment group validate

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

Core GA
az deployment group wait

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

Core GA
az deployment group what-if

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

Core GA

az deployment group cancel

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

az deployment group cancel --name
                           --resource-group

Примеры

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

az deployment group cancel -g testrg -n deployment01

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

--name -n

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

--resource-group -g

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group create

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

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

az deployment group create --resource-group
                           [--aux-subs]
                           [--aux-tenants]
                           [--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]
                           [--rollback-on-error]
                           [--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 group create --resource-group testrg --name rollout01 \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

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

az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'

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

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This [email protected]

Создание развертывания в области группы ресурсов из спецификации шаблона

az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

Создание развертывания в области группы ресурсов из файла параметров bicepparam

az deployment group create --resource-group testrg --parameters parameters.bicepparam

Создание развертывания в группе ресурсов в клиентах

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02

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

--resource-group -g

Группа ресурсов для создания развертывания.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aux-subs
Не рекомендуется

Параметр "--aux-subs" устарел и будет удален в будущем выпуске. Вместо этого используйте "--aux-tenants".

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

--aux-tenants

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

--confirm-with-what-if -c

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

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

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

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

--mode

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

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

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

--no-prompt

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

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

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

Свойство Значение
Default value: False
--parameters -p

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

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

--proceed-if-no-change

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

--query-string -q

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

--rollback-on-error

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

--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.

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group delete

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

az deployment group delete --name
                           --resource-group
                           [--no-wait]

Примеры

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

az deployment group delete -g testrg -n deployment01

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

--name -n

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

--resource-group -g

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group export

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

az deployment group export --name
                           --resource-group

Примеры

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

az deployment group export --resource-group testrg --name MyDeployment

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

--name -n

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

--resource-group -g

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group list

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

az deployment group list --resource-group
                         [--filter]

Примеры

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

az deployment group list -g testrg

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

--resource-group -g

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group show

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

az deployment group show --name
                         --resource-group

Примеры

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

az deployment group show -g testrg -n deployment01

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

--name -n

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

--resource-group -g

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group validate

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

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

az deployment group validate --resource-group
                             [--handle-extended-json-format]
                             [--mode {Complete, Incremental}]
                             [--name]
                             [--no-prompt {false, true}]
                             [--parameters]
                             [--query-string]
                             [--rollback-on-error]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]

Примеры

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

az deployment group validate --resource-group testrg --template-file {template-file}

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

az deployment group validate --parameters MyValue=This [email protected] --resource-group testrg --template-file azuredeploy.json

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

--resource-group -g

Группа ресурсов для создания развертывания.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

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

--mode

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

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

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

--no-prompt

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

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

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

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

--query-string -q

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

--rollback-on-error

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

--template-file -f

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

--template-spec -s

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

--template-uri -u

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group wait

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

az deployment group wait --name
                         --resource-group
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--timeout]
                         [--updated]

Примеры

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

az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup

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

--name -n

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

--resource-group -g

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--interval

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az deployment group what-if

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

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

az deployment group what-if --resource-group
                            [--aux-tenants]
                            [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                            [--mode {Complete, Incremental}]
                            [--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 group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

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

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

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

--resource-group -g

Группа ресурсов для выполнения операции развертывания What-If.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aux-tenants

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

--exclude-change-types -x

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

Свойство Значение
Допустимые значения: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--mode

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

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

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

--no-pretty-print

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

--no-prompt

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

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

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

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

--query-string -q

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

--result-format -r

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

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

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

--template-spec -s

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

--template-uri -u

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False