модуль azure.azcollection.azure_rm_batchaccountapplicationpackage – управление пакетами приложений учетной записи Batch в Azure

Примечание

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

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

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

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

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

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

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

Создание, обновление и удаление экземпляра пакета приложений учетной записи Azure Batch.

Требования

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

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

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
application_name строка / обязательный	Имя приложения учетной записи Batch.
auth_source строка добавлено в 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`; в противном случае используется подписка az cli по умолчанию. Если задано значение `msi`, компьютер должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае выбирается первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
batch_account_name строка / обязательный	Имя учетной записи Batch.
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логический добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для использования в сценариях, где конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение True, проверка центра будет отключена. Поэтому важно убедиться, что настроенный узел центра является действительным и заслуживающим доверия. Задается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
format строка	Формат пакета приложения, если пакет активен. Например, `zip`.
is_activate логический	Определяет, следует ли активировать указанный пакет приложения. Варианты: `false` ← (по умолчанию) `true`
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка / обязательный	Имя пакета приложений учетной записи Batch.
oidc_token строка добавлено в 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 путь добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile строка	Профиль безопасности из файла ~/.azure/credentials.
resource_group строка / обязательный	Имя группы ресурсов, в которой необходимо создать пакет приложений учетной записи Batch.
secret строка	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
state строка	Задает требуемое состояние пакета приложений учетной записи Batch. Используйте `present` для создания или обновления пакета приложений учетной записи Batch и `absent` для его удаления. Варианты: `"present"` ← (по умолчанию) `"absent"`
subscription_id строка	Идентификатор вашей подписки Azure.
tenant строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path.
x509_certificate_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: Create Batch Account Application Package
  azure_rm_batchaccountapplicationpackage:
    resource_group: MyResGroup
    application_name: mybatchaccountapplication
    batch_account_name: mybatchaccount
    name: version01

- name: Activate the Batch Account Application Package
  azure_rm_batchaccountapplicationpackage:
    resource_group: MyResGroup
    application_name: mybatchaccountapplication
    batch_account_name: mybatchaccount
    name: version01
    is_activate: true
    format: zip

- name: Delete Batch Account Application Package
  azure_rm_batchaccountapplicationpackage:
    resource_group: MyResGroup
    application_name: mybatchaccountapplication
    batch_account_name: mybatchaccount
    name: version01
    state: absent

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

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

Ключ	Описание
state complex	Указанный пакет приложения/ Возвращается: всегда
application_name string	Имя приложения. Возвращается: всегда Пример: `"app01"`
batch_account_name string	Имя учетной записи пакетной службы. Возвращается: всегда Пример: `"batch01"`
etag string	ETag ресурса, используемый для управления параллельным доступом. Возвращается: всегда Пример: `"638663294398436610"`
format string	Формат пакета приложения, если пакет активен. Возвращается: всегда Пример: `"zip"`
id string	Идентификатор пакета приложения. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Batch/batchAccounts/batch01/applications/app01/versions/version01"`
last_activation_time string	Время последней активации пакета, если пакет активен. Возвращается: всегда Пример: `"2024-11-04T15:03:59.834538Z"`
name string	Имя ресурса. Возвращается: всегда Пример: `"version01"`
resource_group string	Группа ресурсов пакета приложения. Возвращается: всегда Пример: `"testRG"`
state string	Текущее состояние пакета приложения. Возвращается: всегда Пример: `"Active"`
storage_url string	URL пакета приложения в Azure Storage. Возвращается: всегда
storage_url_expiry string	Время в формате UTC, когда истечет срок действия URL Azure Storage. Возвращается: всегда
type string	Тип пакета приложения учетной записи пакетной службы. Возвращается: всегда Пример: `"Microsoft.Batch/batchAccounts/applications/versions"`

Авторы

xuzhang3 (@xuzhang3)
Fred Sun (@Fred-sun)

Ссылки коллекции

© 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_batchaccountapplicationpackage_module.html