Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_publicipprefix_info – Получение фактов о общедоступном префиксе IP-адресов

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_publicipprefix_info.

Новая версия в azure.azcollection 2.2.0

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

Описание

  • Получение фактов для определенного общедоступного префикса IP-адреса.
  • Получение всех фактов для определенных общедоступных префиксов 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.

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

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

password

string

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

profile

string

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

resource_group

string

Ограничение результатов по группе ресурсов. Требуется при использовании параметра name.

secret

string

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

subscription_id

string

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

теги

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

Ограничить результаты, предоставив список тегов. Форматировать теги как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

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

отпечаток

строка

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

Отпечаток частного ключа, указанного в x509_certificate_path.

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

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

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: Get facts for one Public IP Prefix
  azure_rm_publicipprefix_info:
    resource_group: myResourceGroup
    name: publicipprefix

- name: Get facts for all Public IPs within a resource groups
  azure_rm_publicipprefix_info:
    resource_group: myResourceGroup
    tags:
      - key:value

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

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

Ключ

Описание

publicipprefix

complex

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

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

custom_ip_prefix

dictionary

Настраиваемый префикс IP-адресов, с которым связан этот префикс.

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

Пример: {}

etag

string

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

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

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

extended_location

string

Расширенное местоположение общедоступного IP-адреса.

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

Пример: "eastus2"

id

string

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

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

Пример: "/subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPPrefixes/pipb57dc95224"

ip_prefix

string

Выделенный префикс.

Возвращается: успех

Пример: "20.199.95.80/29"

ip_tags

list / elements=string

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

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

Пример: [{"type": "FirstPartyUsage", "value": "Storage"}]

location

string

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

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

Пример: "eastus"

name

string

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

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

Пример: "prefix57dc95224"

prefix_length

integer

Длина префикса общедоступного IP-адреса.

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

Пример: 29

provisioning_state

string

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

Возможные значения: Succeeded.

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

Пример: "Succeeded"

public_ip_address_version

string

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

Возможные значения: IPv4 и IPv6.

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

Пример: "IPv4"

public_ip_addresses

list / elements=string

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

Возвращается: успех

Пример: []

resource_guid

string

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

Возвращается: успех

Пример: "47cafa04-851d-4579-894d-74ad6afe3233"

sku

dictionary

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

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

Пример: {"name": "standard", "tier": "Regional"}

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

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

зоны

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

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

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

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

Авторы

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

Spec-Zone.ru

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