Модуль azure.azcollection.azure_rm_devtestlabvirtualnetwork_info – Получение фактов о виртуальной сети Azure DevTest Lab

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_devtestlabvirtualnetwork_info.

Новое в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке см. на https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, он будет считывать профиль из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате очень важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
lab_name string / required	Название лаборатории DevTest Lab.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string	Название виртуальной сети DevTest Lab.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / required	Название группы ресурсов.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id string	Ваш идентификатор подписки Azure.
tenant string	Идентификатор клиента Azure. Используйте при аутентификации с помощью Сервисного принципала.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью Сервисного принципала. Обязательно, если определен x509_certificate_path.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используйте при аутентификации с помощью Сервисного принципала.

Примечания

Примечание

Для аутентификации в 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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как аутентифицироваться, используя команду az login.

Примеры

- name: Get instance of DevTest Lab Virtual Network
  azure_rm_devtestlabvirtualnetwork_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVirtualNetwork

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

Значения возврата

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

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

Авторы

Zim Kalinowski (@zikalino)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_devtestlabvirtualnetwork_info_module.html