Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_arcmachineextensions — создание, обновление и удаление расширений ARC для компьютеров.

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_arcmachineextensions.

Добавлено в azure.azcollection 3.17.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Создание, обновление и удаление расширений ARC для компьютеров.
  • https://learn.microsoft.com/en-us/python/api/azure-mgmt-hybridcompute/azure.mgmt.hybridcompute.operations.machineextensionsoperations?view=azure-python#azure-mgmt-hybridcompute-operations-machineextensionsoperations-begin-create-or-update

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю с собственным центром сертификации ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Определяет, является ли поле tags каноническим или новые теги просто добавляются к существующим.

В каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Можно также задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут считываться из переменных среды.

Если задано значение credential_file, профиль будет считываться из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Для указания идентификатора подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет использоваться подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Можно также задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для ситуаций, когда невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации отключается. Поэтому важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия.

Значение можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

location

string

Расположение расширения ARC для компьютера.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

machine_name

string / обязательный

Имя компьютера ARC.

name

string / обязательный

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

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую.

Можно также задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Можно также задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

properties

dictionary

Описывает свойства расширения компьютера.

Обязателен для создания.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-hybridcompute/azure.mgmt.hybridcompute.models.machineextensionproperties?view=azure-python

auto_upgrade_minor_version

boolean

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

Не работает: https://github.com/Azure/azure-rest-api-specs/issues/37591

Варианты:

  • false
  • true

enable_automatic_upgrade

boolean

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

Варианты:

  • false
  • true

force_update_tag

string

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

protected_settings

dictionary

Защищенные параметры расширения.

publisher

string

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

settings

dictionary

Общедоступные параметры расширения.

type

string

Указывает тип расширения.

type_handler_version

string

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

resource_group

string / обязательный

Имя группы ресурсов.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

state

string

Состояние расширения ARC для компьютера

Используйте present для создания или обновления расширения ARC для компьютера.

Используйте absent для удаления расширения ARC для компьютера.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Метаданные объекта будут обновлены с учетом всех переданных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время службы DNS Zones и Traffic Manager Azure также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан параметр x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен после закрытого ключа.

Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте subscription_id, client_id, secret и tenant либо задайте переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации пользователя Active Directory передайте ad_user и password либо задайте в среде AZURE_AD_USER и AZURE_PASSWORD.
  • Кроме того, учетные данные можно хранить в файле ~/.azure/credentials. Это INI-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant либо subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль с помощью параметра profile или задав в среде AZURE_PROFILE.

См. также

См. также

Вход с помощью Azure CLI

Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Add a arc machine extension
  azure.azcollection.azure_rm_arcmachineextensions:
    state: present
    resource_group: resource_group_name
    machine_name: vm_name
    name: AzureMonitorLinuxAgent
    location: germanywestcentral
    properties:
      auto_upgrade_minor_version: false
      enable_automatic_upgrade: true
      publisher: Microsoft.Azure.Monitor
      type: AzureMonitorLinuxAgent
      type_handler_version: 1.37.0

- name: Delete a arc machine extension
  azure.azcollection.azure_rm_arcmachineextensions:
    state: absent
    name: arc_machine_extension_name
    machine_name: vm_name
    resource_group: resource_group_name

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

arcmachineextension

dictionary

Сведения о расширении ARC для компьютера

Имеет значение null при state==absent (расширение ARC для компьютера не существует или будет удалено)

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

Возвращается: всегда

Пример: {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup/providers/Microsoft.HybridCompute/machines/VMName/extensions/AzureMonitorLinuxAgent", "location": "germanywestcentral", "name": "AzureMonitorLinuxAgent", "properties": {"auto_upgrade_minor_version": false, "enable_automatic_upgrade": true, "force_update_tag": null, "instance_view": {"name": "AzureMonitorLinuxAgent", "status": {"code": "0", "level": "Information", "message": "Extension Message: Enable succeeded"}, "type": "AzureMonitorLinuxAgent", "type_handler_version": "1.37.0"}, "protected_settings": null, "publisher": "Microsoft.Azure.Monitor", "settings": null, "type": "AzureMonitorLinuxAgent", "type_handler_version": "1.37.0"}, "system_data": {"created_at": "2025-09-24T13:12:35.754905Z", "created_by": "your_sp", "created_by_type": "Application", "last_modified_at": "2025-09-24T13:12:35.754905Z", "last_modified_by": "your_sp", "last_modified_by_type": "Application"}, "tags": {"Tag1": "Value1"}, "type": "Microsoft.HybridCompute/machines/extensions"}

Авторы

  • Klaas Weyermann (@Klaas-)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_arcmachineextensions_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API