azure.azcollection.azure_rm_functionapp – Управление приложениями Azure Functions

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_functionapp.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Создание, обновление или удаление приложения Azure Functions.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection			URL-адрес службы Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службы ADFS.
api_profile строка добавлено в 0.0.1 из azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
app_settings строка			Словарь, содержащий параметры приложения.
append_tags логический тип		Варианты: no yes ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 из azure.azcollection		Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения `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.
cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection		Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точке. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.
cloud_environment строка добавлено в 0.0.1 из azure.azcollection		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
container_settings строка			Настройки контейнера веб-приложения.
	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 строка			План службы приложений. Может быть именем существующего плана службы приложений в той же группе ресурсов, что и приложение функций. Может быть идентификатором ресурса существующего плана службы приложений. Идентификатор ресурса. Например, /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 строка		Варианты: absent present ←	Утверждает состояние приложения Functions. Используйте `present` для создания или обновления приложения функций, и `absent` для удаления.
storage_account строка / обязательно			Имя хранилища, которое будет использоваться. псевдонимы: storage, storage_account_name
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка, присваиваемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка			Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации в Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед выполнением задач или playbook с помощью 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 словарь	успех	Текущее состояние приложения Azure Function. Пример: {'availability_state': 'Нормальное', 'client_affinity_enabled': True, 'client_cert_enabled': False, 'container_size': 1536, 'daily_memory_time_quota': 0, 'default_host_name': 'myfunctionapp.azurewebsites.net', 'enabled': True, 'enabled_host_names': ['myfunctionapp.azurewebsites.net', 'myfunctionapp.scm.azurewebsites.net'], 'host_name_ssl_states': [{'host_type': 'Стандартный', 'name': 'myfunctionapp.azurewebsites.net', 'ssl_state': 'Отключен'}, {'host_type': 'Репозиторий', 'name': 'myfunctionapp.scm.azurewebsites.net', 'ssl_state': 'Отключен'}], 'host_names': ['myfunctionapp.azurewebsites.net'], 'host_names_disabled': False, 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myFunctionApp', 'kind': 'functionapp', 'last_modified_time_utc': '2017-08-22T18:54:01.190Z', 'location': 'Восточная часть США', 'name': 'myfunctionapp', 'outbound_ip_addresses': '............', 'repository_site_name': 'myfunctionapp', 'reserved': False, 'resource_group': 'myResourceGroup', 'scm_site_also_stopped': False, 'server_farm_id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/EastUSPlan', 'state': 'Запущен', 'type': 'Microsoft.Web/sites', 'usage_state': 'Нормальное'}

Авторы

Thomas Stringer (@trstringer)

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