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 | |
| adfs_authority_url (добавлен в 2.6) | По умолчанию: null | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
| api_profile (добавлен в 2.5) | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags bool |
| Используется для управления тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. Если тег стандартный, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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) |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| cloud_environment (добавлен в 2.4) | По умолчанию: "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 bool |
| Используйте со значением state present для удаления всех существующих address_prefixes. псевдонимы: purge |
| purge_dns_servers bool |
| Используйте со значением state present для удаления существующих DNS-серверов, возвращаясь к стандартным серверам Azure. Взаимоисключающий с dns_servers. |
| resource_group обязательно | имя группы ресурсов. | |
| secret | Секрет клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| state |
| Утвердите состояние виртуальной сети. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| tags | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant | Идентификатор Azure-аренды. Используйте при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации в 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 в среде.
Примеры
- 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 | всегда | Текущее состояние виртуальной сети. Пример: {'address_prefixes': ['10.1.0.0/16', '172.100.0.0/16'], 'dns_servers': ['127.0.0.1', '127.0.0.3'], 'etag': 'W/"0712e87c-f02f-4bb3-8b9e-2da0390a3886"', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/my_test_network', 'location': 'eastus', 'name': 'my_test_network', 'provisioning_state': 'Succeeded', 'tags': None, 'type': 'Microsoft.Network/virtualNetworks'} |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнером Ansible. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых партнерами Ansible, см. здесь.
Автор
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/azure_rm_virtualnetwork_module.html
