Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_monitordatacollectionendpoint – Управляемые конечные точки сбора данных

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_monitordatacollectionendpoint.

Добавлено в 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

string

Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

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

URL-адрес центра Azure AD. Используется для аутентификации по имени пользователя и паролю при наличии собственного центра ADFS.

api_profile

string

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

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

В каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

добавлено в 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; в противном случае будет использоваться подписка Azure CLI по умолчанию.

При значении msi на узле должна быть включена функция MSI для ресурса Azure. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

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

Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Это значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

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

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Это значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

description

string

Описание конечной точки сбора данных.

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому необходимо убедиться, что настроенный узел центра действителен и заслуживает доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

kind

string

Тип ресурса.

Варианты:

  • "Linux"
  • "Windows"

location

string

Географическое расположение ресурса.

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

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

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

Имя конечной точки сбора данных.

Регистр символов в имени не учитывается.

network_acls

dictionary

Правила управления сетевым доступом для конечных точек.

public_network_access

string

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

Варианты:

  • "Enabled"
  • "Disabled"
  • "SecuredByPerimeter"

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

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

profile

string

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

resource_group

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

Имя группы ресурсов, в которой находится конечная точка сбора данных (если используется параметр name).

secret

string

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

state

string

Состояние конечной точки сбора данных.

Укажите present, чтобы создать конечную точку.

Укажите absent, чтобы удалить конечную точку.

Варианты:

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

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с использованием всех указанных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы.

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется для аутентификации с помощью субъекта-службы.

Обязателен, если задан параметр x509_certificate_path.

x509_certificate_path

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 endpoint
  azure.azcollection.azure_rm_monitordatacollectionendpoint:
    resource_group: v-xisuRG
    name: fredendpoint1
    description: fredtestend
    kind: Linux
    network_acls:
      public_network_access: Enabled
    tags:
      key1: value1

- name: Delete the data collection endpoint
  azure.azcollection.azure_rm_monitordatacollectionendpoint:
    resource_group: v-xisuRG
    name: fredendpoint1
    state: absent

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

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

Ключ

Описание

datacollectionendpoint

complex

Сведения о связи с правилом сбора данных.

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

configuration_access

dictionary

Конечная точка, используемая клиентами для доступа к конфигурации.

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

Пример: {"endpoint": "https://fredendpoint-q7lu.eastus-1.handler.control.monitor.azure.com"}

description

string

Описание конечной точки сбора данных.

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

Пример: "Created"

etag

string

Тег сущности ресурса (ETag).

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

Пример: "3d001f14-0000-0100-0000-68ca270a0000"

id

string

Полный идентификатор ресурса.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Insights/dataCollectionEndpoints/fredendpoint"

immutable_id

string

Неизменяемый идентификатор этого ресурса конечной точки сбора данных.

Это свойство доступно только для чтения.

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

Пример: "dce-9897a7cde9b54676a1c07ab3ea222768"

kind

string

Вид ресурса.

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

Пример: "Linux"

location

string

Географическое расположение ресурса.

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

Пример: "eastus"

logs_ingestion

dictionary

Конечная точка, используемая клиентами для приема журналов.

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

Пример: {"endpoint": "https://fredendpoint-q7lu.eastus-1.ingest.monitor.azure.com"}

metrics_ingestion

dictionary

Конечная точка, используемая клиентами для приема метрик.

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

Пример: {"endpoint": "https://fredendpoint-q7lu.eastus-1.metrics.ingest.monitor.azure.com"}

name

string

Имя ресурса.

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

Пример: "testendpoint"

network_acls

dictionary

Правила управления сетевым доступом для конечных точек.

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

Пример: {"public_network_access": "Enabled"}

provisioning_state

string

Состояние подготовки ресурса. Это свойство доступно только для чтения.

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

Пример: "Succeeded"

system_data

dictionary

Метаданные о создании ресурса и его последнем изменении.

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

Пример: {"created_at": "2025-09-17T03:12:08.743499Z", "created_by": "00867800-0fa3-4d02-8bc8-35edac3a0d32", "created_by_type": "Application", "last_modified_at": "2025-09-17T03:12:08.743499Z", "last_modified_by": "00867800-0fa3-4d02-8bc8-35edac3a0d32", "last_modified_by_type": "Application"}

tags

dictionary

Теги ресурса.

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

Пример: {"key1": "value1"}

type

string

Тип ресурса.

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

Пример: "Microsoft.Insights/dataCollectionEndpoints"

Авторы

  • magodo (@magodo)
  • Fred Sun (@Fred-sun)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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