Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_functionapp_info — получение сведений о приложениях-функциях Azure

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_functionapp_info.

Добавлено в azure.azcollection 0.1.2

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

Краткое описание

  • Получение сведений об одном приложении-функции Azure или обо всех приложениях-функциях в группе ресурсов.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • 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

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; в будущем другие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной окружения 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, на узле должна быть включена среда выполнения MSI ресурса Azure. Если ресурсу предоставлен доступ к нескольким подпискам, для выбора идентификатора подписки можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как оно определено в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает как обнаружение экземпляра, так и проверку центра. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если установить значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Показывать результаты только для указанного приложения-функции.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только исходный токен.

Этот метод часто используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

псевдонимы: resource_group_name

string

Ограничить результаты группой ресурсов. Обязательно при фильтрации по имени.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

list / элементы=string

Ограничить результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение».

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязательно, если задан x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен к закрытому ключу.

Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, задавать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему до запуска задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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: Get facts for one Function App
  azure_rm_functionapp_info:
    resource_group: myResourceGroup
    name: myfunctionapp

- name: Get facts for all Function Apps in a resource group
  azure_rm_functionapp_info:
    resource_group: myResourceGroup

- name: Get facts for all Function Apps by tags
  azure_rm_functionapp_info:
    tags:
      - testing

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

azure_functionapps

list / элементы=string

Список словарей приложений-функций Azure.

Возвращается: всегда

Пример: {"availability_state": "Normal", "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": "Standard", "name": "myfunctionapp.azurewebsites.net", "ssl_state": "Disabled"}, {"host_type": "Repository", "name": "myfunctionapp.scm.azurewebsites.net", "ssl_state": "Disabled"}], "host_names": ["myfunctionapp.azurewebsites.net"], "host_names_disabled": false, "id": "/subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/sites/myfunctionapp", "kind": "functionapp", "last_modified_time_utc": "2017-08-22T18:54:01.190Z", "location": "East US", "name": "myfunctionapp", "outbound_ip_addresses": "............", "repository_site_name": "myfunctionapp", "reserved": false, "resource_group": "myResourceGroup", "scm_site_also_stopped": false, "server_farm_id": "/subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/serverfarms/EastUSPlan", "state": "Running", "type": "Microsoft.Web/sites", "usage_state": "Normal"}

Авторы

  • Thomas Stringer (@trstringer)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API