Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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

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

list / elements=string

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

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

adfs_authority_url

string

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

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

api_profile

string

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

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

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

append_tags

boolean

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

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

Варианты:

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

auth_source

string

добавлено в 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

добавлено в 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

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

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

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

disable_instance_discovery

boolean

добавлено в 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 / обязательный

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

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые предоставляют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

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

dictionary

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

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

Чтобы удалить теги, установите для параметра 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.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте 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

list / elements=string

Диапазоны IPv4-адресов виртуальной сети.

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

Пример: ["10.1.0.0/16", "172.100.0.0/16"]

dns_servers

list / elements=string

DNS-серверы.

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

Пример: ["127.0.0.1", "127.0.0.3"]

etag

string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

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

Пример: "W/\"0712e87c-f02f-4bb3-8b9e-2da0390a3886\""

flow_timeout_in_minutes

integer

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

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

Пример: 8

id

string

Идентификатор ресурса.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/ Microsoft.Network/virtualNetworks/myVirtualNetwork"

location

string

Географическое расположение ресурса.

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "my_test_network"

provisioning_state

string

Состояние подготовки виртуальной сети.

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

Пример: "Succeeded"

tags

dictionary

Теги ресурса, например { ‘tags1’:’value1’ }.

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

Пример: {"key1": "value1"}

type

string

Тип ресурса.

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

Пример: "Microsoft.Network/virtualNetworks"

Авторы

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

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

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

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

Spec-Zone.ru

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