Модуль azure.azcollection.azure_rm_loganalyticsworkspace — управление рабочими областями Azure Log Analytics
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_loganalyticsworkspace.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание и удаление рабочих областей Azure Log Analytics.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
- Полные инструкции по установке приведены здесь: https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user строка | Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url строка добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется для аутентификации по имени пользователя и паролю при наличии собственного центра ADFS. |
api_profile строка добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags логическое значение | Управляет тем, считается ли поле tags каноническим или теги лишь добавляются к существующим. В каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта. Варианты:
|
auth_source строка добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения При значении При значении При значении При значении При значении Параметр Варианты:
|
cert_validation_mode строка добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment строка добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например, По умолчанию: |
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает обнаружение экземпляра и проверку центра. Эта возможность предназначена для сценариев, в которых недоступна конечная точка метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Если установить значение **True**, проверка центра отключается. Поэтому важно убедиться, что настроенный узел центра действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
force логическое значение | Удаляет рабочую область без возможности восстановления. Рабочую область, удаленную с этим флагом, восстановить нельзя. Варианты:
|
identity словарь добавлено в azure.azcollection 3.0.0 | Удостоверение для хранилища Azure Recovery Services. |
|
type строка |
Тип управляемого удостоверения Варианты:
|
|
user_assigned_identity строка |
Назначенное пользователем управляемое удостоверение, связанное с этим ресурсом |
intelligence_packs словарь | Управление пакетами аналитики, доступными для этой рабочей области. Чтобы включить пакет, задайте для него значение Чтобы отключить пакет, задайте для него значение Другие пакеты аналитики, не перечисленные в этом свойстве, останутся без изменений. |
location строка | Расположение ресурса. |
log_mode строка | Родительский аргумент. |
log_path строка | Родительский аргумент. |
name строка / обязательный | Имя рабочей области. |
oidc_token строка добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения |
oidc_token_file_path путь добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только токен в исходном виде. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной окружения |
password строка | Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile строка | Профиль безопасности из файла ~/.azure/credentials. |
resource_group строка / обязательный | Имя группы ресурсов. |
retention_in_days целое число | Срок хранения данных рабочей области в днях. -1 означает неограниченный срок хранения для sku=unlimited. Для всех остальных SKU максимальный срок составляет 730 дней. |
secret строка | Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы. |
sku строка | SKU рабочей области. Варианты:
|
state строка | Задает требуемое состояние образа. Используйте Варианты:
|
subscription_id строка | Идентификатор вашей подписки Azure. |
tags словарь | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Метаданные объекта обновляются с использованием всех указанных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
tenant строка | Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы. |
thumbprint строка добавлено в 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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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 workspace with backup enabled
azure_rm_loganalyticsworkspace:
resource_group: myResourceGroup
name: myLogAnalyticsWorkspace
intelligence_pack:
Backup: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id string | Путь к ресурсу рабочей области. Возвращается: при успешном выполнении Пример: |
intelligence_packs list / elements=string | Список всех доступных пакетов аналитики и указание, включены они или отключены для заданной рабочей области. Возвращается: при успешном выполнении Пример: |
location string | Расположение ресурса. Возвращается: при успешном выполнении Пример: |
management_groups dictionary | Группы управления, подключенные к рабочей области. Возвращается: при успешном выполнении Пример: |
retention_in_days integer | Срок хранения данных рабочей области в днях. -1 означает неограниченный срок хранения для sku=unlimited. Для всех остальных SKU максимальный срок составляет 730 дней. Возвращается: при успешном выполнении Пример: |
dictionary | Общие ключи рабочей области. Возвращается: при успешном выполнении Пример: |
sku string | SKU рабочей области. Возвращается: при успешном выполнении Пример: |
usages dictionary | Показатели использования рабочей области. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_loganalyticsworkspace_module.html