community.azure.azure_rm_devtestlabvirtualnetwork_facts – Получение фактов о виртуальной сети Azure DevTest Lab

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_devtestlabvirtualnetwork_facts

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

Обзор

Получение фактов о виртуальной сети Azure DevTest Lab.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection		URL-адрес службы авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой авторизации ADFS.
api_profile строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack.
auth_source строка добавлено в 0.0.1 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 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.
cloud_environment строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment` или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`
lab_name строка / обязательно		Имя лаборатории DevTest Lab.
name строка		Имя виртуальной сети DevTest Lab.
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: Get instance of DevTest Lab Virtual Network
  community.azure.azure_rm_devtestlabvirtualnetwork_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVirtualNetwork

- name: List all Virtual Networks in DevTest Lab
  community.azure.azure_rm_devtestlabvirtualnetwork_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVirtualNetwork

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

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

Ключ		Возвращаемое	Описание
virtualnetworks сложный		всегда	Список словарей, содержащих данные о виртуальной сети DevTest Lab.
	description строка	всегда	Описание виртуальной сети. Пример: Моя виртуальная сеть
	external_provider_resource_id строка	всегда	Идентификатор внешней виртуальной сети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork
	id строка	всегда	Идентификатор виртуальной сети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualnetworks/myVirtualNetwork
	lab_name строка	всегда	Имя лаборатории. Пример: myLab
	name строка	всегда	Имя виртуальной сети. Пример: myVirtualNetwork
	provisioning_state строка	всегда	Состояние подготовки виртуальной сети. Пример: Успешно
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup

Авторы

Zim Kalinowski (@zikalino)

© 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/community/azure/azure_rm_devtestlabvirtualnetwork_facts_module.html