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

ad_user

string

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

address_space

dictionary

AddressSpace, содержащий массив диапазонов IP-адресов.

address_prefixes

list / elements=string

Список блоков адресов в нотации CIDR, зарезервированных для этой виртуальной сети.

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_properties

dictionary

Набор свойств BGP.

asn

integer

Номер автономной системы (ASN) узла BGP.

bgp_peering_address

string

Адрес BGP-соседства и идентификатор BGP этого узла BGP.

bgp_peering_addresses

list / elements=dictionary

Адрес BGP-соседства с идентификатором конфигурации IP для шлюза виртуальной сети.

custom_bgp_ip_addresses

list / elements=string

Список пользовательских адресов BGP-соседства, относящихся к конфигурации IP.

default_bgp_ip_addresses

list / elements=string

Список адресов BGP-соседства по умолчанию, относящихся к конфигурации IP.

ipconfiguration_id

string

Идентификатор конфигурации IP, относящейся к шлюзу.

tunnel_ip_addresses

list / elements=string

Список общедоступных IP-адресов туннеля, относящихся к конфигурации IP.

peer_weight

integer

Вес, добавляемый к маршрутам, полученным от этого узла 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"

device_properties

dictionary

Свойства устройства.

device_model

string

Модель устройства.

device_vendor

string

Название производителя устройства.

link_speed_in_mbps

integer

Скорость соединения.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

ip_address

string

IP-адрес VPN-сайта.

is_security_site

boolean

Флаг IsSecuritySite.

Варианты:

• false
• true

location

string

Расположение VpnSite.

log_mode

string

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

log_path

string

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

name

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

Имя VpnSite.

o365_policy

dictionary

Политика Office365.

break_out_categories

dictionary

Категории обхода для Office365.

allow

boolean

Флаг управления категорией разрешения.

Варианты:

• false
• true

default

boolean

Флаг управления категорией по умолчанию.

Варианты:

• false
• true

optimize

boolean

Флаг управления категорией оптимизации.

Варианты:

• false
• true

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

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

secret

string

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

site_key

string

Ключ VPN-сайта, который можно использовать для подключений.

state

string

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

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

dictionary

VirtualWAN, к которому относится vpnSite.

id

string

Идентификатор ресурса связанной виртуальной глобальной сети.

vpn_site_links

list / elements=dictionary

Список всех каналов VPN-сайта.

bgp_properties

dictionary

Набор свойств BGP.

asn

integer

Номер автономной системы (ASN) узла BGP.

bgp_peering_address

string

Адрес BGP-соседства и идентификатор BGP этого узла BGP.

fqdn

string

Полное доменное имя (FQDN) канала VPN-сайта.

ip_address

string

IP-адрес канала VPN-сайта.

link_properties

dictionary

Свойства поставщика канала.

link_provider_name

string

Название поставщика канала связи.

link_speed_in_mbps

integer

Скорость канала связи.

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

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

x509_certificate_path

path

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

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

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

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

state

complex

Текущее состояние VPN-сайта.

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

device_properties

complex

Свойства устройства.

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

device_vendor

string

Название производителя устройства.

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

Пример: "{'link_speed_in_mbps': 0}"

etag

string

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

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

Пример: "8d7415fe-d92c-4331-92ea-460aadfb9648"

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/vpnSites/vpn_site_name"

is_security_site

boolean

Флаг IsSecuritySite.

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

Пример: false

location

string

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

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "vpn_site_name"

provisioning_state

string

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

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

Пример: "Succeeded"

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

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

virtual_wan

complex

Virtual WAN, к которому относится vpnSite.

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

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/virtualWans/virtualwan_name"