Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новое в azure.azcollection 2.2.0

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

Описание

  • Создание, обновление и удаление префикса общедоступного 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"

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"

custom_ip_prefix

dictionary

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

id

string

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

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

extended_location

string

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

ip_tags

list / elements=dictionary

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

ip_tag_type

string

Тип тега IP. Пример: FirstPartyUsage.

tag

string

Значение тега IP, связанного с публичным IP-адресом. Пример: SQL.

location

string

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

log_mode

string

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

log_path

string

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

name

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

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

password

string

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

prefix_length

целое число

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

profile

string

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

public_ip_address_version

string

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

Варианты:

  • "IPV4"
  • "IPV6"

resource_group

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

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

secret

string

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

sku

dictionary

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

name

string

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

Варианты:

  • "Standard"

tier

string

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

Варианты:

  • "Regional"
  • "Global"

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.

x509_certificate_path

path

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

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

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

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

zones

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

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

См. также

См. также

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

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

Примеры

- name: Create a public ip prefix
  azure_rm_publicipprefix:
    resource_group: myResourceGroup
    name: my_public_ip
    public_ip_address_version: IPV4
    prefix_length: 29
    sku:
      name: Standard
      tier: Regional
    zones:
      - 1
    tags:
      key1: value1

- name: Delete public ip prefix
  azure_rm_publicipprefix:
    resource_group: myResourceGroup
    name: my_public_ipprefix
    state: absent

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

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

Ключ

Описание

state

сложный

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

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

custom_ip_prefix

словарь

customIpPrefix, с которым связан этот префикс.

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

Пример: {}

id

строка

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

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

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

ip_tags

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

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

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

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

location

строка

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

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

Пример: "eastus"

name

строка

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

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

Пример: "prefix57dc95224"

public_ip_address_version

строка

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

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

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

Пример: "IPv4"

public_ip_addresses

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

Список всех ссылочных PublicIPAddresses.

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

Пример: []

resource_guid

строка

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

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

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

tags

словарь

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

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

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

type

строка

Тип ресурса.

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

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

Авторы

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

Spec-Zone.ru

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