Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The service/workspaces/loggers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/workspaces/loggers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/loggers@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
credentials: {
{customized property}: 'string'
}
description: 'string'
isBuffered: bool
loggerType: 'string'
resourceId: 'string'
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/loggers
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: service/workspaces |
| properties | Logger entity contract properties. | LoggerContractProperties |
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials |
| description | Logger description. | string Constraints: Max length = 256 |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' 'azureMonitor' (required) |
| resourceId | Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). | string |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|
ARM template resource definition
The service/workspaces/loggers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/workspaces/loggers resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/workspaces/loggers",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"credentials": {
"{customized property}": "string"
},
"description": "string",
"isBuffered": "bool",
"loggerType": "string",
"resourceId": "string"
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/loggers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| properties | Logger entity contract properties. | LoggerContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/workspaces/loggers' |
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials |
| description | Logger description. | string Constraints: Max length = 256 |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' 'azureMonitor' (required) |
| resourceId | Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). | string |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The service/workspaces/loggers resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/workspaces/loggers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/loggers@2024-06-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
credentials = {
{customized property} = "string"
}
description = "string"
isBuffered = bool
loggerType = "string"
resourceId = "string"
}
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/loggers
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service/workspaces |
| properties | Logger entity contract properties. | LoggerContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/workspaces/loggers@2024-06-01-preview" |
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials |
| description | Logger description. | string Constraints: Max length = 256 |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' 'azureMonitor' (required) |
| resourceId | Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). | string |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|