azure_rm_virtualnetwork - Управление виртуальными сетями Azure.
Новая версия с 2.1.
Обзор
- Создание, обновление или удаление виртуальных сетей. Позволяет задавать и обновлять доступные диапазоны адресов IPv4 и устанавливать пользовательские DNS-серверы. Используйте модуль azure_rm_subnet для ассоциации подсетей с виртуальной сетью.
Требования (к хосту, выполняющему модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательный | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| address_prefixes_cidr | нет | Список диапазонов адресов IPv4, каждый из которых отформатирован с использованием CIDR-нотации. Требуется при создании новой виртуальной сети или использовании purge_address_prefixes. псевдонимы: address_prefixes | ||
| append_tags | нет | True | Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через файл профиля учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| dns_servers | нет | Пользовательский список DNS-серверов. Максимальная длина — две. Первый сервер в списке будет рассматриваться как основной. Это явный список. Существующие DNS-серверы будут заменены указанным списком. Используйте параметр purge_dns_servers для удаления всех пользовательских DNS-серверов и возврата к стандартным серверам Azure. | ||
| location | нет | местоположение группы ресурсов | Допустимое местоположение Azure. По умолчанию — местоположение группы ресурсов. | |
| name | да | Имя виртуальной сети. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| purge_address_prefixes | нет | Используется с состоянием present для удаления любых существующих address_prefixes. | ||
| purge_dns_servers | нет | Используется с состоянием present для удаления существующих DNS-серверов, возвращаясь к стандартным серверам Azure. Несовместим с dns_servers. | ||
| resource_group | да | Имя группы ресурсов. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| state | нет | present |
| Утверждение состояния виртуальной сети. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | нет | Идентификатор вашей подписки Azure. | ||
| tags | нет | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | ||
| tenant | нет | Идентификатор арендатора Azure. Используется при аутентификации с принципалом службы. |
Примеры
- name: Create a virtual network
azure_rm_virtualnetwork:
name: foobar
resource_group: Testing
address_prefixes_cidr:
- "10.1.0.0/16"
- "172.100.0.0/16"
dns_servers:
- "127.0.0.1"
- "127.0.0.2"
tags:
testing: testing
delete: on-exit
- name: Delete a virtual network
azure_rm_virtualnetwork:
name: foobar
resource_group: Testing
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| state | Текущее состояние виртуальной сети. | всегда | dict | {'dns_servers': ['127.0.0.1', '127.0.0.3'], 'name': 'my_test_network', 'tags': None, 'provisioning_state': 'Succeeded', 'etag': 'W/"0712e87c-f02f-4bb3-8b9e-2da0390a3886"', 'location': 'eastus', 'type': 'Microsoft.Network/virtualNetworks', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/my_test_network', 'address_prefixes': ['10.1.0.0/16', '172.100.0.0/16']} |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в файле ~/.azure/credentials. Аутентификация возможна с использованием принципала службы или пользователя 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 в среде.
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вам это интересно, прочитайте Информация сообщества и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_virtualnetwork_module.html
