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

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

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

Обзор

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

Требования

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

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 строка		ID клиента Azure. Используется при аутентификации со служебным принципалом.
cloud_environment строка добавлен в 2.4	По умолчанию: "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
  azure_rm_devtestlabvirtualnetwork_facts:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVirtualNetwork

- name: List all Virtual Networks in DevTest Lab
  azure_rm_devtestlabvirtualnetwork_facts:
    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

Статус

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

Авторы

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.8/modules/azure_rm_devtestlabvirtualnetwork_facts_module.html