azure_rm_cdnendpoint – Управление конечной точкой Azure CDN
Новая версия с 2.8.
Обзор
- Создание, обновление, запуск, остановка и удаление конечной точки Azure CDN.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| adfs_authority_url строка добавлено в 2.6 | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS авторизации. | ||
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменных окружения -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. | |
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. | ||
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (определённое Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| content_types_to_compress список | Список типов содержимого, к которым применяется сжатие. | ||
| is_compression_enabled логическое значение |
| Указывает, включено ли сжатие содержимого на CDN. | |
| is_http_allowed логическое значение |
| Указывает, разрешен ли HTTP-трафик на точке входа. | |
| is_https_allowed логическое значение |
| Указывает, разрешен ли HTTPS-трафик на точке входа. | |
| location - | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. | ||
| name - / обязательно | Имя точки входа Azure CDN. | ||
| origin_host_header строка | Значение заголовка host, отправляемое источнику с каждым запросом. | ||
| origin_path строка | Путь к каталогу в источнике, который CDN может использовать для получения содержимого. | ||
| 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 логическое значение |
| Используется с состоянием present для очистки точки входа. Установите в true для очистки точки входа. | |
| purge_content_paths список | По умолчанию: ["/"] | Используется с состоянием present и purge true для указания путей к содержимому, которое должно быть очищено. | |
| query_string_caching_behavior строка |
| Определяет, как CDN кэширует запросы, содержащие строки запроса | |
| resource_group - / обязательно | Имя группы ресурсов, в которой находится или будет создана точка входа Azure CDN. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| started логическое значение |
| Используется с состоянием present для запуска точки входа. Установите в false для остановки точки входа. Установите в true для запуска точки входа. | |
| state - |
| Утверждает состояние точки входа Azure CDN. Используйте present для создания или обновления точки входа Azure CDN и absent для её удаления. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| Теги словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false. | ||
| арендатор строка | Идентификатор 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
Значения возврата
Общие значения возврата описаны в этом документе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| имя_хоста строка | всегда | Имя хоста конечной точки CDN. Пример: myendpoint.azureedge.net |
| id строка | всегда | Идентификатор конечной точки CDN. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/ myEndpoint |
| состояние строка | всегда | Текущее состояние конечной точки Azure CDN |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Yunge Zhu (@yungezz)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_cdnendpoint_module.html
