Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.

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

Новая функция в azure.azcollection 0.1.0

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

Обзор

  • Создание, обновление или удаление виртуальных сетей. Позволяет задавать и обновлять доступные диапазоны адресов IPv4 и настраивать пользовательские DNS-серверы. Для ассоциации подсетей с виртуальной сетью используйте модуль azure.azcollection.azure_rm_subnet.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, который выполняет модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

address_prefixes_cidr

aliases: address_prefixes

list / elements=string

Список диапазонов IPv4-адресов, каждый из которых отформатирован с использованием нотации CIDR.

Обязательно при создании новой виртуальной сети или использовании purge_address_prefixes.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть установлена через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, профиль будет считываться из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлена через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлена через переменную окружения AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлена через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

dns_servers

list / elements=string

Пользовательский список DNS-серверов.

Первый сервер в списке будет рассматриваться как основной сервер. Это явный список.

Существующие DNS-серверы будут заменены указанным списком.

Используйте параметр purge_dns_servers, чтобы удалить все пользовательские DNS-серверы и вернуться к серверам Azure по умолчанию.

flow_timeout_in_minutes

integer

Значение FlowTimeout (в минутах) для виртуальной сети.

location

string

Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string / обязательно

Имя виртуальной сети.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

purge_address_prefixes

псевдонимы: purge

boolean

Используется со значением state=present для удаления всех существующих address_prefixes.

Выбори:

  • false ← (по умолчанию)
  • true

purge_dns_servers

boolean

Используется со значением state=present для удаления существующих DNS-серверов, возвращаясь к серверам по умолчанию Azure. Взаимоисключающее с DNS-серверами.

Выбори:

  • false ← (по умолчанию)
  • true

resource_group

string / обязательно

Имя группы ресурсов.

secret

string

Секрет клиента Azure. Используется при аутентификации с принципалом службы.

state

string

Состояние виртуальной сети. Используйте present для создания или обновления и absent для удаления.

Выбори:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные теги объекта будут обновлены любыми предоставленными значениями.

Для удаления тегов установите опцию append_tags в false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток пальца закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с принципалом службы.

Требуется, если определён x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания принципала службы в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации в 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\""

flow_timeout_in_minutes

целое число

Значение FlowTimeout (в минутах) для виртуальной сети.

Возвращается: всегда

Пример: 8

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"

Авторы

  • Крис Хаузенехт (@chouseknecht)
  • Мэтт Дэвис (@nitzmahone)

Ссылки на коллекции

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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