Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_publicipaddress – Управление общедоступными IP-адресами Azure

Примечание

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

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

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

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

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

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

Описание

  • Создание, обновление и удаление общедоступного IP-адреса.
  • Позволяет задавать и обновлять метод выделения адреса и метку доменного имени.
  • Используйте модуль azure.azcollection.azure_rm_networkinterface для ассоциации общедоступного IP-адреса с сетевым интерфейсом.

Требования

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

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

allocation_method

string

Управление тем, остаётся ли назначенный общедоступный IP-адрес постоянно назначенным объекту.

Если не задано значение Static, IP-адрес может измениться в любое время при циклическом включении/выключении связанной виртуальной машины.

Варианты:

  • "dynamic" ← (default)
  • "static"
  • "Static"
  • "Dynamic"

api_profile

string

added in azure.azcollection 0.0.1

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

По умолчанию: "latest"

append_tags

boolean

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

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

Варианты:

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

Варианты:

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

Варианты:

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

По умолчанию: "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 ← (default)
  • true

domain_name

aliases: domain_name_label

string

Настраиваемая часть FQDN, назначенного общедоступному IP-адресу. Это явное значение.

Если значение не указано, любое существующее значение будет удалено из существующего общедоступного IP-адреса.

idle_timeout

integer

Тайм-аут бездействия в минутах.

ip_tags

list / elements=dictionary

Список IpTag, связанных с общедоступным IP-адресом.

Каждый элемент должен содержать пару тип:значение.

тип

строка / обязательно

Устанавливает тип ip_tags.

значение

строка / обязательно

Устанавливает значение ip_tags.

местоположение

строка

Допустимое расположение Azure. По умолчанию — расположение группы ресурсов.

режим_логирования

строка

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

путь_логирования

строка

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

имя

строка / обязательно

Имя общедоступного IP-адреса.

пароль

строка

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

профиль

строка

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

группа_ресурсов

строка / обязательно

Имя группы ресурсов, к которой относится общедоступный IP-адрес.

секрет

строка

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

sku

строка

SKU общедоступного IP-адреса.

При version=ipv6, если sku=standard, то установите allocation_method=static.

При version=ipv4, если sku=standard, то установите allocation_method=static.

Выбо:

  • "basic"
  • "standard"
  • "Basic"
  • "Standard"

состояние

строка

Утвердить состояние общедоступного IP-адреса. Используйте present для создания или обновления, и absent для удаления.

Выбо:

  • "absent"
  • "present" ← (по умолчанию)

идентификатор_подписки

строка

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

метки

словарь

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

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

Чтобы удалить метки, установите опцию append_tags в значение false.

В настоящее время в зонах Azure DNS и службах Traffic Manager также запрещено использовать пробелы в метках.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 меток для ресурсов.

арендатор

строка

Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы.

отпечаток

строка

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

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

Используйте при аутентификации с принципалом службы.

Требуется, если определен x509_certificate_path.

версия

строка

Версия общедоступного IP-адреса.

Выбо:

  • "ipv4" ← (по умолчанию)
  • "ipv6"

путь_сертификата_x509

путь

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

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

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

Используйте при аутентификации с принципалом службы.

зоны

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

Список зон доступности, указывающий, откуда необходимо выделить IP для ресурса.

Выбо:

  • "1"
  • "2"
  • "3"

Примечания

Примечание

  • Для аутентификации с 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

См. также

Авторизация с помощью Azure CLI

Как выполнить аутентификацию, используя команду az login.

Примеры

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    allocation_method: static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    state: absent

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

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

Ключ

Описание

state

сложное

Информация о текущем состоянии объекта.

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

dns_settings

словарь

FQDN записи DNS, связанной с общедоступным IP-адресом.

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

Пример: {"domain_name_label": "ansible-b57dc95985712e45eb8b9c2e", "fqdn": "ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com", "reverse_fqdn": null}

etag

строка

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

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

Пример: "W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'"

idle_timeout_in_minutes

целое число

Таймаут бездействия общедоступного IP-адреса.

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

Пример: 4

ip_address

строка

Префикс общедоступного IP, из которого должен быть выделен данный общедоступный IP-адрес.

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

Пример: "52.160.103.93"

location

строка

Расположение ресурса.

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

Пример: "eastus"

name

строка

Имя общедоступного IP-адреса.

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

Пример: "publicip002"

provisioning_state

строка

Состояние подготовки общедоступного IP-ресурса.

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

Пример: "Succeeded"

public_ip_address_version

строка

Версия общедоступного IP-адреса.

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

Пример: "ipv4"

public_ip_allocation_method

строка

Метод выделения общедоступного IP-адреса.

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

Пример: "static"

sku

строка

SKU общедоступного IP-адреса.

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

Пример: "Basic"

tags

словарь

Теги ресурса.

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

Пример: {"delete": "on-exit", "testing": "testing"}

type

строка

Тип ресурса.

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

Пример: "Microsoft.Network/publicIPAddresses"

zones

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

Список доступных зон, определяющих, откуда нужно получить выделенный IP для ресурса.

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

Пример: ["1", "2"]

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

Ссылки на сборки

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

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

Spec-Zone.ru

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