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		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile строка добавлено в 2.5	По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение	Варианты: нет да ←	Используется для управления тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. При стандартном значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто cli credential_file env msi	Управляет источником используемых учетных данных для аутентификации. Если не указано, используется переменная среды 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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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 логическое значение	Варианты: нет ← да	Используется со значением состояния present для удаления всех существующих address_prefixes. псевдонимы: purge
purge_dns_servers логическое значение	Варианты: нет ← да	Используется со значением состояния present для удаления существующих DNS-серверов, возвращаясь к стандартным Azure-серверам. Взаимоисключающий параметр с dns_servers.
resource_group - / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
state -	Варианты: absent present ←	Утверждает состояние виртуальной сети. Используйте `present` для создания или обновления и `absent` для удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
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: Create a virtual network
  azure_rm_virtualnetwork:
    resource_group: myResourceGroup
    name: myVirtualNetwork
    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:
    resource_group: myResourceGroup
    name: myVirtualNetwork
    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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork', 'location': 'eastus', 'name': 'my_test_network', 'provisioning_state': 'Succeeded', 'tags': None, 'type': 'Microsoft.Network/virtualNetworks'}

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/azure_rm_virtualnetwork_module.html