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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Добавлено в версии 0.1.2: коллекции azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection			URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 0.0.1 azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение		Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection		Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection		Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но когда используется прокси-сервер HTTPS или соединение с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
content_types_to_compress список / элементы=строка			Список типов содержимого, к которому применяется сжатие. Это значение должно быть допустимым MIME-типом.
is_compression_enabled логическое значение		Варианты: нет ← да	Указывает, включено ли сжатие содержимого на CDN.
is_http_allowed логическое значение		Варианты: нет да ←	Указывает, разрешен ли HTTP-трафик на точке входа.
is_https_allowed логическое значение		Варианты: нет да ←	Указывает, разрешен ли HTTPS-трафик на точке входа.
location строка			Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
name строка / обязательно			Имя точки входа Azure CDN.
origin_host_header строка			Значение заголовка хоста, отправляемое источнику с каждым запросом.
origin_path строка			Путь к каталогу на источнике, который 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 для очистки точки входа.
purge_content_paths список / элементы=строка		По умолчанию: ["/"]	Используйте со значением state=present и purge=true для указания путей к содержимому, которое должно быть очищено.
query_string_caching_behavior строка		Варианты: игнорировать_строку_запроса ← bypass_caching use_query_string not_set	Определяет, как CDN кэширует запросы, содержащие строки запроса.
resource_group строка / обязательно			Имя группы ресурсов, в которой существует или будет создана точка входа Azure CDN.
secret строка			Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
started логическое значение		Варианты: нет да	Используйте со значением state=present для запуска точки входа.
state строка		Варианты: absent present ←	Утверждает состояние точки входа Azure CDN. Используйте `present` для создания или обновления точки входа Azure CDN и `absent` для её удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false.
tenant строка			Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с 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

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

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

Ключ	Возвращаемое значение	Описание
host_name string	всегда	Имя хоста конечной точки CDN. Пример: myendpoint.azureedge.net
id string	всегда	Идентификатор конечной точки CDN. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/ myEndpoint
state string	всегда	Текущее состояние конечной точки Azure CDN.

Авторы

Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_cdnendpoint_module.html