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 - | Словарь, содержащий параметры приложения | |
| append_tags boolean |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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 - | Допустимое расположение 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 - / обязательно | Имя хранилища, которое необходимо использовать. алиасы: 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 словарь | успех | Текущее состояние приложения Azure Functions |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_functionapp_module.html
