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 | URL-адрес авторитета Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственном авторитете ADFS. | ||
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| app_settings - | Словарь, содержащий параметры приложения. | ||
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| 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. | |
| container_settings - добавлен в 2.8 | Параметры контейнера веб-приложения. | ||
| name - | Имя контейнера. Например, "imagename:tag". | ||
| registry_server_password - | Пароль сервера реестра контейнеров. | ||
| registry_server_url - | URL-адрес сервера реестра контейнеров. Например, mydockerregistry.io. | ||
| registry_server_user - | Имя пользователя сервера реестра контейнеров. | ||
| location - | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | ||
| name - / обязательно | Имя приложения Azure Functions. | ||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы. | ||
| plan - добавлен в 2.8 | План службы приложений. Это может быть имя существующего плана службы приложений в той же группе ресурсов, что и приложение функций. Это может быть идентификатор ресурса существующего плана службы приложений. Идентификатор ресурса. Например, /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>. Это может быть словарь, содержащий name, resource_group.name. Имя плана службы приложений.resource_group. Имя группы ресурсов плана службы приложений. | ||
| 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, или войти в систему перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью управляемого сервиса или пользователя 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 в среде.
См. также
См. также
- Вход в Azure CLI
- Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create a function app
azure_rm_functionapp:
resource_group: myResourceGroup
name: myFunctionApp
storage_account: myStorageAccount
- name: Create a function app with app settings
azure_rm_functionapp:
resource_group: myResourceGroup
name: myFunctionApp
storage_account: myStorageAccount
app_settings:
setting1: value1
setting2: value2
- name: Create container based function app
azure_rm_functionapp:
resource_group: myResourceGroup
name: myFunctionApp
storage_account: myStorageAccount
plan:
resource_group: myResourceGroup
name: myAppPlan
container_settings:
name: httpd
registry_server_url: index.docker.io
- name: Delete a function app
azure_rm_functionapp:
resource_group: myResourceGroup
name: myFunctionApp
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| state словарь | success | Текущее состояние приложения Azure Function. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Thomas Stringer (@trstringer)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_functionapp_module.html
