модуль azure.azcollection.azure_rm_virtualnetworkgateway — управление шлюзами виртуальных сетей 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; в противном случае будет использоваться подписка az cli по умолчанию.

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

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

Варианты:

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

bgp_settings

dictionary

Параметры BGP-спикера шлюза виртуальной сети.

asn

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

Номер автономной системы (ASN) BGP-спикера.

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

enable_bgp

boolean

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

Варианты:

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

gateway_type

string

Тип этого шлюза виртуальной сети.

Варианты:

• "vpn" ← (по умолчанию)
• "express_route"

ip_configurations

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

Список конфигураций IP-адресов.

name

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

Имя конфигурации IP-адреса.

private_ip_allocation_method

string

Метод выделения частного IP-адреса.

Варианты:

• "Dynamic" ← (по умолчанию)
• "Static"

public_ip_address_name

string

Имя общедоступного IP-адреса. Укажите «None», чтобы отключить общедоступный IP-адрес.

subnet

string

Идентификатор подсети шлюза для VPN.

location

string

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

log_mode

string

Аргумент родительского модуля.

log_path

string

Аргумент родительского модуля.

name

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

Имя VPN-шлюза.

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

Имя группы ресурсов, в которой находится или будет создан VPN-шлюз.

secret

string

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

sku

string

Ссылка на ресурс VirtualNetworkGatewaySku, представляющий выбранный SKU шлюза виртуальной сети.

Варианты:

• "VpnGw1"
• "VpnGw2"
• "VpnGw3"
• "Standard"
• "Basic"
• "HighPerformance"
• "VpnGw1AZ" ← (по умолчанию)
• "VpnGw2AZ"
• "VpnGw3AZ"
• "VpnGw4AZ"
• "VpnGw5AZ"
• "ErGw1AZ"
• "ErGw2AZ"
• "ErGw3AZ"
• "ErGwScale"

state

string

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

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

any

Существующая виртуальная сеть, с которой будет связан VPN-шлюз.

Обязателен при создании VPN-шлюза.

Может быть именем виртуальной сети.

Если указано имя, сеть должна находиться в той же группе ресурсов, что и VPN-шлюз.

Может быть идентификатором ресурса виртуальной сети.

Может быть словарем, содержащим name и resource_group виртуальной сети.

Обязателен при создании.

vpn_gateway_generation

string

Поколение этого VirtualNetworkGateway. Должно быть равно None, если gateway_type не является VPN.

Варианты:

• "None"
• "Generation1" ← (по умолчанию)
• "Generation2"

vpn_type

string

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

Варианты:

• "route_based" ← (по умолчанию)
• "policy_based"

x509_certificate_path

path

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

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

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

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

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway"