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

注意

此模块是 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 Monitor 诊断设置。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

adfs_authority_url

字符串

azure.azcollection 0.0.1 中新增

Azure AD 授权 URL。在使用用户名/密码进行身份验证且拥有自己的 ADFS 授权时使用。

api_profile

字符串

azure.azcollection 0.0.1 中新增

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

默认值： "latest"

auth_source

字符串

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

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选项

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

azure.azcollection 0.0.1 中新增

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

client_id

字符串

Azure 客户端 ID。在使用服务主体或托管标识 (msi) 进行身份验证时使用。

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

cloud_environment

字符串

azure.azcollection 0.0.1 中新增

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

默认值： "AzureCloud"

disable_instance_discovery

布尔值

azure.azcollection 2.3.0 版本中添加

确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保已配置的权限主机有效且值得信赖。

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

选项

  • false ← (默认)

  • true

event_hub

字典

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

诊断设置必须至少指定 storage_account、log_analytics 或 event_hub 之一。

hub

字符串

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

namespace

字符串 / 必需

事件中心命名空间。

policy

字符串 / 必需

共享访问策略。

resource_group

字符串

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

subscription_id

字符串

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

log_analytics

任意

将接收诊断日志的日志分析工作区。

可以是包含日志分析工作区资源 ID 的字符串。

可以是包含 name 以及可选的 subscription_id 和 resource_group 的字典。

诊断设置必须至少指定 storage_account、log_analytics 或 event_hub 之一。

log_mode

字符串

父参数。

log_path

字符串

父参数。

logs

列表 / 元素=字典

日志设置列表。

诊断设置必须至少指定 metrics 或 logs 之一。

category

字符串

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

category_group

字符串

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

enabled

布尔值

日志是否启用。

选项

  • false

  • true ← (默认)

retention_policy

字典

此日志的保留策略。

days

整数

保留策略的天数。

默认值： 0

enabled

布尔值

保留策略是否启用。

选项

  • false

  • true ← (默认)

metrics

列表 / 元素=字典

指标设置列表。

诊断设置必须至少指定 metrics 或 logs 之一。

category

字符串

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

enabled

布尔值

指标类别是否启用。

选项

  • false

  • true ← (默认)

retention_policy

字典

此指标的保留策略。

days

整数

保留策略的天数。

默认值： 0

enabled

布尔值

保留策略是否启用。

选项

  • false

  • true ← (默认)

name

字符串 / 必需

诊断设置的名称。

password

字符串

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

profile

字符串

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

resource

任意 / 必需

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

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

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

name. 资源名称。

type. 包含命名空间的资源类型，例如“Microsoft.Network/virtualNetworks”。

resource_group. 包含资源的资源组。

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

secret

字符串

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

state

字符串

专用端点 DNS 区域组的状态。使用 present 创建或更新，使用 absent 删除。

选项

  • "absent"

  • "present" ← (默认)

storage_account

任意

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

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

可以是包含 name 以及可选的 subscription_id 和 resource_group 的字典。

诊断设置必须至少指定 storage_account、log_analytics 或 event_hub 之一。

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

azure.azcollection 1.14.0 版本中添加

在 x509_certificate_path 中指定的私钥的指纹。

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

如果定义了 x509_certificate_path，则必需。

x509_certificate_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 中。这是一个包含 [default] 部分和以下键的 ini 文件：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

字典

诊断设置的状态。

返回： 始终

event_hub

字典

如果已配置，则为诊断设置的事件中心。

返回： 始终

hub

字符串

命名空间中集线器的名称。

返回： 始终

示例： "my-event-hub"

id

字符串

事件中心命名空间的 ID。

返回： 始终

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

namespace

字符串

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

返回： 始终

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

policy

字符串

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

返回： 始终

示例： "RootManageSharedAccessKey"

id

字符串

诊断设置的 ID。

返回： 始终

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

log_analytics

字典

如果已配置，则为诊断设置的日志分析工作区。

返回： 始终

id

字符串

日志分析工作区的 ID。

返回： 始终

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

logs

列表 / 元素=字典

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

返回： 始终

category

字符串

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

返回： 始终

category_group

字符串

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

返回： 始终

enabled

布尔值

此日志是否已启用。

返回： 始终

retention_policy

字典

此日志的保留策略。

返回： 始终

days

整数

保留策略的天数。

返回： 始终

enabled

布尔值

保留策略是否启用。

返回： 始终

metrics

列表 / 元素=字典

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

返回： 始终

category

字符串

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

返回： 始终

enabled

布尔值

指标类别是否启用。

返回： 始终

retention_policy

字典

指标类别的保留策略。

返回： 始终

days

整数

保留策略的天数。

返回： 始终

enabled

布尔值

保留策略是否启用。

返回： 始终

name

字符串

诊断设置的名称。

返回： 始终

示例： "my-diagnostic-setting"

storage_account

字典

如果已配置，则为诊断设置的存储帐户。

返回： 始终

id

字符串

存储帐户的 ID。

返回： 始终

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

作者

  • Ross Bender (@l3ender)