azure_rm_virtualnetwork_facts – Получение фактов о виртуальной сети

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

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

Описание

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

Требования

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

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 one virtual network
  azure_rm_virtualnetwork_facts:
    resource_group: myResourceGroup
    name: secgroup001

- name: Get facts for all virtual networks
  azure_rm_virtualnetwork_facts:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_virtualnetwork_facts:
    tags:
      - testing

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

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

Ключевые слова			Возвращаемое значение	Описание
azure_virtualnetworks список			всегда	Список словарей виртуальных сетей.
virtualnetworks список			всегда	Список словарей виртуальных сетей с тем же форматом, что и параметры модуля azure_rm_virtualnetwork.
	address_prefixes список			Список диапазонов адресов IPv4, каждый из которых отформатирован с использованием нотации CIDR. Пример: ['10.10.0.0/16']
	dns_servers список			Пользовательский список DNS-серверов. Пример: ['www.azure.com']
	id строка			Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001
	location строка			Допустимое расположение Azure. Пример: eastus
	name строка			Имя виртуальной сети. Пример: foo
	provisioning_state строка			Состояние подготовки ресурса. Пример: Successed
	subnets список			Подсети, связанные с этой виртуальной сетью.
		address_prefix -		Префикс адреса для подсети.
		id строка		Идентификатор ресурса.
		name строка		Имя ресурса.
		network_security_group строка		Идентификатор существующей группы безопасности, с которой следует связать подсеть.
		provisioning_state строка		Состояние подготовки ресурса. Пример: Successed
		route_table строка		Ссылка на ресурс таблицы маршрутизации.
		service_endpoints список		Массив точек доступа к услугам.
	tags словарь			Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}

Статус

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

Авторы

Chris Houseknecht (@chouseknecht) <house@redhat.com>
Matt Davis (@nitzmahone) <mdavis@redhat.com>

Подсказка

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

© 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_virtualnetwork_facts_module.html