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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_virtualhubconnection.

Добавлено в azure.azcollection 1.14.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, а не субъекта-службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.
allow_hub_to_remote_vnet_transit логический	(Устарело) Определяет, включен ли транзит от VirtualHub к RemoteVnet. Этот параметр устарел и игнорируется службой. Он будет удалён в следующем основном выпуске. Варианты: `false` `true`
allow_remote_vnet_to_use_hub_vnet_gateways логический	(Устарело) Разрешает RemoteVnet использовать шлюзы Virtual Hub. Этот параметр устарел и игнорируется службой. Он будет удалён в следующем основном выпуске. Варианты: `false` `true`
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
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"`
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_internet_security логический	Включить интернет-безопасность. Варианты: `false` `true`
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка / обязательный	Имя подключения VirtualHub.
oidc_token строка добавлено в 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 путь добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN_FILE`.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile строка	Профиль безопасности из файла ~/.azure/credentials.
remote_virtual_network словарь	Идентификатор удалённой виртуальной сети (VNet), к которой нужно подключиться.
id строка	Идентификатор удалённой виртуальной сети.
resource_group строка / обязательный	Имя группы ресурсов VirtualHub.
routing_configuration словарь	Конфигурация маршрутизации, определяющая связанные и распространяемые таблицы маршрутизации для этого подключения.
propagated_route_tables словарь	Список таблиц маршрутизации, которым следует объявлять маршруты.
ids список / элементы=словарь	-Список идентификаторов ресурсов всех таблиц маршрутизации виртуального концентратора.
id строка	Идентификатор таблиц маршрутизации.
labels список / элементы=строка	Список меток.
vnet_routes словарь	Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение виртуальной сети.
static_routes список / элементы=словарь	Список всех статических маршрутов.
address_prefixes список / элементы=строка	Список всех префиксов адресов.
name строка	Имя StaticRoute, уникальное в пределах VnetRoute.
next_hop_ip_address строка	IP-адрес следующего перехода.
secret строка	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
state строка	Задаёт требуемое состояние подключения VirtualHub. Используйте `present` для создания или обновления подключения VirtualHub и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Идентификатор вашей подписки Azure.
tenant строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path.
vhub_name строка / обязательный	Имя VirtualHub.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен после закрытого ключа. Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, задать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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 virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    enable_internet_security: false
    remote_virtual_network:
      id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet
    routing_configuration:
      propagated_route_tables:
        labels:
          - labels1
          - labels3
        ids:
          - id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub01/hubRouteTables/testtable
      vnet_routes:
        static_routes:
          - name: route1
            address_prefixes:
              - 10.1.0.0/16
              - 10.2.0.0/16
            next_hop_ip_address: 10.0.0.68
          - name: route2
            address_prefixes:
              - 10.4.0.0/16
            next_hop_ip_address: 10.0.0.65

- name: Delete virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    state: absent

Возвращаемые значения

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

Ключ	Описание
state complex	Список словарей с информацией о подключении виртуального концентратора. Возвращается: всегда
allow_hub_to_remote_vnet_transit boolean	(Устарело) Включает транзитный трафик от концентратора к удаленной VNet. Это поле устарело и будет удалено в следующем выпуске основной версии. Возвращается: всегда Пример: `true`
allow_remote_vnet_to_use_hub_vnet_gateways boolean	(Устарело) Разрешает удаленной VNet использовать шлюзы VNet концентратора. Это поле устарело и будет удалено в следующем выпуске основной версии. Возвращается: всегда Пример: `true`
enable_internet_security boolean	Включает защиту в Интернете; по умолчанию она включена. Возвращается: всегда Пример: `true`
etag string	Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: `"31102041-49e7-4cac-8573-aac1e1a16793"`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/vhub/hubVirtualNetworkConnections/MyConnection"`
name string	Имя ресурса. Возвращается: всегда Пример: `"MyConnection"`
provisioning_state string	Состояние подготовки ресурса подключения виртуального концентратора. Возвращается: всегда Пример: `"Succeeded"`
remote_virtual_network complex	Имя или идентификатор удаленной VNet, к которой выполняется подключение. Возвращается: всегда
id string	Идентификатор удаленной VNet, к которой выполняется подключение. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet"`
routing_configuration complex	Сведения о конфигурации маршрутизации. Возвращается: всегда
associated_route_table complex	Идентификатор ресурса таблицы маршрутизации, связанной с этой конфигурацией маршрутизации. Возвращается: всегда
id string	Идентификатор таблицы маршрутизации. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"`
propagated_route_tables complex	Список идентификаторов ресурсов таблиц маршрутизации, разделенных пробелами, для которых выполняется распространение маршрутов. Возвращается: всегда
ids list / elements=string	Список идентификаторов ресурсов таблиц маршрутизации, для которых выполняется распространение маршрутов. Возвращается: всегда Пример: `[{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"}]`
labels list / elements=string	Список меток таблиц маршрутизации, для которых выполняется распространение маршрутов, разделенных пробелами. Возвращается: всегда Пример: `["labels1", "labels2"]`
vnet_routes complex	Имя статического маршрута, уникальное в пределах маршрутов VNet. Возвращается: всегда
static_routes list / elements=string	Имя статического маршрута. Возвращается: всегда
address_prefixes list / elements=string	Список всех префиксов адресов, разделенных пробелами. Возвращается: всегда Пример: `["10.1.0.0/16", "10.2.0.0/16"]`
name string	Имя статического маршрута. Возвращается: всегда Пример: `"route1"`
next_hop_ip_address string	IP-адрес следующего узла. Возвращается: всегда Пример: `"10.0.0.65"`

Авторы

Fred-Sun (@Fred-Sun)
Xu Zhang (@xuzhang3)

Ссылки коллекции

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