Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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-адреса.
  • Позволяет задавать и обновлять метод распределения адресов и метку доменного имени.
  • Для связывания общедоступного IP-адреса с сетевым интерфейсом используйте модуль azure.azcollection.azure_rm_networkinterface.

Требования

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

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

allocation_method

string

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

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

Варианты:

  • "dynamic" ← (по умолчанию)
  • "static"
  • "Static"
  • "Dynamic"

api_profile

string

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

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

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

append_tags

boolean

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

При использовании канонического набора все теги, отсутствующие в параметре 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

domain_name

псевдонимы: domain_name_label

string

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

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

idle_timeout

integer

Время ожидания простоя в минутах.

ip_tags

list / элементы=dictionary

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

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

type

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

Задаёт тип ip_tags.

value

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

Задаёт значение ip_tags.

location

string

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

log_mode

string

Аргумент родительского уровня.

log_path

string

Аргумент родительского уровня.

name

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

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

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_prefix

dictionary

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

После задания этого значения его нельзя изменить.

id

string

Идентификатор префикса общедоступных IP-адресов.

resource_group

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

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

reverse_fqdn

string

Обратное полное доменное имя (FQDN).

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

Если задано значение reverseFqdn, создаётся DNS-запись PTR, указывающая с IP-адреса в домене in-addr.arpa на обратное полное доменное имя.

secret

string

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

sku

string

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

Если version=ipv6 и sku=standard, задайте allocation_method=static.

Если version=ipv4 и sku=standard, задайте allocation_method=static.

Поддержка sku=basic будет прекращена 30 сентября 2025 года.

Новые ресурсы SKU sku=basic нельзя будет развернуть после 31 марта 2025 года.

Варианты:

  • "standard"
  • "Standard"

state

string

Задаёт требуемое состояние общедоступного IP-адреса. Используйте 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.

version

string

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

Варианты:

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

x509_certificate_path

path

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

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

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

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

zones

list / элементы=string

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

Варианты:

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

complex

Сведения о текущем состоянии объекта.

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

dns_settings

dictionary

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

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

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

etag

string

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

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

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

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/publicIPAddresses/pip01"

idle_timeout_in_minutes

integer

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

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

Пример: 4

ip_address

string

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

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

Пример: "52.160.103.93"

location

string

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

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

Пример: "eastus"

name

string

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

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

Пример: "publicip002"

provisioning_state

string

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

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

Пример: "Succeeded"

public_ip_address_version

string

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

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

Пример: "ipv4"

public_ip_allocation_method

string

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

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

Пример: "static"

public_ip_prefix

dictionary

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

Возвращается: при использовании

Пример: {"id": "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/publicIPPrefixes/prefix01"}

sku

string

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

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

Пример: "Standard"

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

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

zones

list / elements=string

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

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

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

Авторы

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

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

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

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

Spec-Zone.ru

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