通过

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

Diagnostic - Get

  • 参考
服务:
API Management
API 版本:
2024-05-01

获取由其标识符指定的诊断的详细信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2024-05-01

URI 参数

名称 在 必需 类型 说明
diagnosticId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

诊断标识符。 当前 API 管理服务实例中必须是唯一的。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服务的名称。
subscriptionId
 path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

DiagnosticContract

响应正文包含指定的诊断实体。

标头

ETag: string
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetDiagnostic

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights?api-version=2024-05-01

示例响应

状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "httpCorrelationProtocol": "Legacy",
    "logClientIp": true,
    "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 100
    },
    "frontend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    },
    "backend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    }
  }
}

定义

名称 说明
AlwaysLog

指定不应应用哪种类型的消息采样设置。
BodyDiagnosticSettings

正文日志记录设置。
DataMasking
DataMaskingEntity
DataMaskingMode

数据掩码模式。
DiagnosticContract

诊断详细信息。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
HttpCorrelationProtocol

设置要用于 Application Insights 诊断的相关协议。
HttpMessageDiagnostic

Http 消息诊断设置。
OperationNameFormat

Application Insights 遥测的作名称的格式。 默认值为 Name。
PipelineDiagnosticSettings

传入/传出 HTTP 消息到网关的诊断设置。
SamplingSettings

诊断的采样设置。
SamplingType

采样类型。
Verbosity

应用于跟踪策略发出的跟踪的详细级别。

AlwaysLog

枚举

指定不应应用哪种类型的消息采样设置。

值 说明
allErrors

无论采样设置如何，始终记录所有错误请求。

BodyDiagnosticSettings

Object

正文日志记录设置。

名称 类型 说明
bytes

integer (int32)

maximum: 8192

要记录的请求正文字节数。

DataMasking

Object
名称 类型 说明
headers

DataMaskingEntity[]

标头的掩码设置
queryParams

DataMaskingEntity[]

Url 查询参数的掩码设置

DataMaskingEntity

Object
名称 类型 说明
mode

DataMaskingMode

数据掩码模式。
value

string

要屏蔽的实体的名称（例如标头或查询参数的名称）。

DataMaskingMode

枚举

数据掩码模式。

值 说明
Hide

隐藏实体的存在。
Mask

屏蔽实体的值。

DiagnosticContract

Object

诊断详细信息。

名称 类型 说明
id

string

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

string

资源的名称
properties.alwaysLog

AlwaysLog

指定不应应用哪种类型的消息采样设置。
properties.backend

PipelineDiagnosticSettings

传入/传出 HTTP 消息到后端的诊断设置
properties.frontend

PipelineDiagnosticSettings

传入/传出 HTTP 消息到网关的诊断设置。
properties.httpCorrelationProtocol

HttpCorrelationProtocol

设置要用于 Application Insights 诊断的相关协议。
properties.logClientIp

boolean

记录 ClientIP。 默认值为 false。
properties.loggerId

string

目标记录器的资源 ID。
properties.metrics

boolean

通过发出指标策略发出自定义指标。 仅适用于 Application Insights 诊断设置。
properties.operationNameFormat

OperationNameFormat

Application Insights 遥测的作名称的格式。 默认值为 Name。
properties.sampling

SamplingSettings

诊断的采样设置。
properties.verbosity

Verbosity

应用于跟踪策略发出的跟踪的详细级别。
type

string

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

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

HttpCorrelationProtocol

枚举

设置要用于 Application Insights 诊断的相关协议。

值 说明
Legacy

使用请求关联数据注入 Request-Id 和 Request-Context 标头。 请参阅 https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md。
None

不要读取和注入相关标头。
W3C

注入跟踪上下文标头。 请参阅 https://w3c.github.io/trace-context。

HttpMessageDiagnostic

Object

Http 消息诊断设置。

名称 类型 说明
body

BodyDiagnosticSettings

正文日志记录设置。
dataMasking

DataMasking

数据掩码设置。
headers

string[]

要记录的 HTTP 标头数组。

OperationNameFormat

枚举

Application Insights 遥测的作名称的格式。 默认值为 Name。

值 说明
Name

API_NAME;rev=API_REVISION - OPERATION_NAME
Url

HTTP_VERB URL

PipelineDiagnosticSettings

Object

传入/传出 HTTP 消息到网关的诊断设置。

名称 类型 说明
request

HttpMessageDiagnostic

请求的诊断设置。
response

HttpMessageDiagnostic

响应的诊断设置。

SamplingSettings

Object

诊断的采样设置。

名称 类型 说明
percentage

number (double)

minimum: 0
maximum: 100

固定速率采样的采样率。
samplingType

SamplingType

采样类型。

SamplingType

枚举

采样类型。

值 说明
fixed

固定速率采样。

Verbosity

枚举

应用于跟踪策略发出的跟踪的详细级别。

值 说明
error

只有“严重性”设置为“error”的跟踪才会发送到附加到此诊断实例的记录器。
information

将“严重性”设置为“信息”和“错误”的跟踪将发送到附加到此诊断实例的记录器。
verbose

跟踪策略发出的所有跟踪都将发送到附加到此诊断实例的记录器。