Logger - Create Or Update

Creates or Updates a logger.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}?api-version=2018-06-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

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

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])?$

loggerid
path True
  • string

Logger identifier. Must be unique in the API Management service instance.

Regex pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$)

api-version
query True
  • string

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

Request Header

Name Required Type Description
If-Match
  • string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Required Type Description
properties.credentials True
  • 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 True

Logger type.

properties.resourceId
  • string

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

Responses

Name Type Description
200 OK

The existing logger was successfully updated.

201 Created

Logger was successfully created.

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

ApiManagementCreateAILogger
ApiManagementCreateEHLogger

ApiManagementCreateAILogger

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2018-06-01-preview
{
  "properties": {
    "loggerType": "applicationInsights",
    "description": "adding a new logger",
    "credentials": {
      "instrumentationKey": "11................a1"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false,
    "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false
  }
}

ApiManagementCreateEHLogger

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2018-06-01-preview
{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "{{59544ef2e4bbd50d9468c617}}"
    },
    "isBuffered": true,
    "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "{{59544ef2e4bbd50d9468c617}}"
    },
    "isBuffered": true,
    "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns"
  }
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

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.

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.