Модуль azure.azcollection.azure_rm_monitordatacollectionruleassociation — Управляемая связь правила сбора данных
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля также требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_monitordatacollectionruleassociation.
Добавлено в azure.azcollection 3.9.0
Краткое описание
- Создание, обновление или удаление связи правила сбора данных.
Требования
На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- 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. Значение по умолчанию По умолчанию: |
association_name строка / обязательный | Имя связи. Имя не чувствительно к регистру. Связь конечной точки сбора данных должна иметь имя ‘configurationAccessEndpoint. |
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, например, По умолчанию: |
data_collection_endpoint_id строка | Идентификатор конечной точки сбора данных. |
data_collection_rule_id строка | Идентификатор правила сбора данных. |
description строка | Описание связи. |
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если установить значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта возможность предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Установка значения **True** отключает проверку центра. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
log_mode строка | Родительский аргумент. |
log_path строка | Родительский аргумент. |
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_uri строка / обязательный | Идентификатор ресурса. |
secret строка | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state строка | Состояние связи правила сбора данных. Установите значение Установите значение Варианты:
|
subscription_id строка | Идентификатор вашей подписки Azure. |
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 new data collection rule association
azure.azcollection.azure_rm_monitordatacollectionrulesassociation:
resource_uri: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/fredVM"
association_name: association01
data_collection_rule_id: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Insights/dataCollectionRules/fredrpfx001-DCR"
description: fredtest
- name: Delete the data collection rule association
azure.azcollection.azure_rm_monitordatacollectionrulesassociation:
resource_uri: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/fredVM"
association_name: association01
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
datacollectionruleassociation сложный тип | Факты о связи правила сбора данных. Возвращается: всегда |
|
data_collection_endpoint_id строка |
Идентификатор ресурса конечной точки сбора данных, с которой требуется создать связь. Возвращается: при использовании Пример: |
|
data_collection_rule_id строка |
Идентификатор ресурса конечной точки сбора данных, с которой требуется создать связь. Возвращается: при использовании Пример: |
|
description строка |
Описание связи. Возвращается: всегда Пример: |
|
etag строка |
Описание связи. Возвращается: всегда Пример: |
|
id строка |
Полный идентификатор ресурса. Возвращается: всегда Пример: |
|
name строка |
Описание связи. Возвращается: всегда Пример: |
|
system_data словарь |
Метаданные о создании и последнем изменении ресурса. Возвращается: всегда Пример: |
|
type строка |
Тип ресурса. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_monitordatacollectionruleassociation_module.html