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

az deployment tenant

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

Команды

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

Отмена развертывания в области клиента.

 Core GA
az deployment tenant create

Запустите развертывание в области клиента.

 Core GA
az deployment tenant delete

Удаление развертывания в области клиента.

 Core GA
az deployment tenant export

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

 Core GA
az deployment tenant list

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

 Core GA
az deployment tenant show

Отображение развертывания в области клиента.

 Core GA
az deployment tenant validate

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

 Core GA
az deployment tenant wait

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

 Core GA
az deployment tenant what-if

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

 Core GA

az deployment tenant cancel

Изменить

Отмена развертывания в области клиента.

az deployment tenant cancel --name

Примеры

Отмена развертывания в области клиента.

az deployment tenant cancel -n deployment01

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

--name -n

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

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

Изменить

Запустите развертывание в области клиента.

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

az deployment tenant create --location
                            [--confirm-with-what-if]
                            [--handle-extended-json-format]
                            [--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 tenant create --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment tenant create --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

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

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

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

--location -l

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

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

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

--confirm-with-what-if -c

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

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

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

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

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

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

Свойство Значение
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 tenant delete

Изменить

Удаление развертывания в области клиента.

az deployment tenant delete --name
                            [--no-wait]

Примеры

Удаление развертывания в области клиента.

az deployment tenant delete -n deployment01

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

--name -n

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

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

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 tenant export

Изменить

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

az deployment tenant export --name

Примеры

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

az deployment tenant export --name MyDeployment

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

--name -n

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

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

Изменить

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

az deployment tenant list [--filter]

Примеры

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

az deployment tenant list

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

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 tenant show

Изменить

Отображение развертывания в области клиента.

az deployment tenant show --name

Примеры

Отображение развертывания в области клиента.

az deployment tenant show -n deployment01

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

--name -n

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

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

Изменить

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

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

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

Примеры

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

az deployment tenant validate --location WestUS --template-file {template-file}

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

az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

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

--location -l

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

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

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

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

--name -n

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

--no-prompt

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

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

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

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

--query-string -q

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

--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 tenant wait

Изменить

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

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

Примеры

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

az deployment tenant wait --deleted --name MyDeployment

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

--name -n

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

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

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 tenant what-if

Изменить

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

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

az deployment tenant what-if --location
                             [--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 tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

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

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

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

--location -l

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

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

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

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

Свойство Значение
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