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

Примечание

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

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

Для использования в книге задач укажите: 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 of azure.azcollection		URL-адрес полномочий Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля, и у вас есть собственный ADFS-центр полномочий.
api_profile строка добавлен в 0.0.1 of azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево	Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом поле любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 of azure.azcollection	Варианты: auto ← 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 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен с помощью профиля файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с служебным принципалом.
cloud_environment строка добавлен в 0.0.1 of 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 servers.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с служебным принципалом.
state строка	Варианты: отсутствует есть ←	Состояние виртуальной сети. Используйте `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 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 строка	всегда	Состояние подготовки виртуальной сети. Пример: Выполнено
	tags словарь	всегда	Теги ресурса, такие как { 'tags1':'value1' }. Пример: {'key1': 'value1'}
	type строка	всегда	Тип ресурса. Пример: Microsoft.Network/virtualNetworks

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_virtualnetwork_module.html