azure.azcollection.azure_rm_monitordiagnosticsetting_info 模块 – 获取 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_info。

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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了 `msi`。选项 `"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`
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串	将结果限制在资源内的单个诊断设置。
密码字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
资源任意 / 必需	将使用诊断设置监控的资源。它可以是包含资源 ID 的字符串。它可以是包含名称、类型、资源组以及可选的订阅 ID 的字典。名称。资源名称。类型。包含命名空间的资源类型，例如“Microsoft.Network/virtualNetworks”。资源组。包含资源的资源组。订阅 ID。包含资源的订阅 ID。如果未指定，则将使用凭据的订阅 ID。
密钥字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
订阅 ID 字符串	您的 Azure 订阅 ID。
租户字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
指纹字符串在 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: Get all diagnostic settings for a resource
  azure_rm_monitordiagnosticsetting_info:
    resource: "/subscriptions/my-resource-group/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/my-web-app"

- name: Get all diagnostic settings for a resource using a dictionary
  azure_rm_monitordiagnosticsetting_info:
    resource:
      name: "my-web-app"
      type: "Microsoft.Web/sites"
      resource_group: "my-resource-group"

- name: Get a specific diagnostic setting
  azure_rm_monitordiagnosticsetting_info:
    name: "my-diagnostic-setting"
    resource: "/subscriptions/my-resource-group/resourceGroups/my-resource-group/providers/Microsoft.Network/virtualNetworks/my-vnet"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
设置列表 / 元素=字典	诊断设置列表，按名称排序。返回：始终
事件中心字典	如果已配置，则为诊断设置的事件中心。返回：始终
中心字符串	命名空间内的中心名称。返回：始终示例：`"my-event-hub"`
ID 字符串	事件中心命名空间的 ID。返回：始终示例：`"/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.EventHub/namespaces/my-event-hub-namespace"`
命名空间字符串	事件中心命名空间的名称。返回：始终示例：`"my-event-hub-namespace"`
策略字符串	事件中心共享访问策略的名称。返回：始终示例：`"RootManageSharedAccessKey"`
ID 字符串	诊断设置的 ID。返回：始终示例：`"/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.network/applicationgateways/my-appgw/ providers/microsoft.insights/diagnosticSettings/my-diagnostic-setting"`
日志分析字典	如果已配置，则为诊断设置的日志分析工作区。返回：始终
ID 字符串	日志分析工作区的 ID。返回：始终示例：`"/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-log-analytics-workspace"`
日志列表 / 元素=字典	为诊断设置启用的日志配置。返回：始终
类别字符串	应用此设置的资源类型的管理组诊断日志类别的名称。返回：始终
类别组字符串	应用此设置的资源类型的管理组诊断日志类别组的名称。返回：始终
已启用布尔值	此日志是否已启用。返回：始终
保留策略字典	此日志的保留策略。返回：始终
天数整数	保留策略的天数。返回：始终
已启用布尔值	保留策略是否已启用。返回：始终
指标列表 / 元素=字典	为诊断设置启用的指标配置。返回：始终
类别字符串	应用此设置的资源类型的诊断指标类别的名称。返回：始终
已启用布尔值	指标类别是否已启用。返回：始终
保留策略字典	指标类别的保留策略。返回：始终
天数整数	保留策略的天数。返回：始终
已启用布尔值	保留策略是否已启用。返回：始终
name 字符串	诊断设置的名称。返回：始终示例：`"my-diagnostic-setting"`
存储帐户字典	如果已配置，则为诊断设置的存储帐户。返回：始终
ID 字符串	存储帐户的 ID。返回：始终示例：`"/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"`

作者

Ross Bender (@l3ender)