community.azure.azure_rm_appserviceplan_info – Получение фактов о плане службы приложений Azure

Примечание

Этот плагин входит в коллекцию community.azure (версия 1.0.0).

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

Для использования в книге задач укажите: community.azure.azure_rm_appserviceplan_info.

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

Обзор

Получение фактов о конкретном плане службы приложений или всех планах службы приложений в группе ресурсов или всех планах службы приложений в текущей подписке.

Требования

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

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.
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`.
name строка		Отображать результаты только для конкретного плана службы приложений.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Ограничить результаты по группе ресурсов.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
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: Get facts for app service plan by name
  community.azure.azure_rm_appserviceplan_info:
    resource_group: myResourceGroup
    name: myAppServicePlan

- name: Get azure_rm_appserviceplan_facts for app service plan in resource group
  community.azure.azure_rm_appserviceplan_info:
    resource_group: myResourceGroup

- name: Get facts for app service plan with tags
  community.azure.azure_rm_appserviceplan_info:
    tags:
      - testtag
      - foo:bar

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

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

Ключ			Возвращаемое значение	Описание
appserviceplans сложный тип			всегда	Список планов службы приложений.
	id строка		всегда	Идентификатор плана службы приложений. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myPlan
	kind строка		всегда	Тип плана службы приложений. Пример: app
	location строка		всегда	Расположение плана службы приложений.
	name строка		всегда	Имя плана службы приложений.
	resource_group строка		всегда	Группа ресурсов плана службы приложений. Пример: myResourceGroup
	sku сложный тип		всегда	Sku плана службы приложений.
		capacity целое число	всегда	Емкость sku. Пример: 1
		family строка	всегда	Семейство sku. Пример: S
		name строка	всегда	Имя sku. Пример: S1
		size строка	всегда	Размер sku. Пример: S1
		tier строка	всегда	Уровень sku. Пример: Стандартный

Авторы

Yunge Zhu (@yungezz)

© 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/community/azure/azure_rm_appserviceplan_info_module.html