azure.azcollection.azure_rm_monitordiagnosticsetting 模块 – 创建、更新或管理 Azure 监视器诊断设置。

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要满足其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_monitordiagnosticsetting。

azure.azcollection 1.10.0 中的新增功能

概要

  • 为任何类型的资源创建、更新或管理 Azure 监视器诊断设置。

要求

执行此模块的主机需要满足以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 Galaxy 安装 azure.azcollection 集合

  • 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合 requirements.txt 中列出的所有 Python 包

  • 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数

注释

ad_user

string

Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有您自己的 ADFS 授权时使用。

api_profile

string

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

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 可用于标识订阅 ID（如果存在多个订阅 ID），否则将使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 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 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

string

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment），或元数据发现端点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

boolean

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点（例如在私有云或 Azure Stack 中）的情况。实例发现过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权验证。因此，必须确保配置的授权主机有效且值得信赖。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选择

  • false ← （默认）

  • true

event_hub

dictionary

一个将接收诊断日志的事件中心。

对于诊断设置，必须指定 storage_account、log_analytics 或 event_hub 中的至少一个。

hub

string

一个用于接收日志的事件中心名称。如果未指定，将选择默认事件中心。

namespace

string / 必需

事件中心命名空间。

policy

string / 必需

共享访问策略。

resource_group

string

包含事件中心的资源组。如果未指定，将使用 resource 参数的资源组。

subscription_id

string

包含事件中心的订阅 ID。如果未指定，将使用resource参数的订阅 ID。

log_analytics

any

将接收诊断日志的 Log Analytics 工作区。

它可以是包含 Log Analytics 工作区资源 ID 的字符串。

它可以是一个字典，包含 name，以及可选的 subscription_id 和 resource_group。

对于诊断设置，必须指定 storage_account、log_analytics 或 event_hub 中的至少一个。

log_mode

string

父参数。

log_path

string

父参数。

logs

list / elements=dictionary

日志设置的列表。

对于诊断设置，必须至少指定 metrics 或 logs 中的一个。

category

string

此设置应用的资源类型的管理组诊断日志类别的名称。

category_group

string

此设置应用的资源类型的管理组诊断日志类别组的名称。

enabled

boolean

是否启用日志。

选择

  • false

  • true ← (默认)

retention_policy

dictionary

此日志的保留策略。

days

integer

保留策略的天数。

默认值: 0

enabled

boolean

是否启用保留策略。

选择

  • false

  • true ← (默认)

metrics

list / elements=dictionary

指标设置的列表。

对于诊断设置，必须至少指定 metrics 或 logs 中的一个。

category

string

此设置应用的资源类型的诊断指标类别的名称。

enabled

boolean

是否启用指标类别。

选择

  • false

  • true ← (默认)

retention_policy

dictionary

此指标的保留策略。

days

integer

保留策略的天数。

默认值: 0

enabled

boolean

是否启用保留策略。

选择

  • false

  • true ← (默认)

name

string / 必需

诊断设置的名称。

password

string

Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

string

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource

any / required

将使用诊断设置监控的资源。

它可以是包含资源 ID 的字符串。

它可以是一个字典，包含 name、type、resource_group，以及可选的 subscription_id。

name。资源名称。

type。资源类型，包括命名空间，例如 ‘Microsoft.Network/virtualNetworks’。

resource_group。包含资源的资源组。

subscription_id。包含资源的订阅 ID。如果未指定，将使用凭据的订阅 ID。

secret

string

Azure 客户端密钥。当使用服务主体进行身份验证时使用。

state

string

私有终结点 DNS 区域组的状态。使用 present 创建或更新，使用 absent 删除。

选择

  • "absent"

  • "present" ← (默认)

storage_account

any

将接收诊断日志的存储帐户。

它可以是包含存储帐户资源 ID 的字符串。

它可以是一个字典，包含 name，以及可选的 subscription_id 和 resource_group。

对于诊断设置，必须指定 storage_account、log_analytics 或 event_hub 中的至少一个。

subscription_id

string

您的 Azure 订阅 ID。

tenant

string

Azure 租户 ID。当使用服务主体进行身份验证时使用。

thumbprint

string

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

当使用服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必需。

x509_certificate_path

path

在 azure.azcollection 1.14.0 中添加

用于创建 PEM 格式的服务主体的 X509 证书的路径。

证书必须附加到私钥。

当使用服务主体进行身份验证时使用。

说明

注意

  • 为了使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用 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 storage-based diagnostic setting for a virtual network
  azure_rm_monitordiagnosticsetting:
    name: "logs-storage"
    resource: "{{ vnet_output.state.id }}"
    storage_account: "{{ storage_output.state.id }}"
    logs:
      - category_group: "allLogs"
    metrics:
      - category: "AllMetrics"

- name: Create diagnostic setting for webapp with log analytics, event hub, and storage
  azure_rm_monitordiagnosticsetting:
    name: "webapp-logs"
    resource:
      name: "my-webapp"
      type: "Microsoft.Web/sites"
      resource_group: "my-webapp-resource-group"
    event_hub:
      namespace: "my-event-hub"
      policy: "RootManageSharedAccessKey"
    log_analytics:
      name: "my-log-analytics-workspace"
      resource_group: "my-log-analytics-workspace-resource-group"
    storage_account:
      name: "mystorageaccount"
    logs:
      - category: "AppServiceHTTPLogs"
      - category: "AppServiceConsoleLogs"
      - category: "AppServiceAppLogs"
      - category: "AppServiceAuditLogs"
      - category: "AppServiceIPSecAuditLogs"
      - category: "AppServicePlatformLogs"

- name: Delete diagnostic setting
  azure_rm_monitordiagnosticsetting:
    name: "webapp-logs"
    resource:
      name: "my-webapp"
      type: "Microsoft.Web/sites"
      resource_group: "my-webapp-resource-group"
    state: "absent"

返回值

通用返回值记录在此处 此处，以下是此模块独有的字段

Key

描述

state

dictionary

诊断设置的状态。

返回: 总是

event_hub

dictionary

诊断设置的事件中心（如果已配置）。

返回: 总是

hub

string

命名空间中的中心的名称。

返回: 总是

示例: "my-event-hub"

id

string

事件中心命名空间的 ID。

返回: 总是

示例: "/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.EventHub/namespaces/my-event-hub-namespace"

namespace

string

事件中心命名空间的名称。

返回: 总是

示例: "my-event-hub-namespace"

policy

string

事件中心共享访问策略的名称。

返回: 总是

示例: "RootManageSharedAccessKey"

id

string

诊断设置的 ID。

返回: 总是

示例: "/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.network/applicationgateways/my-appgw/ providers/microsoft.insights/diagnosticSettings/my-diagnostic-setting"

log_analytics

dictionary

诊断设置的 Log Analytics 工作区（如果已配置）。

返回: 总是

id

string

Log Analytics 工作区的 ID。

返回: 总是

示例: "/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-log-analytics-workspace"

logs

list / elements=dictionary

诊断设置的已启用日志配置。

返回: 总是

category

string

此设置应用的资源类型的管理组诊断日志类别的名称。

返回: 总是

category_group

string

此设置应用的资源类型的管理组诊断日志类别组的名称。

返回: 总是

enabled

boolean

是否启用此日志。

返回: 总是

retention_policy

dictionary

此日志的保留策略。

返回: 总是

days

integer

保留策略的天数。

返回: 总是

enabled

boolean

是否启用保留策略。

返回: 总是

metrics

list / elements=dictionary

诊断设置的已启用指标配置。

返回: 总是

category

string

此设置应用的资源类型的诊断指标类别的名称。

返回: 总是

enabled

boolean

是否启用指标类别。

返回: 总是

retention_policy

dictionary

指标类别的保留策略。

返回: 总是

days

integer

保留策略的天数。

返回: 总是

enabled

boolean

是否启用保留策略。

返回: 总是

name

string

诊断设置的名称。

返回: 总是

示例: "my-diagnostic-setting"

storage_account

dictionary

诊断设置的存储帐户（如果已配置）。

返回: 总是

id

string

存储帐户的 ID。

返回: 总是

示例: "/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"

作者

  • Ross Bender (@l3ender)