azure_rm_appserviceplan_facts – Получение фактов о планах приложений Azure

Новое в версии 2.7.

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_profile строка добавлен в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, и по умолчанию будет установлено значение `auto` , если переменная не определена. `auto` будет следовать по умолчанию, соблюдая приоритет параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке значения `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть установлено через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке значения `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано в профиле файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.
cloud_environment строка добавлен в 2.4	Значение по умолчанию: "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
  azure_rm_appserviceplan_facts:
    resource_group: myResourceGroup
    name: winwebapp1

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

- name: Get facts for app service plan with tags
  azure_rm_appserviceplan_facts:
    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. Пример: Стандартный

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Yunge Zhu (@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.8/modules/azure_rm_appserviceplan_facts_module.html