Модуль azure.azcollection.azure_rm_virtualwan — управление экземпляром Azure VirtualWan

ad_user

string

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

adfs_authority_url

string

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

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

allow_branch_to_branch_traffic

boolean

Значение True, если разрешен трафик между филиалами.

Варианты:

• false
• true

allow_vnet_to_vnet_traffic

boolean

True, если разрешен трафик между виртуальными сетями VNet.

Варианты:

• false
• true

api_profile

string

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

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

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

append_tags

boolean

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

В каноническом режиме все теги, отсутствующие в параметре 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

disable_vpn_encryption

boolean

Определяет, отключено ли шифрование VPN.

Варианты:

• false
• true

location

string

Расположение виртуальной глобальной сети WAN.

log_mode

string

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

log_path

string

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

name

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

Имя получаемой VirtualWAN.

office365_local_breakout_category

string

Указывает категорию локального выхода Office365.

Значение по умолчанию — None.

Варианты:

• "Optimize"
• "OptimizeAndAllow"
• "All"
• "None"

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.

resource_group

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

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

secret

string

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

state

string

Задает требуемое состояние VirtualWan.

Используйте present для создания или обновления VirtualWan и 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.

virtual_hubs

list / элементы=dictionary

Список VirtualHubs в VirtualWAN.

id

string

Идентификатор ресурса виртуального концентратора.

virtual_wan_type

string

Тип VirtualWAN.

Варианты:

• "Basic"
• "Standard"

vpn_sites

list / элементы=dictionary

Список VpnSites в VirtualWAN.

id

string

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

x509_certificate_path

path

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

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

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

Используйте при аутентификации с помощью субъекта-службы.

state

complex

Текущее состояние виртуальной глобальной сети.

Возвращается: при успешном выполнении

allow_branch_to_branch_traffic

boolean

True, если разрешён обмен трафиком между филиалами.

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

Пример: true

allow_vnet_to_vnet_traffic

boolean

True, если разрешён обмен трафиком между виртуальными сетями.

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

Пример: true

disable_vpn_encryption

boolean

Отключено ли шифрование VPN.

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

Пример: true

etag

string

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

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

Пример: "52def36b-84b6-49aa-a825-16ba167fc559"

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/virtual_wan_name"

location

string

Расположение ресурса виртуальной глобальной сети.

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "virtualwanb57dc9555691"

office365_local_breakout_category

string

Категория локального прямого доступа к Office 365.

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

Пример: "None"

provisioning_state

string

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

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

Пример: "Succeeded"

tags

dictionary

Теги ресурса.

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

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

type

string

Тип ресурса.

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

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

virtual_hubs

complex

Список виртуальных концентраторов в виртуальной глобальной сети.

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

id

string

Идентификатор виртуальных концентраторов.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/test"

virtual_wan_type

string

Тип виртуальной глобальной сети.

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

Пример: "Standard"

vpn_sites

list / elements=string

Список VPN-сайтов в виртуальной глобальной сети.

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

id

string

Идентификатор ресурса VPN-сайтов.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/resource_group/providers/Microsoft.Network/vpnSites/test1"