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

ad_user

string

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

address_prefix

string

Префикс адреса для этого VirtualHub.

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"

azure_firewall

dictionary

Azure Firewall, связанный с этим VirtualHub.

id

string

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

bgp_connections

list / elements=dictionary

Список ссылок на подключения BGP.

id

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"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

enable_virtual_router_route_propogation

boolean

Флаг управления распространением маршрутов для VirtualRouter hub.

Варианты:

• false
• true

express_route_gateway

dictionary

ExpressRoute Gateway, связанный с этим VirtualHub.

id

string

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

ip_configurations

list / elements=dictionary

Список ссылок на конфигурации IP.

id

string

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

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя VirtualHub.

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.

p2_s_vpn_gateway

dictionary

P2SVpnGateway, связанный с этим VirtualHub.

id

string

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

password

string

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

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

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

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

route_table

dictionary

Таблица маршрутов, связанная с этим виртуальным концентратором.

routes

list / elements=dictionary

Список всех маршрутов.

address_prefixes

list / elements=string

Список всех префиксов адресов.

next_hop_ip_address

string

IP-адрес следующего перехода.

secret

string

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

security_partner_provider

dictionary

Поставщик-партнер по безопасности, связанный с этим VirtualHub.

id

string

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

security_provider_name

string

Имя поставщика средств безопасности.

sku

string

Артикул этого VirtualHub.

state

string

Укажите требуемое состояние VirtualHub.

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

list / elements=dictionary

Список всех таблиц маршрутизации виртуального концентратора версии 2, связанных с этим VirtualHub.

attached_connections

list / elements=string

Список всех подключений, присоединенных к этой таблице маршрутизации версии 2.

name

string

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

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

routes

list / elements=dictionary

Список всех маршрутов.

destination_type

string

Тип назначений.

destinations

list / elements=string

Список всех назначений.

next_hop_type

string

Тип следующих переходов.

next_hops

list / elements=string

IP-адреса следующих переходов.

virtual_router_asn

integer

Номер автономной системы VirtualRouter.

virtual_router_ips

list / elements=string

IP-адреса VirtualRouter.

virtual_wan

dictionary

VirtualWAN, которому принадлежит VirtualHub.

id

string

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

vpn_gateway

dictionary

VpnGateway, связанный с этим VirtualHub.

id

string

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

x509_certificate_path

path

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

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

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

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

state

complex

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

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

address_prefix

string

Префикс адреса этого VirtualHub.

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

Пример: "10.2.0.0/24"

azure_firewall

complex

AzureFirewall, связанный с этим VirtualHub.

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

id

string

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

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

bgp_connections

list / elements=string

Список ссылок на подключения BGP.

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

id

string

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

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

enable_virtual_router_route_propogation

boolean

Флаг управления распространением маршрутов для концентратора VirtualRouter.

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

etag

string

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

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

Пример: "cf8c0b06-d339-4155-95fd-2a363945cce4"

express_route_gateway

dictionary

ExpressRouteGateway, связанный с этим VirtualHub.

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

id

string

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

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

id

string

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

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

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

ip_configurations

list / elements=string

Список ссылок на IpConfigurations.

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

id

string

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

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

location

string

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

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "my_virtual_hub_name"

p2_s_vpn_gateway

complex

P2SVpnGateway, связанный с этим VirtualHub.

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

id

string

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

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

provisioning_state

string

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

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

Пример: "Succeeded"

route_table

complex

RouteTable, связанная с этим виртуальным концентратором.

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

routes

list / elements=string

Список всех маршрутов.

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

address_prefixes

list / elements=string

Список всех префиксов адресов.

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

next_hop_ip_address

string

IP-адрес следующего перехода.

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

routing_state

string

Состояние маршрутизации.

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

Пример: "Standard"

security_partner_provider

complex

SecurityPartnerProvider, связанный с этим VirtualHub.

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

id

string

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

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

security_provider_name

string

Имя поставщика служб безопасности.

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

sku

string

SKU этого VirtualHub.

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

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

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

virtual_hub_route_table_v2_s

complex

Список всех таблиц маршрутизации виртуального концентратора версии 2, связанных с этим VirtualHub.

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

attached_connections

list / elements=string

Список всех подключений, присоединённых к этой таблице маршрутизации версии 2.

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

name

string

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

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

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

routes

list / elements=string

Список всех маршрутов.

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

destination_type

string

Тип назначения.

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

destinations

list / elements=string

Список всех назначений.

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

next_hop_type

string

Тип следующих переходов.

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

next_hops

list / elements=string

IP-адреса следующих переходов.

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

virtual_router_asn

integer

ASN VirtualRouter.

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

virtual_router_ips

list / elements=string

IP-адреса VirtualRouter.

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

virtual_wan

complex

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

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

id

string

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

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

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

vpn_gateway

complex

VpnGateway, связанный с этим VirtualHub.

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

id

string

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

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