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

Logger - Update

服务:

API Management

API 版本:

2024-05-01

更新现有记录器。

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

URI 参数

名称	在	必需	类型	说明
loggerId	path	True	string maxLength: 256 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 版本。

请求头

名称	必需	类型	说明
If-Match	True	string	实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

请求正文

名称	类型	说明
properties.credentials	object	记录器凭据。
properties.description	string	记录器说明。
properties.isBuffered	boolean	是否在发布前缓冲记录器中的记录。 默认值假定为 true。
properties.loggerType	LoggerType	记录器类型。

响应

名称	类型	说明
200 OK	LoggerContract	已成功更新现有记录器。 标头 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	模拟用户帐户

示例

ApiManagementUpdateLogger

示例请求

HTTP

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


{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "updating description"
  }
}

示例响应

状态代码:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "updating description",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LoggerContract	记录器详细信息。
LoggerType	记录器类型。
LoggerUpdateContract	记录器更新协定。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LoggerContract

Object

记录器详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.credentials	object	azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。 applicationInsights 记录器检测密钥。
properties.description	string maxLength: 256	记录器说明。
properties.isBuffered	boolean	是否在发布前缓冲记录器中的记录。 默认值假定为 true。
properties.loggerType	LoggerType	记录器类型。
properties.resourceId	string	日志目标的 Azure 资源 ID（Azure 事件中心资源或 Azure Application Insights 资源）。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

LoggerType

枚举

记录器类型。

值	说明
applicationInsights	Azure Application Insights 作为日志目标。
azureEventHub	Azure 事件中心作为日志目标。
azureMonitor	Azure Monitor

LoggerUpdateContract

Object

记录器更新协定。

名称	类型	说明
properties.credentials	object	记录器凭据。
properties.description	string	记录器说明。
properties.isBuffered	boolean	是否在发布前缓冲记录器中的记录。 默认值假定为 true。
properties.loggerType	LoggerType	记录器类型。