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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в playbook укажите: azure.azcollection.azure_rm_virtualhub.

Новая версия в azure.azcollection 1.10.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и удаление экземпляра Azure VirtualHub.

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
address_prefix строка	Префикс адреса для этой VirtualHub.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags логическое значение	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В случае канонического значения теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлен в 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"`
azure_firewall словарь	AzureFirewall, связанный с этой VirtualHub.
id строка	Идентификатор ресурса.
bgp_connections список / элементы=словарь	Список ссылок на Bgp Connections.
id строка	Идентификатор ресурса.
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управление поведением проверки сертификата для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с принципалом службы или управляемой идентичностью (msi). Также может быть задано через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логическое значение добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит обнаружение экземпляра и проверку авторитета. Эта функция предназначена для использования в сценариях, где точка доступа к метаданным недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных авторитета с https://login.microsoft.com/ для проверки авторитета. Установив это значение в True, отключение проверки авторитета. В результате, необходимо убедиться, что указанный хост авторитета является действительным и надёжным. Настраивается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
enable_virtual_router_route_propogation логическое значение	Флаг для управления распространением маршрутов для VirtualRouter hub. Варианты: `false` `true`

express_route_gateway словарь	Шлюз ExpressRoute, связанный с этим VirtualHub.
id строка	Идентификатор ресурса.
ip_configurations список / элементы=словарь	Список ссылок на IpConfigurations.
id строка	Идентификатор ресурса.
location строка	Расположение VirtualHub.
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка / обязательно	Имя VirtualHub.
p2_s_vpn_gateway словарь	P2SVpnGateway, связанный с этим VirtualHub.
id строка	Идентификатор ресурса.
password строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов VirtualHub.
route_table словарь	Таблица маршрутизации, связанная с этим виртуальным шлюзом.
routes список / элементы=словарь	Список всех маршрутов.
address_prefixes список / элементы=строка	Список всех префиксов адресов.
next_hop_ip_address строка	Следующий IP-адрес узла.
secret строка	Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
security_partner_provider словарь	SecurityPartnerProvider, связанный с этим VirtualHub.
id строка	Идентификатор ресурса.
security_provider_name строка	Имя поставщика безопасности.
sku строка	SKU этого VirtualHub.
state строка	Установите состояние VirtualHub. Используйте `present` для создания или обновления VirtualHub и `absent` для его удаления. Выбоpы: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы.

thumbprint string added in azure.azcollection 1.14.0	Отпечаток хэш-суммы закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определен параметр x509_certificate_path.
virtual_hub_route_table_v2_s list / elements=dictionary	Список всех таблиц маршрутизации v2 виртуального шлюза, связанных с этим VirtualHub.
attached_connections list / elements=string	Список всех подключений, присоединенных к этой таблице маршрутизации v2.
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	ASN виртуального маршрутизатора.
virtual_router_ips list / elements=string	IP-адреса виртуального маршрутизатора.
virtual_wan dictionary	VirtualWAN, к которому принадлежит VirtualHub.
id string	Идентификатор ресурса.
vpn_gateway dictionary	VpnGateway, связанный с этим VirtualHub.
id string	Идентификатор ресурса.
x509_certificate_path path added in azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть прикреплен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или плейбука с помощью az login.
Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
Для аутентификации через служебного принципала передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это ini файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как аутентифицироваться с помощью команды az login.

Примеры

- name: Create a VirtualHub
  azure_rm_virtualhub:
    resource_group: myResourceGroup
    name: my_virtual_hub_name
    address_prefix: 10.2.0.0/24
    sku: Standard
    location: eastus
    enable_virtual_router_route_propogation: false
    virtual_wan:
      id: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan

- name: Delete VirtualHub
  azure_rm_virtualhub:
    resource_group: myResourceGroup
    name: my_virtual_hub_name
    location: eastus
    state: absent

Значения возврата

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

Ключ	Описание
state сложный	Текущее состояние виртуального концентратора. Возвращается: всегда
address_prefix строка	Префикс адреса для этого виртуального концентратора. Возвращается: всегда Пример: `"10.2.0.0/24"`
azure_firewall сложный	AzureFirewall, связанный с этим виртуальным концентратором. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда
bgp_connections список / элементы=строка	Список ссылок на Bgp Connections. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда
enable_virtual_router_route_propogation булево	Флаг для управления распространением маршрутов для виртуального маршрутизатора. Возвращается: всегда
etag строка	Уникальная неизменяемая строка, которая меняется всякий раз, когда ресурс обновляется. Возвращается: всегда Пример: `"cf8c0b06-d339-4155-95fd-2a363945cce4"`
express_route_gateway словарь	ExpressRouteGateway, связанный с этим виртуальным концентратором. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/my_virtual_hub_name"`
ip_configurations список / элементы=строка	Список ссылок на IpConfigurations. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда
location строка	Расположение ресурса. Возвращается: всегда Пример: `"eastus"`
name строка	Имя ресурса. Возвращается: всегда Пример: `"my_virtual_hub_name"`
p2_s_vpn_gateway сложный	P2SVpnGateway, связанный с этим виртуальным концентратором. Возвращается: всегда
id строка	Идентификатор ресурса. Возвращается: всегда
provisioning_state строка	Состояние подготовки виртуального концентратора. Возвращается: всегда Пример: `"Succeeded"`
route_table сложный	RouteTable, связанная с этим виртуальным концентратором. Возвращается: всегда
routes список / элементы=строка	Список всех маршрутов. Возвращается: всегда

address_prefixes list / elements=string	Список всех addressPrefixes. Возвращается: всегда
next_hop_ip_address string	IP-адрес NextHop. Возвращается: всегда
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	Список всех таблиц маршрутизации виртуальных концентраторов v2, связанных с этим VirtualHub. Возвращается: всегда
attached_connections list / elements=string	Список всех подключений, присоединенных к этой таблице маршрутизации v2. Возвращается: всегда
name string	Имя ресурса, которое является уникальным в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда
routes list / elements=string	Список всех маршрутов. Возвращается: всегда
destination_type string	Тип назначений. Возвращается: всегда
destinations list / elements=string	Список всех назначений. Возвращается: всегда
next_hop_type string	Тип следующих переходов. Возвращается: всегда
next_hops list / elements=string	IP-адреса NextHops. Возвращается: всегда
virtual_router_asn integer	ASN виртуального маршрутизатора. Возвращается: всегда
virtual_router_ips list / elements=string	IP-адреса виртуального маршрутизатора. Возвращается: всегда
virtual_wan complex	VirtualWAN, к которому принадлежит VirtualHub. Возвращается: всегда

id string	Идентификатор ресурса. Возвращаемое значение: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan"`
vpn_gateway complex	VpnGateway, связанный с этим VirtualHub. Возвращаемое значение: всегда
id string	Идентификатор ресурса. Возвращаемое значение: всегда

Авторы

Fred-Sun (@Fred-Sun)
Haiyuan Zhang (@haiyuazhang)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_virtualhub_module.html