azure.azcollection.azure_rm_virtualnetwork – Управление виртуальными сетями Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_virtualnetwork.

Новое в версии 0.1.0: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Создание, обновление или удаление виртуальных сетей. Позволяет устанавливать и обновлять доступные диапазоны адресов 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 строка добавлено в 0.0.1 от azure.azcollection		URL-адрес службы авторизации Azure AD. Используется при аутентификации с использованием имени пользователя/пароля и собственной службой авторизации ADFS.
api_profile строка добавлено в 0.0.1 от azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево	Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляет теги к существующим. В случае канонического, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 от azure.azcollection	Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в значение `auto` (по умолчанию) приоритет имеет следующие параметры: параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды. При установке в `credential_file`, он будет считывать профиль из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько; иначе используется по умолчанию подписка из Azure CLI. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, иначе выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 от azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 от azure.azcollection	По умолчанию: "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 булево	Варианты: нет ← да	Используйте с state=present для удаления всех существующих address_prefixes. псевдонимы: purge
purge_dns_servers булево	Варианты: нет ← да	Используйте с state=present для удаления существующих DNS-серверов, вернувшись к стандартным Azure-серверам. Взаимоисключающее с DNS-серверами.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
state строка	Варианты: absent present ←	Состояние виртуальной сети. Используйте `present` для создания или обновления, и `absent` для удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти перед выполнением задач или playbook с 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 complex		всегда	Текущее состояние виртуальной сети.
	address_prefixes список / элементы=строка	всегда	Диапазоны адресов IPv4 виртуальной сети. Пример: ['10.1.0.0/16', '172.100.0.0/16']
	dns_servers список / элементы=строка	всегда	DNS-серверы. Пример: ['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 словарь	всегда	Теги ресурса, такие как { 'tags1':'value1' }. Пример: {'key1': 'value1'}
	type строка	всегда	Тип ресурса. Пример: Microsoft.Network/virtualNetworks

Авторы

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.10/collections/azure/azcollection/azure_rm_virtualnetwork_module.html