Модуль azure.azcollection.azure_rm_natgateway — Управление экземпляром Azure NAT Gateway
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_natgateway.
Описание
- Создание, обновление и удаление экземпляров Azure NAT Gateway.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 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:
|
idle_timeout_in_minutes integer | Тайм-аут бездействия в минутах, который следует использовать. По умолчанию 4. Default: |
location string | Расположение ресурса. Если не указано, по умолчанию будет использоваться расположение из группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя шлюза NAT. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
public_ip_addresses list / elements=string | Список общедоступных IP-адресов, которые должны быть связаны с ресурсом NAT-шлюза. Каждый элемент может быть именем или идентификатором ресурса, или словарем, содержащим |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципа. |
sku словарь | SKU ресурса NAT-шлюза. |
|
name строка |
Имя SKU NAT-шлюза. По умолчанию Варианты:
|
state строка | Утверждение состояния NAT-шлюза. Используйте Варианты:
|
subscription_id строка | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципа. |
thumbprint строка добавлено в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципа. Требуется, если определен x509_certificate_path. |
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания служебного принципа в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью Служебного принципа. |
zones список / elements=целое число | Список доступных зон, в которых должен находиться этот NAT-шлюз. Варианты:
|
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или игры с помощью
az login. - Аутентификация также возможна с помощью служебного принципа или пользователя 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 в среде.
См. также
См. также
- Вход с помощью 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 строка | Идентификатор ресурса шлюза NAT. Возвращается: всегда Пример: |
location строка | Расположение шлюза NAT. Возвращается: всегда Пример: |
name строка | Имя шлюза NAT. Возвращается: всегда Пример: |
resource_group строка | Имя группы ресурсов. Возвращается: всегда Пример: |
Ссылки на сборки
© 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_natgateway_module.html