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 boolean |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| 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 boolean |
| Используется со значением state present для удаления всех существующих address_prefixes. Псевдонимы: purge |
| purge_dns_servers boolean |
| Используется со значением 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 словарь | всегда | Текущее состояние виртуальной сети. Пример: {'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. [сертифицировано]
Авторы
- 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.7/modules/azure_rm_virtualnetwork_module.html
