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

Примечание

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

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

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

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

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

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

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

Получение или просмотр указанного шлюза локальной сети в группе ресурсов.

Требования

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

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`, хост должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае будет выбрана первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
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`
external_mappings list / элементы=string	Внешнее сопоставление частного IP-адреса для NAT.
internal_mappings list / элементы=string	Внутреннее сопоставление частного IP-адреса для NAT.
ip_configuration_id string	Идентификатор конфигурации IP, к которой применяется это правило NAT.
log_mode string	Аргумент родительского модуля.
log_path string	Аргумент родительского модуля.
mode string	Направление исходного NAT для VPN NAT. Варианты: `"EgressSnat"` `"IngressSnat"`
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` для создания или обновления правила NAT шлюза виртуальной сети. Используйте `absent` для удаления правила NAT. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Идентификатор вашей подписки Azure.
tags dictionary	Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Значения метаданных тегов объекта будут обновлены с учетом всех указанных значений. Чтобы удалить теги, установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы 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.
type_properties_type string	Тип правила NAT для VPN NAT. Варианты: `"Dynamic"` `"Static"`
virtual_network_gateway_name string / обязательный	Имя шлюза локальной сети.
x509_certificate_path 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 a virtual netowrk nat rule
  azure_rm_virtualnetworkgatewaynatrule:
    resource_group: "{{ resource_group }}"
    virtual_network_gateway_name: "{{ vngname }}"
    name: "{{ natrulename }}"
    type_properties_type: Dynamic
    ip_configuration_id: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworkGateways/testRG/ipConfigurations/ipconfig"
    mode: EgressSnat
    internal_mappings:
      - 10.1.0.0/24
    external_mappings:
      - 192.168.1.0/24

- name: Delete the virtual netowrk nat rule
  azure_rm_virtualnetworkgatewaynatrule:
    resource_group: "{{ resource_group }}"
    virtual_network_gateway_name: "{{ vngname }}"
    name: "{{ natrulename }}"
    state: absent

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

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

Ключ	Описание
state complex	Получает правила NAT для определенного шлюза виртуальной сети Возвращается: всегда
etag string	Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: `"b5a32693-2e75-49e0-9137-ded19db658d6"`
external_mappings list / elements=string	Внешнее сопоставление частных IP-адресов для NAT. Возвращается: всегда Пример: `["192.168.1.0/24"]`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworkGateways/vng01/natRules/natrule"`
internal_mappings list / elements=string	Внутреннее сопоставление частных IP-адресов для NAT. Возвращается: всегда Пример: `["10.1.0.0/24"]`
ip_configuration_id string	Идентификатор конфигурации IP, к которой применяется это правило NAT. Возвращается: всегда Пример: `"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default"`
mode string	Направление исходного NAT для VPN NAT. Возвращается: всегда Пример: `"EgressSnat"`
name string	Имя ресурса. Возвращается: всегда Пример: `"natrule_name"`
provisioning_state string	Состояние подготовки ресурса правила NAT. Возвращается: всегда Пример: `"Succeeded"`
resource_group string	Имя группы ресурсов. Возвращается: всегда Пример: `"testRG"`
type string	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Network/virtualNetworkGateways/natRules"`
type_properties_type string	Тип правила NAT для VPN NAT. Возвращается: всегда Пример: `"Static"`

Авторы

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_virtualnetworkgatewaynatrule_module.html