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

Logger - List By Service

列出指定服务实例中的记录器集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

|字段 |使用情况 |支持的运算符 |支持的函数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge、le、eq、ne、gt、lt |substringof, contains, startswith, endswith |
|description |filter |ge、le、eq、ne、gt、lt |substringof, contains, startswith, endswith |
|loggerType |filter |eq | |
|resourceId |filter |ge、le、eq、ne、gt、lt |substringof、 contains、 startswith、 endswith |

$skip
query

integer

int32

要跳过的记录数。

$top
query

integer

int32

要返回的记录数。

响应

名称 类型 说明
200 OK

LoggerCollection

列出记录器实体的集合。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementListLoggers

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "azuremonitor",
      "properties": {
        "loggerType": "azureMonitor",
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "vvktest",
      "properties": {
        "loggerType": "applicationInsights",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}"
        },
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "applicationinsights",
      "properties": {
        "loggerType": "applicationInsights",
        "description": "miaoappinsight",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}"
        },
        "isBuffered": true
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

LoggerCollection

分页记录器列表表示形式。

LoggerContract

记录器详细信息。

LoggerType

记录器类型。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

LoggerCollection

分页记录器列表表示形式。

名称 类型 说明
count

integer

所有页面的总记录计数数。

nextLink

string

下一页链接(如果有)。

value

LoggerContract[]

记录器值。

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