azure.azcollection.azure_rm_appserviceplan_info – Получение фактов о плане Azure App Service

Примечание

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_appserviceplan_info.

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

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 0.0.1 of azure.azcollection		URL-адрес авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном авторитете ADFS.
api_profile строка добавлен в 0.0.1 of azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлен в 0.0.1 of 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` может использоваться для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure CLI. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлен в 0.0.1 of azure.azcollection	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (определённое Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name строка		Показать результаты только для конкретного плана App Service.
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
  azure_rm_appserviceplan_info:
    resource_group: myResourceGroup
    name: myAppServicePlan

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

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

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

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

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

Авторы

Юньге Жу (@yungezz)

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