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	Значение по умолчанию: null	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	Варианты: validate ignore	Управляет поведением проверки сертификата для 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. Аутентификация возможна с использованием принципала службы или пользователя 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 в среде.

Примеры

- name: Get facts for app service plan by name
  azure_rm_appserviceplan_facts:
    resource_group: testrg
    name: winwebapp1

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

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

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

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

Ключ			Возвращаемое значение	Описание
appserviceplans сложный			всегда	Список планов приложений.
	id строка		всегда	Идентификатор плана приложения. Пример: /subscriptions/xxxx/resourceGroupsxxx/providers/Microsoft.Web/serverfarms/xxx
	kind строка		всегда	Тип плана приложения. Пример: app
	location строка		всегда	Расположение плана приложения.
	name строка		всегда	Имя плана приложения.
	resource_group строка		всегда	Группа ресурсов плана приложения.
	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.7/modules/azure_rm_appserviceplan_facts_module.html