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

Logger - Update

汇报现有的记录器。

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

URI 参数

名称 必需 类型 说明
loggerId
path True

string

记录器标识符。 在API 管理服务实例中必须是唯一的。

正则表达式模式: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

资源组的名称。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

请求头

名称 必需 类型 说明
If-Match True

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配,或者对于无条件更新,ETag 应为 * 。

请求正文

名称 类型 说明
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 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementUpdateLogger

示例请求

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2021-08-01


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

示例响应

{
  "id": "/subscriptions/subid/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
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

LoggerContract

记录器详细信息。

LoggerType

记录器类型。

LoggerUpdateContract

记录器更新协定。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

LoggerContract

记录器详细信息。

名称 类型 说明
id

string

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

name

string

资源的名称

properties.credentials

object

azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。 applicationInsights 记录器检测密钥。

properties.description

string

记录器说明。

properties.isBuffered

boolean

发布前是否在记录器中缓冲记录。 默认值假定为 true。

properties.loggerType

LoggerType

记录器类型。

properties.resourceId

string

日志目标的 Azure 资源 ID (Azure 事件中心资源或 Azure 应用程序 Insights 资源) 。

type

string

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

LoggerType

记录器类型。

名称 类型 说明
applicationInsights

string

Azure 应用程序见解作为日志目标。

azureEventHub

string

Azure 事件中心作为日志目标。

azureMonitor

string

Azure Monitor

LoggerUpdateContract

记录器更新协定。

名称 类型 说明
properties.credentials

object

记录器凭据。

properties.description

string

记录器说明。

properties.isBuffered

boolean

发布前是否在记录器中缓冲记录。 默认值假定为 true。

properties.loggerType

LoggerType

记录器类型。