你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Diagnostic Settings - List

获取指定资源的活动诊断设置列表。

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings?api-version=2021-05-01-preview

URI 参数

Name In Required Type Description
resourceUri
path True
  • string

资源的标识符。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

成功请求以获取有关诊断设置的详细信息

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Gets the diagnostic setting
Gets the diagnostic setting for category

Gets the diagnostic setting

Sample Request

GET https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings?api-version=2021-05-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting",
      "type": "Microsoft.Insights/diagnosticSettings",
      "name": "mysetting",
      "properties": {
        "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
        "eventHubAuthorizationRuleId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "",
        "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
        "metrics": [
          {
            "category": "WorkflowMetrics",
            "enabled": true,
            "retentionPolicy": {
              "enabled": false,
              "days": 0
            }
          }
        ],
        "logs": [
          {
            "categoryGroup": "allLogs",
            "enabled": true,
            "retentionPolicy": {
              "enabled": false,
              "days": 0
            }
          }
        ]
      }
    }
  ]
}

Gets the diagnostic setting for category

Sample Request

GET https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings?api-version=2021-05-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
      "type": "microsoft.logic/workflows",
      "name": "mysetting",
      "properties": {
        "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
        "eventHubAuthorizationRuleId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "",
        "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
        "metrics": [
          {
            "category": "WorkflowMetrics",
            "enabled": true,
            "retentionPolicy": {
              "enabled": false,
              "days": 0
            }
          }
        ],
        "logs": [
          {
            "category": "WorkflowRuntime",
            "enabled": true,
            "retentionPolicy": {
              "enabled": false,
              "days": 0
            }
          }
        ]
      }
    }
  ]
}

定义

createdByType

创建资源的标识的类型。

DiagnosticSettingsResource

诊断设置资源。

DiagnosticSettingsResourceCollection

表示警报规则资源的集合。

ErrorResponse

描述错误响应的格式。

LogSettings

MultiTenantDiagnosticSettings 的一部分。 指定特定日志的设置。

MetricSettings

MultiTenantDiagnosticSettings 的一部分。 指定特定指标的设置。

RetentionPolicy

指定日志的保留策略。

systemData

与创建和上次修改资源相关的元数据。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DiagnosticSettingsResource

诊断设置资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.eventHubAuthorizationRuleId
  • string

事件中心授权规则的资源 ID。

properties.eventHubName
  • string

事件中心的名称。 如果未指定任何内容,则会选择默认事件中心。

properties.logAnalyticsDestinationType
  • string

一个字符串,指示导出到 Log Analytics 是否应使用默认目标类型,即 AzureDiagnostics,还是使用按如下所示构造的目标类型: _。 可能的值为:专用值,null (null 为 default.)

properties.logs

日志设置列表。

properties.marketplacePartnerId
  • string

要向其发送诊断日志的市场资源的完整 ARM 资源 ID。

properties.metrics

指标设置列表。

properties.serviceBusRuleId
  • string

诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。

properties.storageAccountId
  • string

要向其发送诊断日志的存储帐户的资源 ID。

properties.workspaceId
  • string

要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

systemData

与此资源相关的系统元数据。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

DiagnosticSettingsResourceCollection

表示警报规则资源的集合。

Name Type Description
value

诊断设置资源的集合;。

ErrorResponse

描述错误响应的格式。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败的原因的错误消息。

LogSettings

MultiTenantDiagnosticSettings 的一部分。 指定特定日志的设置。

Name Type Description
category
  • string

此设置应用于的资源类型的诊断日志类别的名称。 若要获取资源的诊断日志类别列表,请先执行 GET 诊断设置操作。

categoryGroup
  • string

应用此设置的资源类型的诊断日志类别组的名称。 若要获取资源的诊断日志类别列表,请先执行 GET 诊断设置操作。

enabled
  • boolean

一个值,该值指示是否启用此日志。

retentionPolicy

此日志的保留策略。

MetricSettings

MultiTenantDiagnosticSettings 的一部分。 指定特定指标的设置。

Name Type Description
category
  • string

此设置应用于的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表,请先执行 GET 诊断设置操作。

enabled
  • boolean

一个值,该值指示是否启用此类别。

retentionPolicy

此类别的保留策略。

timeGrain
  • string

采用 ISO8601 格式的指标的时间根。

RetentionPolicy

指定日志的保留策略。

Name Type Description
days
  • integer

保留天数(以天为单位)。 值为 0 将无限期保留事件。

enabled
  • boolean

一个值,该值指示是否启用保留策略。

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。