Logger - List By Service

Lists a collection of loggers in the specified service instance.

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

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

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Version of the API to be used with the client request.

$filter
query
  • string

| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| 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

Number of records to skip.

$top
query
  • integer
int32

Number of records to return.

Responses

Name Type Description
200 OK

Lists a collection of Logger entities.

Other Status Codes

Error response describing why the operation failed.

Security

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 impersonate your user account

Examples

ApiManagementListLoggers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers?api-version=2020-12-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": ""
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

LoggerCollection

Paged Logger list representation.

LoggerContract

Logger details.

LoggerType

Logger type.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

LoggerCollection

Paged Logger list representation.

Name Type Description
count
  • integer

Total record count number across all pages.

nextLink
  • string

Next page link if any.

value

Logger values.

LoggerContract

Logger details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.credentials
  • object

The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.

properties.description
  • string

Logger description.

properties.isBuffered
  • boolean

Whether records are buffered in the logger before publishing. Default is assumed to be true.

properties.loggerType

Logger type.

properties.resourceId
  • string

Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).

type
  • string

Resource type for API Management resource.

LoggerType

Logger type.

Name Type Description
applicationInsights
  • string

Azure Application Insights as log destination.

azureEventHub
  • string

Azure Event Hub as log destination.

azureMonitor
  • string

Azure Monitor