Spec-Zone.ru › Ansible 2.9

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

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

Описание

  • Создание, обновление или удаление виртуальных сетей. Позволяет задавать и обновлять доступные диапазоны адресов 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
булево
    Варианты:
  • нет ←
  • да
Используется со значением state=present для удаления любых существующих address_prefixes.

псевдонимы: purge
purge_dns_servers
булево
    Варианты:
  • нет ←
  • да
Используется со значением state=present для удаления существующих DNS-серверов, возвращаясь к стандартным серверам Azure. Взаимоисключительно с DNS-серверами.
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
сложное
всегда
Текущее состояние виртуальной сети.
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':'значение1' }

Пример:
{'ключ1': 'значение1'}
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.9/modules/azure_rm_virtualnetwork_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API