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=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
$filter
|
query |
string |
| Field | Usage | Supported operators | Supported functions | |
|
$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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers?api-version=2024-05-01
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "azuremonitor",
"properties": {
"loggerType": "azureMonitor",
"isBuffered": true
}
},
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/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
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Logger |
Paged Logger list representation. |
Logger |
Logger details. |
Logger |
Logger type. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
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 |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
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 |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
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 |