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

az blueprint

  • Ссылка

Примечание.

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

Команды для управления схемой.

Команды

Имя Описание Тип Состояние
az blueprint artifact

Команды для управления артефактом схемы.

 Расширение ГА
az blueprint artifact delete

Удаление артефакта схемы.

 Расширение Предварительный просмотр
az blueprint artifact list

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

 Расширение Предварительный просмотр
az blueprint artifact policy

Команды для управления артефактом назначения политики схемы.

 Расширение ГА
az blueprint artifact policy create

Создание артефакта политики схемы.

 Расширение ГА
az blueprint artifact policy update

Обновление артефакта политики схемы.

 Расширение ГА
az blueprint artifact role

Команды для управления артефактом назначения ролей схемы.

 Расширение ГА
az blueprint artifact role create

Создание артефакта роли схемы.

 Расширение ГА
az blueprint artifact role update

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

 Расширение ГА
az blueprint artifact show

Получение артефакта схемы.

 Расширение Предварительный просмотр
az blueprint artifact template

Команды для управления артефактом шаблона ARM схемы.

 Расширение ГА
az blueprint artifact template create

Создание артефакта армейки схемы.

 Расширение ГА
az blueprint artifact template update

Обновление артефакта армейки схемы.

 Расширение ГА
az blueprint assignment

Команды для управления назначением схемы.

 Расширение ГА
az blueprint assignment create

Создание назначения схемы.

 Расширение ГА
az blueprint assignment delete

Удаление назначения схемы.

 Расширение Предварительный просмотр
az blueprint assignment list

Вывод списка назначений схемы в подписке.

 Расширение Предварительный просмотр
az blueprint assignment show

Получение назначения схемы.

 Расширение Предварительный просмотр
az blueprint assignment update

Обновление назначения схемы.

 Расширение ГА
az blueprint assignment wait

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

 Расширение ГА
az blueprint assignment who

Получение объекта ObjectId объекта имени субъекта-объекта Blueprint Servie.

 Расширение Предварительный просмотр
az blueprint create

Создание определения схемы.

 Расширение Предварительный просмотр
az blueprint delete

Удаление определения схемы.

 Расширение Предварительный просмотр
az blueprint export

Экспорт определения схемы и артефактов в json-файлы.

 Расширение ГА
az blueprint import

Импорт определения схемы и артефактов из directoy файлов JSON.

 Расширение ГА
az blueprint list

Перечисление определений схемы.

 Расширение Предварительный просмотр
az blueprint publish

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

 Расширение Предварительный просмотр
az blueprint resource-group

Команды для управления артефактом группы ресурсов схемы.

 Расширение ГА
az blueprint resource-group add

Добавьте артефакт группы ресурсов в схему.

 Расширение ГА
az blueprint resource-group list

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

 Расширение ГА
az blueprint resource-group remove

Удалите артефакт группы ресурсов схемы.

 Расширение ГА
az blueprint resource-group show

Отображение артефакта группы ресурсов схемы.

 Расширение ГА
az blueprint resource-group update

Обновление артефакта группы ресурсов схемы.

 Расширение ГА
az blueprint show

Получение определения схемы.

 Расширение Предварительный просмотр
az blueprint update

Обновление определения схемы.

 Расширение Предварительный просмотр
az blueprint version

Команды для управления опубликованными версиями схемы.

 Расширение Предварительный просмотр
az blueprint version artifact

Команды для управления опубликованными артефактами схемы.

 Расширение Предварительный просмотр
az blueprint version artifact list

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

 Расширение Предварительный просмотр
az blueprint version artifact show

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

 Расширение Предварительный просмотр
az blueprint version delete

Удаление опубликованной версии схемы.

 Расширение Предварительный просмотр
az blueprint version list

Список опубликованных версий заданного определения схемы.

 Расширение Предварительный просмотр
az blueprint version show

Получение опубликованной версии схемы.

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

az blueprint create

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Создание определения схемы.

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

Примеры

Создание схемы подписки

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

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

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

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

--name -n

Имя определения схемы.

--target-scope

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

Допустимые значения: managementGroup, subscription

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

--description

В нескольких строках объясняется этот ресурс.

--display-name

Строка однострочный поясняет этот ресурс.

--management-group -m

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

--parameters -p

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

--resource-groups

Заполнители групп ресурсов, определенные этим определением схемы. Ожидаемое значение: json-string/@json-file. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

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

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Удаление определения схемы.

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Примеры

Удаление схемы группы управления

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

Удаление схемы подписки

az blueprint delete --subscription MySubscription --name MyBlueprint

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

--name -n

Имя определения схемы.

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

--management-group -m

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

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

Экспорт определения схемы и артефактов в json-файлы.

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

Примеры

Экспорт определения схемы и артефактов

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

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

--name -n

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

--output-path

Путь к каталогу для определений json схемы и артефактов. Файл определения схемы будет называться blueprint.json. Файлы JSON артефактов будут находиться в подкаталогах с именем артефактов.

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

--management-group -m

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

--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 blueprint import

Импорт определения схемы и артефактов из directoy файлов JSON.

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Примеры

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

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

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

--input-path

Путь к каталогу для определений json схемы и артефактов. Файл определения схемы должен называться blueprint.json. Файлы JSON артефактов должны находиться в подкаталоге с именем артефактов.

--name -n

Имя определения схемы.

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

--management-group -m

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

--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 blueprint list

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Перечисление определений схемы.

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

Примеры

Перечисление схем в группе управления

az blueprint list --management-group MyManagementGroup

Перечисление схем в подписке

az blueprint list --subscription MySubscription

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

--management-group -m

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

--max-items

Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

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

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

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

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

Примеры

Публикация схемы группы управления

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

Публикация схемы подписки

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

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

--blueprint-name

Имя определения схемы.

--version

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

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

--change-notes

Заметки об изменениях для конкретной версии.

--management-group -m

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

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

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Получение определения схемы.

az blueprint show --name
                  [--management-group]
                  [--subscription]

Примеры

Отображение схемы группы управления

az blueprint show --management-group MyManagementGroup --name MyBlueprint

Отображение схемы подписки

az blueprint show --subscription MySubscription --name MyBlueprint

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

--name -n

Имя определения схемы.

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

--management-group -m

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

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

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

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновление определения схемы.

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

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

--name -n

Имя определения схемы.

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

--add

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

--description

В нескольких строках объясняется этот ресурс.

--display-name

Строка однострочный поясняет этот ресурс.

--force-string

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

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

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

--parameters -p

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

--remove

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

--resource-groups

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

--set

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

--subscription -s

Используйте подписку для области схемы. Если группа --management-не указана, значение --subscription или подписка по умолчанию будет использоваться в качестве области.

--target-scope

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

Допустимые значения: managementGroup, subscription
Глобальные параметры
--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.