Модуль azure.azcollection.azure_rm_virtualnetworkgatewayconnection — управление подключением шлюза виртуальной сети Azure в группе ресурсов

ad_user

string

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

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; в противном случае будет использоваться подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

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

Варианты:

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

authorization_key

string

Ключ авторизации.

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"

connection_protocol

string

Протокол подключения, используемый для этого соединения.

Варианты:

• "IKEv2"
• "IKEv1"

connection_type

string

Тип подключения шлюза.

Варианты:

• "IPsec"
• "Vnet2Vnet"
• "ExpressRoute"
• "VPNClient"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

dpd_timeout_seconds

integer

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

enable_bgp

boolean

Флаг EnableBgp.

Варианты:

• false
• true

express_route_gateway_bypass

boolean

Обход шлюза ExpressRoute для пересылки данных.

Варианты:

• false
• true

local_network_gateway2

string

Ссылка на ресурс шлюза локальной сети.

location

string

Расположение подключения сетевого шлюза.

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.

resource_group

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

Группа ресурсов подключения сетевого шлюза.

routing_weight

integer

Вес маршрутизации.

secret

string

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

shared_key

string

Общий ключ IPSec.

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.

use_local_azure_ip_address

boolean

Использовать для подключения частный локальный IP-адрес Azure.

Варианты:

• false
• true

use_policy_based_traffic_selectors

boolean

Включить селекторы трафика на основе политик.

Варианты:

• false
• true

virtual_network_gateway1

string

Ссылка на ресурс шлюза виртуальной сети.

virtual_network_gateway2

string

Ссылка на ресурс шлюза виртуальной сети.

x509_certificate_path

path

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

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

Сертификат необходимо добавить в конец файла закрытого ключа.

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

state

complex

Текущее состояние ресурса Azure Local Network Gateway.

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

authorization_key

string

Ключ авторизации.

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

Пример: "308201E806092A864********************78B9FADDAC2D"

connection_mode

string

Режим подключения для этого соединения.

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

Пример: "Default"

connection_protocol

string

Протокол подключения, используемый для этого соединения.

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

Пример: "IKEv2"

connection_type

string

Тип подключения шлюза.

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

Пример: "Vnet2Vnet"

dpd_timeout_seconds

integer

Тайм-аут обнаружения недоступности узла для этого соединения в секундах.

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

Пример: 45

enable_bgp

boolean

Флаг EnableBgp.

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

Пример: false

etag

string

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

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

Пример: "58b6f0c2-7d7c-4666-a62e-6416b4e00c83"

express_route_gateway_bypass

boolean

Обход шлюза ExpressRoute для пересылки данных.

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

Пример: false

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/connections/fredvnet"

ipsec_policies

list / elements=string

Политики IPSec, учитываемые этим соединением.

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

Пример: []

local_network_gateway2

complex

Ссылка на ресурс шлюза локальной сети.

Возвращается: при использовании

id

string

Идентификатор ресурса шлюза локальной сети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/localNetworkGateways/rpfx001"

location

string

Расположение ресурса.

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "fredvnetconnection"

provisioning_state

string

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

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

Пример: "Succeeded"

resource_group

string

Группа ресурсов подключения шлюза виртуальной сети.

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

Пример: "rg"

routing_weight

integer

Вес маршрутизации.

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

Пример: 0

shared_key

string

Общий ключ IPSec.

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

tags

dictionary

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

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

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

traffic_selector_policies

list / elements=string

Политики селекторов трафика, учитываемые этим соединением.

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

Пример: []

use_local_azure_ip_address

boolean

Использовать для соединения частный локальный IP-адрес Azure.

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

Пример: false

use_policy_based_traffic_selectors

boolean

Включить селекторы трафика на основе политик.

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

Пример: false

virtual_network_gateway1

complex

Ссылка на ресурс шлюза виртуальной сети.

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

id

string

Идентификатор ресурса шлюза виртуальной сети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng"

virtual_network_gateway2

complex

Ссылка на ресурс шлюза виртуальной сети.

Возвращается: при использовании

id

string

Идентификатор ресурса шлюза виртуальной сети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng02"