Модуль azure.azcollection.azure_rm_localnetworkgateway — управление шлюзом локальной сети Azure в группе ресурсов

Примечание

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

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

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

Чтобы использовать модуль в сценарии playbook, укажите: azure.azcollection.azure_rm_localnetworkgateway.

Добавлено в azure.azcollection 2.4.0

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

Краткое описание

Создание, обновление и удаление шлюза локальной сети Azure в группе ресурсов

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

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, а не субъекта-службы.
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`, на компьютере-узле должен быть включен модуль MSI для ресурса Azure. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае выбирается первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
bgp_settings dictionary	Параметры динамической маршрутизации BGP для локального сетевого шлюза.
asn integer	Номер автономной системы BGP-узла.
bgp_peering_address string	Адрес пиринга BGP и идентификатор этого BGP-узла.
peer_weight integer	Вес, добавляемый к маршрутам, полученным от этого BGP-узла.
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`
fqdn string	Полное доменное имя локального сетевого шлюза.
gateway_ip_address string	IP-адрес локального сетевого шлюза.
local_network_address_space dictionary	Пространство адресов сайта локальной сети.
address_prefixes list / элементы=string	Список блоков адресов в нотации CIDR, зарезервированных для этой виртуальной сети.
location string	Расположение локального сетевого шлюза.
log_mode string	Аргумент родительского модуля.
log_path string	Аргумент родительского модуля.
name string / обязательный	Имя локального сетевого шлюза.
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`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
resource_group string / обязательный	Группа ресурсов локального сетевого шлюза.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
state string	Используйте `present` для создания или обновления локального сетевого шлюза. Используйте `absent` для удаления локального сетевого шлюза. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Идентификатор вашей подписки Azure.
tags dictionary	Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Метаданные тегов объекта будут обновлены с учетом всех переданных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время зоны DNS Azure и службы 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.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, использованному для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

Для аутентификации в Azure можно передавать параметры, задавать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или сценария playbook с помощью 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 a new local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    local_network_address_space:
      address_prefixes:
        - 10.0.0.0/24
        - 20.0.0.0/24
    fqdn: fredtest.com
    tags:
      key: value
    bgp_settings:
      asn: 8
      bgp_peering_address: 10.3.0.1
      peer_weight: 3

- name: Delete local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    state: absent

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

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

Ключ	Описание
state complex	Текущее состояние ресурса шлюза локальной сети Azure. Возвращается: всегда
bgp_settings complex	Параметры BGP-спикера шлюза локальной сети. Возвращается: при успешном выполнении
asn integer	ASN BGP-спикера. Возвращается: всегда Пример: `10`
bgp_peering_address string	Адрес BGP-пирингового соединения и идентификатор BGP этого BGP-спикера. Возвращается: всегда Пример: `"10.0.0.3"`
peer_weight integer	Вес, добавляемый к маршрутам, полученным от этого BGP-спикера. Возвращается: всегда Пример: `0`
etag string	Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: `"b5a32693-2e75-49e0-9137-ded19db658d6"`
fqdn string	FQDN шлюза локальной сети. Возвращается: всегда Пример: `"testfqdn.com"`
gateway_ip_address string	IP-адрес шлюза локальной сети. Возвращается: всегда Пример: `"10.1.1.1"`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/localNetworkGateways/testgateway"`
local_network_address_space complex	Адресное пространство сайта локальной сети. Возвращается: при успешном выполнении
address_prefixes list / elements=string	Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. Возвращается: всегда Пример: `["10.0.0.0/24", "20.0.0.0/24"]`
location string	Расположение ресурса. Возвращается: всегда Пример: `"eastus"`
name string	Имя ресурса. Возвращается: всегда Пример: `"testgateway"`
provisioning_state string	Состояние подготовки ресурса шлюза локальной сети. Возвращается: всегда Пример: `"Succeeded"`
tags string	Теги ресурса. Возвращается: всегда Пример: `"{'key1': 'value1', 'key2': 'value2'}"`
type string	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Network/localNetworkGateways"`

Авторы

xuzhang3 (@xuzhang3)
Fred Sun (@Fred-sun)

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

© 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_localnetworkgateway_module.html