Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

Когда канонично, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

Когда установлено в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Может быть также установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Может быть также установлено через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

external_mappings

list / elements=string

Внешнее сопоставление частного IP-адреса для NAT.

internal_mappings

list / elements=string

Внутреннее сопоставление частного IP-адреса для NAT.

ip_configuration_id

string

Идентификатор IP-конфигурации, к которой применяется это правило NAT.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

mode

string

Направление источника NAT для VPN NAT.

Варианты:

  • "EgressSnat"
  • "IngressSnat"

name

string / обязательно

Имя ресурса, уникальное в пределах группы ресурсов.

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

словарь

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные теги объекта будут обновлены любыми предоставленными значениями.

Для удаления тегов установите параметр 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

путь

добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания сервисного принципала в формате PEM.

Сертификат должен быть присоединен к приватного ключу.

Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

  • Для аутентификации с 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 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
END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ

Описание

state

сложный

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

Возвращается: всегда

etag

строка

Уникальная неизменяемая строка, которая меняется всякий раз, когда ресурс обновляется.

Возвращается: всегда

Пример: "b5a32693-2e75-49e0-9137-ded19db658d6"

external_mappings

список / элементы=строка

Внешнее отображение частного IP-адреса для NAT.

Возвращается: всегда

Пример: ["192.168.1.0/24"]

id

строка

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworkGateways/vng01/natRules/natrule"

internal_mappings

список / элементы=строка

Внутреннее отображение частного IP-адреса для NAT.

Возвращается: всегда

Пример: ["10.1.0.0/24"]

ip_configuration_id

строка

Идентификатор IP-конфигурации, к которому применяется это правило NAT.

Возвращается: всегда

Пример: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default"

mode

строка

Направление источника NAT для VPN NAT.

Возвращается: всегда

Пример: "EgressSnat"

name

строка

Имя ресурса.

Возвращается: всегда

Пример: "natrule_name"

provisioning_state

строка

Состояние подготовки ресурса правила NAT.

Возвращается: всегда

Пример: "Succeeded"

resource_group

строка

Имя группы ресурсов.

Возвращается: всегда

Пример: "testRG"

type

строка

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/virtualNetworkGateways/natRules"

type_properties_type

строка

Тип правила NAT для VPN NAT.

Возвращается: всегда

Пример: "Static"

Авторы

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

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API