azure_rm_route – Управление ресурсом маршрута Azure.

Новое в версии 2.7.

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

Описание

Создание, обновление или удаление маршрута.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user -		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
address_prefix -		CIDR-адрес назначения, к которому применяется маршрут.
adfs_authority_url - добавлен в 2.6	Значение по умолчанию: null	URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном центре авторизации ADFS.
api_profile - добавлен в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags boolean	Варианты: no да ←	Используется для управления тем, является ли поле тегов стандартным, или оно просто добавляется к существующим тегам. При стандартном формате теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source - добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI по умолчанию. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode - добавлен в 2.5	Варианты: validate ignore	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id -		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment - добавлен в 2.4	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name - / обязательно		Имя маршрута.
next_hop_ip_address -		IP-адрес, к которому должны перенаправляться пакеты. Значения следующего узла разрешены только в маршрутах, где тип следующего узла — виртуальный шлюз.
next_hop_type -	Варианты: virtual_network_gateway vnet_local internet virtual_appliance none ←	Тип Azure-узла, к которому должен отправляться пакет.
password -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
route_table_name - / обязательно		Имя таблицы маршрутизации.
secret -		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
state -	Варианты: absent present ←	Утверждение состояния маршрута. Используйте 'present' для создания или обновления, и 'absent' для удаления.
subscription_id -		Идентификатор вашей подписки Azure.
tags -		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant -		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципала или пользователя 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 в среде.

Примеры

- name: Create a route
  azure_rm_route:
    name: foobar
    resource_group: Testing
    address_prefix: 10.1.0.0/16
    next_hop_type: virtual_network_gateway
    route_table_name: table

- name: Delete a route
  azure_rm_route:
    name: foobar
    resource_group: Testing
    route_table_name: table
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
id строка	успех	Текущее состояние маршрута.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Yuwei Zhou (@yuwzho)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_route_module.html