Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_virtualnetworkgatewaynatrule_info – Получение или список правил NAT для определённого шлюза виртуальной сети

Примечание

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

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

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

Для использования его в плейбуке укажите: azure.azcollection.azure_rm_virtualnetworkgatewaynatrule_info.

Новая функция в azure.azcollection 2.4.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

  • 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"

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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in 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

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.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

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

log_path

string

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

name

string

Имя правила NAT.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string / required

Ресурсная группа шлюза локальной сети.

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта безопасности.

subscription_id

string

Ваш идентификатор подписки Azure.

tenant

string

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

thumbprint

string

added in azure.azcollection 1.14.0

Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path.

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

Обязательно, если определен x509_certificate_path.

virtual_network_gateway_name

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

Имя локального шлюза сети.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

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

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

Примечания

Примечание

  • Для аутентификации с Azure можно передавать параметры, задавать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед выполнением задач или playbook с помощью 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: Gets the nat rule by the name
  azure_rm_virtualnetworkgatewaynatrule_info:
    resource_group: "{{ resource_group }}"
    virtual_network_gateway_name: "{{ local_networkgateway_name }}"
    name: "{{ name }}"

- name: List all nat rules for a particular virtual network gateway
  azure_rm_virtualnetworkgatewaynatrule_info:
    resource_group: "{{ resource_group }}"
    virtual_network_gateway_name: "{{ local_networkgateway_name }}"

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

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

Ключ

Описание

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

Spec-Zone.ru

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