Модуль azure.azcollection.azure_rm_natgateway — управление экземпляром NAT-шлюза Azure

Примечание

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

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

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

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

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

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

Создание, обновление и удаление экземпляров NAT-шлюза 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 каноническим или новые теги только добавляются к существующим. Если поле является каноническим, все теги, отсутствующие в параметре 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`
idle_timeout_in_minutes integer	Задаваемый тайм-аут простоя в минутах. По умолчанию — 4. По умолчанию: `4`
location string	Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательный	Имя NAT-шлюза.
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.
public_ip_addresses list / элементы типа string	Список общедоступных IP-адресов, которые следует связать с ресурсом NAT-шлюза. Каждый элемент может быть именем или идентификатором ресурса либо словарем, содержащим сведения `name`, `resource_group` об IP-адресе.
resource_group string / обязательный	Имя группы ресурсов.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
sku dictionary	SKU ресурса NAT-шлюза.
name string	Имя SKU NAT-шлюза. По умолчанию — `standard`. Варианты: `"standard"` ← (по умолчанию)
state string	Задает требуемое состояние NAT-шлюза. Используйте `present` для создания или обновления и `absent` для удаления. Варианты: `"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.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат необходимо добавить к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы.
zones list / элементы типа integer	Список зон доступности, в которых должен располагаться этот NAT-шлюз. Варианты: `1` `2` `3`

Примечания

Примечание

Для аутентификации в 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 instance of NAT Gateway
  azure_rm_natgateway:
    resource_group: myResourceGroup
    name: myNATGateway
    public_ip_addresses:
      - pip_name

- name: Create instance of NAT Gateway
  azure_rm_natgateway:
    resource_group: myResourceGroup
    name: myNATGateway
    idle_timeout_in_minutes: 10
    location: eastus
    zones: [1]
    sku:
      name: standard

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

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

Ключ	Описание
id string	Идентификатор ресурса NAT-шлюза. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/natGateways/myNATGw"`
location string	Расположение NAT-шлюза. Возвращается: всегда Пример: `"centralus"`
name string	Имя NAT-шлюза. Возвращается: всегда Пример: `"myNATGw"`
resource_group string	Имя группы ресурсов. Возвращается: всегда Пример: `"myResourceGroup"`

Авторы

Andrea Decorte (@andreadecorte)

Ссылки на коллекцию

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