Spec-Zone.ru › Ansible 2.11

azure.azcollection.azure_rm_virtualnetwork_info – Получение фактов о виртуальной сети

Примечание

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

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

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

Новое в версии 0.0.1: из azure.azcollection

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

Описание

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

Требования

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

  • 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, может использоваться для идентификации идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az 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.
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_info:
    resource_group: myResourceGroup
    name: secgroup001

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

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

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

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

Ключ Возвращаемое значение Описание
azure_virtualnetworks
список / элементы=строка
всегда
Список словарей виртуальных сетей.

Пример:
[{'etag': 'W/"532ba1be-ae71-40f2-9232-3b1d9cf5e37e"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001', 'location': 'eastus2', 'name': 'vnet2001', 'properties': {'addressSpace': {'addressPrefixes': ['10.10.0.0/16']}, 'provisioningState': 'Успешно завершено', 'resourceGuid': 'a7ba285f-f7e7-4e17-992a-de4d39f28612', 'subnets': []}, 'type': 'Microsoft.Network/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
строка
всегда
Состояние подготовки ресурса.

Пример:
Успешно завершено
subnets
список / элементы=строка
всегда
Подсети, связанные с виртуальной сетью.
address_prefix
строка
всегда
Префикс адреса для подсети.

Пример:
10.1.0.0/16
address_prefixes
список / элементы=строка
всегда
Префиксы адресов IPv4 и IPv6 для подсети, вернёт null, если задан только IPv4.

Пример:
['10.1.0.0/16', 'fdda:e69b:2547:485e::/64']
id
строка
всегда
Идентификатор ресурса подсети.

Пример:
/subscriptions/f64d4ee8-be94-457d-ba26-3fa6b6506cef/resourceGroups/v-xisuRG/providers/ Microsoft.Network/virtualNetworks/vnetb57dc95232/subnets/vnetb57dc95232
name
строка
всегда
Имя подсети.

Пример:
vnetb57dc95232
network_security_group
строка
всегда
Существующий идентификатор группы безопасности, который необходимо связать с подсетью.
provisioning_state
строка
всегда
Состояние подготовки подсети.

Пример:
Успешно завершено
route_table
строка
всегда
Ссылка на ресурс таблицы маршрутизации.
service_endpoints
список / элементы=строка
всегда
Массив точек входа служб.

Пример:
[{'locations': ['southeastasia', 'eastasia'], 'service': 'Microsoft.Storage'}]
tags
словарь
всегда
Теги, назначенные ресурсу. Словарь пар «строка:строка».

Пример:
{'tag1': 'abc'}


Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API