azure_rm_virtualnetwork - Управление виртуальными сетями Azure.
Новая версия 2.1.
Обзор
- Создание, обновление или удаление виртуальных сетей. Позволяет устанавливать и обновлять доступные диапазоны адресов IPv4 и устанавливать пользовательские DNS-серверы. Используйте модуль azure_rm_subnet для ассоциации подсетей с виртуальной сетью.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
| address_prefixes_cidr | Значение по умолчанию: None | Список диапазонов адресов IPv4, каждый из которых отформатирован в формате CIDR. Требуется при создании новой виртуальной сети или использовании purge_address_prefixes. псевдонимы: address_prefixes |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags | Значение по умолчанию: yes | Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для использования в процессе аутентификации. auto будет следовать умолчанию по приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификата для Azure-точек конечных устройств. По умолчанию все модули будут проверять сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| dns_servers | Значение по умолчанию: None | Пользовательский список DNS-серверов. Максимальная длина — две. Первый сервер в списке будет рассматриваться как основной сервер. Это явный список. Существующие DNS-серверы будут заменены указанным списком. Используйте параметр purge_dns_servers для удаления всех пользовательских DNS-серверов и возврата к серверам Azure по умолчанию. |
| location | Значение по умолчанию: местоположение группы ресурсов | Действительное местоположение Azure. По умолчанию используется местоположение группы ресурсов. |
| name обязательно | имя виртуальной сети. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| purge_address_prefixes | Значение по умолчанию: no | Используйте с существующим состоянием для удаления любых существующих address_prefixes. |
| purge_dns_servers | Значение по умолчанию: no | Используйте с существующим состоянием для удаления существующих DNS-серверов, возвращаясь к серверам Azure по умолчанию. Взаимоисключающий параметр с dns_servers. |
| resource_group обязательно | имя группы ресурсов. | |
| secret | Значение по умолчанию: None | Секретный ключ клиента Azure. Используется при аутентификации с помощью служебного принципала. |
| state |
| Утвердить состояние виртуальной сети. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | Значение по умолчанию: None | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. |
| tenant | Значение по умолчанию: None | Идентификатор арендатора 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 словарь | всегда | Текущее состояние виртуальной сети. Пример: {'dns_servers': ['127.0.0.1', '127.0.0.3'], 'name': 'my_test_network', 'tags': None, 'provisioning_state': 'Успешно завершено', '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']} |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/azure_rm_virtualnetwork_module.html
