azure.azcollection.azure_rm_functionapp модуль — Управление приложениями Azure Functions
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_functionapp.
Впервые в azure.azcollection 0.1.2
Описание
- Создание, обновление или удаление приложения Azure Functions.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, который выполняет модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
app_settings dictionary | Словарь, содержащий параметры приложения. |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в значение При установке в значение При установке в значение При установке в значение При установке в значение Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но когда используется прокси-сервер HTTPS или Azure Stack, может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
container_settings dictionary | Параметры контейнера веб-приложения. |
|
name string / required |
Имя контейнера. Например, “imagename:tag”. |
|
registry_server_password string |
Пароль сервера реестра контейнеров. |
|
registry_server_url string |
URL-адрес сервера реестра контейнеров. Например, |
|
registry_server_user string |
Имя пользователя сервера реестра контейнеров. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел является действительным и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
identity dictionary added in azure.azcollection 2.5.0 | Идентификатор для FunctionApp. |
|
type string |
Тип управляемой идентификации Варианты:
|
|
user_assigned_identities dictionary |
Управляемые идентификаторы, назначенные пользователю, и их параметры По умолчанию: |
|
append boolean |
Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false) Варианты:
|
|
id list / elements=string |
Список идентификаторов управляемых идентификаторов, назначенных пользователю, связанных с FunctionApp По умолчанию: |
location string | Допустимое расположение Azure. По умолчанию - расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя Azure Function App. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. |
plan any | План службы приложений. Может быть именем существующего плана службы приложений в той же группе ресурсов, что и функция. Может быть идентификатором ресурса существующего плана службы приложений. Идентификатор ресурса. Например, /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>. Может быть словарем, содержащим
|
profile string | Профиль безопасности, находящийся в файле ~/.azure/credentials. |
resource_group aliases: resource_group_name string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала. |
state string | Утверждение состояния Function App. Используйте Варианты:
|
storage_account aliases: storage, storage_account_name string | Имя хранилища, которое нужно использовать. Требуется при создании. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар ключ-значение типа строка-строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала. |
thumbprint string added in azure.azcollection 1.14.0 | Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы-принципала. Требуется, если задан x509_certificate_path. |
x509_certificate_path path added in azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания службы-принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используйте при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с 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 словарь | Текущее состояние приложения Azure Function. Возвращаемое значение: success Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_functionapp_module.html