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

az devcenter admin devbox-definition

Note

Эта ссылка является частью расширения центра разработки для Azure CLI (версия 2.75.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az devcenter admin devbox-definition. Подробнее о расширениях.

Управление определениями полей разработки.

Команды

Имя Описание Тип Состояние
az devcenter admin devbox-definition create

Создание определения поля разработки.

 Extension GA
az devcenter admin devbox-definition delete

Удаление определения поля разработки.

 Extension GA
az devcenter admin devbox-definition list

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

 Extension GA
az devcenter admin devbox-definition show

Получение определения поля разработки, настроенного для центра разработки или проекта.

 Extension GA
az devcenter admin devbox-definition update

Обновление определения поля разработки.

 Extension GA
az devcenter admin devbox-definition wait

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

 Extension GA

az devcenter admin devbox-definition create

Создание определения поля разработки.

az devcenter admin devbox-definition create --dev-center --dev-center-name
                                            --devbox-definition-name --name
                                            --image-reference
                                            --os-storage-type
                                            --resource-group
                                            --sku
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]

Примеры

Create

az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

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

--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

--devbox-definition-name --name -n

Имя определения поля разработки.

--image-reference

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

Свойство Значение
Группа параметров: Properties Arguments
--os-storage-type

Тип хранилища, используемый для диска операционной системы полей разработки, созданных с помощью этого определения.

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

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

--sku

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

Свойство Значение
Группа параметров: Properties Arguments

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

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

--hibernate-support

Указывает, могут ли поля разработки, созданные с помощью этого определения, выполнять гибернацию. Не все изображения могут поддерживать гибернацию. Дополнительные сведения см. в https://aka.ms/devbox/hibernate.

Свойство Значение
Группа параметров: Properties Arguments
Допустимые значения: Disabled, Enabled
--location -l

Географическое расположение, в котором находится ресурс. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>. Если это не указано, будет использоваться расположение группы ресурсов.

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

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

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--tags

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

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

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

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

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

--only-show-errors

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

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

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

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

Удаление определения поля разработки.

az devcenter admin devbox-definition delete [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

Примеры

Delete

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

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

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

--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

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

Имя определения поля разработки.

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

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

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

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

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

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

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

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

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az devcenter admin devbox-definition list

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

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center --dev-center-name]
                                          [--max-items]
                                          [--next-token]
                                          [--project --project-name]

Примеры

Список по центру разработки

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

Список по проекту

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

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

--resource-group -g

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

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

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

--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

--max-items

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

Свойство Значение
Группа параметров: Pagination Arguments
--next-token

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

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

Имя проекта. Используйте az configure -d project=<project_name> для настройки по умолчанию.

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

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

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

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

--only-show-errors

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

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

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

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

Получение определения поля разработки, настроенного для центра разработки или проекта.

az devcenter admin devbox-definition show [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--ids]
                                          [--project --project-name]
                                          [--resource-group]
                                          [--subscription]

Примеры

Получение определения поля разработки центра разработки

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

Получение определения поля разработки проекта

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

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

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

--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

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

Имя определения поля разработки.

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

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

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

Имя проекта. Используйте az configure -d project=<project_name> для настройки по умолчанию.

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

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

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

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az devcenter admin devbox-definition update

Обновление определения поля разработки.

az devcenter admin devbox-definition update [--add]
                                            [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--ids]
                                            [--image-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--os-storage-type]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--sku]
                                            [--subscription]
                                            [--tags]

Примеры

Update

az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

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

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

--add

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

Свойство Значение
Группа параметров: Generic Update Arguments
--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

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

Имя определения поля разработки.

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

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

Свойство Значение
Группа параметров: Generic Update Arguments
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support

Указывает, могут ли поля разработки, созданные с помощью этого определения, выполнять гибернацию. Не все изображения могут поддерживать гибернацию. Дополнительные сведения см. в https://aka.ms/devbox/hibernate.

Свойство Значение
Группа параметров: Properties Arguments
Допустимые значения: Disabled, Enabled
--ids

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

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

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

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

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

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--os-storage-type

Тип хранилища, используемый для диска операционной системы полей разработки, созданных с помощью этого определения.

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

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

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

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

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

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

Свойство Значение
Группа параметров: Generic Update Arguments
--sku

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

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

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

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

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az devcenter admin devbox-definition wait

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

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

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

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

--created

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--custom

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

Свойство Значение
Группа параметров: Wait Condition Arguments
--deleted

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--dev-center --dev-center-name -d

Имя центра разработки. Используйте az configure -d dev-center=<dev_center_name> для настройки по умолчанию.

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

Имя определения поля разработки.

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

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--ids

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

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

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 30
--resource-group -g

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

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

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

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

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 3600
--updated

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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