az connectedmachine extension

Note

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

Управление расширением виртуальной машины на сервере с поддержкой Azure Arc.

Команды

Имя Описание Тип Состояние
az connectedmachine extension create

Создайте расширение.

 Extension GA
az connectedmachine extension delete

Удаление расширения.

 Extension GA
az connectedmachine extension image

Управление метаданными расширения виртуальной машины, доступными для серверов с поддержкой Azure Arc.

 Extension GA
az connectedmachine extension image list

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

 Extension GA
az connectedmachine extension image show

Получение метаданных расширения на основе расположения, издателя, расширенияType и версии.

 Extension GA
az connectedmachine extension list

Получите все расширения компьютера, отличного от Azure.

 Extension GA
az connectedmachine extension publisher

Управление Publisher.

 Extension GA
az connectedmachine extension publisher list

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

 Extension GA
az connectedmachine extension show

Отображение расширения компьютера, отличного от Azure.

 Extension GA
az connectedmachine extension type

Управление типом расширения.

 Extension GA
az connectedmachine extension type list

Список всех типов расширений на основе расположения и издателя.

 Extension GA
az connectedmachine extension update

Обновите расширение.

 Extension GA
az connectedmachine extension wait

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

 Extension GA

az connectedmachine extension create

Создайте расширение.

az connectedmachine extension create --extension-name --name
                                     --machine-name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Примеры

Пример команды для создания расширения

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

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

--extension-name --name -n

Имя расширения компьютера.

--machine-name

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

--resource-group -g

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

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

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--auto-upgrade-min --auto-upgrade-minor-version

Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.

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

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--enable-auto-upgrade --enable-automatic-upgrade

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

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

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

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

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

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

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

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

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

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

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

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

Имя издателя обработчика расширений.

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

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

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

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

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

Указывает тип расширения; примером является CustomScriptExtension.

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

Указывает версию обработчика скрипта.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az connectedmachine extension delete

Удаление расширения.

az connectedmachine extension delete [--acquire-policy-token]
                                     [--change-reference]
                                     [--extension-name --name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Примеры

Пример команды удаления расширения

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

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

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--extension-name --name -n

Имя расширения компьютера.

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

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

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

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

Свойство Значение
Группа параметров: 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

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

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az connectedmachine extension list

Получите все расширения компьютера, отличного от Azure.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

Примеры

Пример команды для списка расширений

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

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

--machine-name

Имя компьютера, содержащего расширение.

--resource-group -g

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

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

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

--expand

Выражение расширения, применяемое к операции.

--max-items

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

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

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

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az connectedmachine extension show

Отображение расширения компьютера, отличного от Azure.

az connectedmachine extension show [--extension-name --name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Примеры

Пример команды для отображения расширения

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

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

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

--extension-name --name -n

Имя расширения компьютера.

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

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

Свойство Значение
Группа параметров: Resource Id Arguments
--machine-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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az connectedmachine extension update

Обновите расширение.

az connectedmachine extension update [--acquire-policy-token]
                                     [--add]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name --name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Примеры

Пример команды для обновления расширения

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

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

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

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

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

Свойство Значение
Группа параметров: Generic Update Arguments
--auto-upgrade-min --auto-upgrade-minor-version

Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.

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

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--enable-auto-upgrade --enable-automatic-upgrade

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

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

Имя расширения компьютера.

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

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

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

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

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

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

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

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

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

Имя компьютера, содержащего расширение.

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

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

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

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

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

Имя издателя обработчика расширений.

Свойство Значение
Группа параметров: 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
--settings

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

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

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

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

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

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

Указывает тип расширения; примером является CustomScriptExtension.

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

Указывает версию обработчика скрипта.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az connectedmachine extension wait

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

az connectedmachine extension wait [--acquire-policy-token]
                                   [--change-reference]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name --name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

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

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

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

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

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

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

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

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

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

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: False
--extension-name --name -n

Имя расширения компьютера.

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

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

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

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

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: 30
--machine-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
--timeout

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

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

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

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Значение по умолчанию: False