azure_rm_functionapp - Управление приложениями Azure Functions
Новая версия с 2.4.
Обзор
- Создание, обновление или удаление приложения Azure Functions
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url (добавлено в 2.6) | Значение по умолчанию: null | URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и наличии собственных полномочий ADFS. |
| api_profile (добавлено в 2.5) | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать Azure Stack. |
| app_settings (добавлено в 2.6) | Словарь, содержащий параметры приложения | |
| append_tags bool |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом поле все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные берутся из профиля по умолчанию Azure CLI.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode (добавлено в 2.5) |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. | |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: "AzureCloud" | Для облачных сред, отличных от публичного облака США, используется имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| location (добавлено в 2.6) | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. | |
| name обязательно | Имя приложения Azure Functions | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов псевдонимы: resource_group_name | |
| secret | Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы. | |
| state |
| Утверждение состояния приложения Functions. Используйте 'present' для создания или обновления приложения Functions и 'absent' для удаления. |
| storage_account обязательно (добавлено в 2.6) | Имя используемой учетной записи хранения. псевдонимы: storage, storage_account_name | |
| subscription_id | Идентификатор вашей подписки Azure. | |
| tags | Словарь пар строка:строка, присваиваемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. | |
| tenant | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя Active Directory. Для аутентификации с помощью принципала службы передайте 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 в среде.
Примеры
- name: create function app
azure_rm_functionapp:
resource_group: ansible-rg
name: myfunctionapp
- name: create a function app with app settings
azure_rm_functionapp:
resource_group: ansible-rg
name: myfunctionapp
app_settings:
setting1: value1
setting2: value2
- name: delete a function app
azure_rm_functionapp:
name: myfunctionapp
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в документе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| state dict | success | Текущее состояние приложения Azure Function |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. в документе по поддержке модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Thomas Stringer (@tstringer)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/azure_rm_functionapp_module.html
