Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_cdnendpoint – Управление точкой доступа Azure CDN

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_cdnendpoint.

Новое в azure.azcollection 0.1.2

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

Описание

  • Создание, обновление, запуск, остановка и удаление точки доступа Azure CDN.

Требования

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

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

content_types_to_compress

list / elements=string

Список типов контента, к которым применяется сжатие.

Это значение должно быть допустимым типом MIME.

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

is_compression_enabled

boolean

Указывает, включено ли сжатие контента в CDN.

Choices:

  • false ← (default)
  • true

is_http_allowed

boolean

Указывает, разрешен ли HTTP-трафик в конечной точке.

Choices:

  • false
  • true ← (default)

is_https_allowed

boolean

Указывает, разрешен ли HTTPS-трафик в конечной точке.

Choices:

  • false
  • true ← (default)

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя конечной точки Azure CDN.

origin_host_header

string

Значение заголовка хоста, отправляемого источнику с каждым запросом.

origin_path

string

Путь к каталогу в источнике, который CDN может использовать для получения содержимого.

Например: contoso.cloudapp.net/originpath.

origins

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

Набор источников содержимого, доставляемого через CDN.

Требуется при создании.

host_name

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

Адрес источника.

Может быть именем домена, IPv4-адресом или IPv6-адресом.

http_port

целое число

Значение порта HTTP. Должно быть между 1 и 65535.

https_port

целое число

Значение порта HTTPS. Должно быть между 1 и 65535.

name

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

Имя источника.

password

строка

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

profile

строка

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

profile_name

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

Имя профиля CDN, к которому подключена конечная точка.

purge

логическое значение

Используйте со значением state=present для очистки конечной точки.

Варианты:

  • false
  • true

purge_content_paths

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

Используйте со значением state=present и purge=true для указания путей к содержимому, которое нужно очистить.

По умолчанию: ["/"]

query_string_caching_behavior

строка

Определяет, как CDN кеширует запросы, содержащие строки запроса.

Варианты:

  • "ignore_query_string" ← (по умолчанию)
  • "bypass_caching"
  • "use_query_string"
  • "not_set"

resource_group

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

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

secret

строка

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

started

логическое значение

Используйте со значением state=present для запуска конечной точки.

Варианты:

  • false
  • true

state

строка

Утверждение состояния конечной точки Azure CDN. Используйте present для создания или обновления конечной точки Azure CDN и absent для её удаления.

Варианты:

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

subscription_id

строка

Ваш идентификатор подписки 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.

x509_certificate_path

путь

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

Путь к X509-сертификату, используемому для создания принципала службы в формате 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: Create a Azure CDN endpoint
  azure_rm_cdnendpoint:
    resource_group: myResourceGroup
    profile_name: myProfile
    name: myEndpoint
    origins:
      - name: TestOrig
        host_name: "www.example.com"
    tags:
      testing: testing
      delete: on-exit
      foo: bar
- name: Delete a Azure CDN endpoint
  azure_rm_cdnendpoint:
    resource_group: myResourceGroup
    profile_name: myProfile
    name: myEndpoint
    state: absent

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

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

Ключ

Описание

имя_хоста

строка

Имя хоста конечной точки CDN.

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

Пример: "myendpoint.azureedge.net"

id

строка

Идентификатор конечной точки CDN.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/ myEndpoint"

состояние

строка

Текущее состояние конечной точки CDN Azure.

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

Авторы

  • Yunge Zhu (@yungezz)

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

  • Отслеживание задач
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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