Модуль azure.azcollection.azure_rm_route — Управление ресурсом маршрутизации Azure
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_route.
Добавлен в azure.azcollection 0.1.2
Описание
- Создание, обновление или удаление маршрута.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
address_prefix string | Целевой CIDR, к которому применяется маршрут. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в отношении Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя маршрута. |
next_hop_ip_address string | IP-адрес, на который должны пересылаться пакеты. Значения следующего перехода разрешены только в маршрутах, где тип следующего перехода — VirtualAppliance. |
next_hop_type string | Тип перехода Azure, на который должен быть отправлен пакет. Choices:
|
пароль строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. |
группа_ресурсов строка / обязательно | Имя группы ресурсов. |
имя_таблицы_маршрутизации строка / обязательно | Имя таблицы маршрутизации. |
секрет строка | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. |
состояние строка | Установить состояние маршрута. Используйте Варианты:
|
идентификатор_подписки строка | Ваш идентификатор подписки Azure. |
метки словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены всеми предоставленными значениями. Для удаления меток установите опцию append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах. |
арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью служебного принципала. |
отпечаток строка добавлен в azure.azcollection 1.14.0 | Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью служебного принципала. Требуется, если определен x509_certificate_path. |
путь_к_сертификату_x509 путь добавлен в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к приватному ключу. Используется при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
- Для аутентификации через служебный принципал передайте идентификатор подписки, идентификатор клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите 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 route
azure_rm_route:
resource_group: myResourceGroup
name: myRoute
address_prefix: 10.1.0.0/16
next_hop_type: virtual_network_gateway
route_table_name: table
- name: Delete a route
azure_rm_route:
resource_group: myResourceGroup
name: myRoute
route_table_name: table
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
идентификатор строка | Текущее состояние маршрута. Возвращается: успех Пример: |
Ссылки на сборки
© 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_route_module.html