azure_rm_azurefirewall_info – Получение информации об AzureFirewall

Новая версия 2.9.

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

Описание

Получение информации об AzureFirewall.

Требования

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

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.
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: List all Azure Firewalls for a given subscription
  azure_rm_azurefirewall_info:
- name: List all Azure Firewalls for a given resource group
  azure_rm_azurefirewall_info:
    resource_group: myResourceGroup
- name: Get Azure Firewall
  azure_rm_azurefirewall_info:
    resource_group: myResourceGroup
    name: myAzureFirewall

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

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

Ключ		Возвращаемое значение	Описание
firewalls complex		всегда	Список словарей результатов, где ключ — имя AzureFirewall, а значения — фактические данные для этого AzureFirewall.
	etag строка	всегда	Получает уникальную неизменяемую строку, которая меняется при каждом обновлении ресурса. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall
	ip_configurations список		Конфигурация IP-адресов ресурса Azure Firewall.
	location строка	всегда	Расположение ресурса. Пример: eastus
	name строка	всегда	Имя ресурса. Пример: myAzureFirewall
	nat_rule_collections список		Коллекция правил NAT, используемых Azure Firewall.
	network_rule_collections список		Коллекция правил сети, используемых Azure Firewall.
	provisioning_state строка		Текущее состояние галереи. Пример: Выполнено
	tags словарь	всегда	Теги ресурса. Пример: {'тег': 'значение'}

Статус

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

Авторы

Liu Qingyi (@smile37773)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_azurefirewall_info_module.html