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 dataCollectionEndpoints 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.Insights/dataCollectionEndpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Insights/dataCollectionEndpoints@2023-03-11' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
configurationAccess: {}
description: 'string'
immutableId: 'string'
logsIngestion: {}
metricsIngestion: {}
networkAcls: {
publicNetworkAccess: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Insights/dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| kind | The kind of the resource. | 'Linux' 'Windows' |
| location | The geo-location where the resource lives. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DataCollectionEndpointConfigurationAccess
| Name | Description | Value |
|---|
DataCollectionEndpointLogsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointMetricsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
DataCollectionEndpointResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
DataCollectionEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| configurationAccess | The endpoint used by clients to access their configuration. | DataCollectionEndpointConfigurationAccess |
| description | Description of the data collection endpoint. | string |
| immutableId | The immutable ID of this data collection endpoint resource. This property is READ-ONLY. | string |
| logsIngestion | The endpoint used by clients to ingest logs. | DataCollectionEndpointLogsIngestion |
| metricsIngestion | The endpoint used by clients to ingest metrics. | DataCollectionEndpointMetricsIngestion |
| networkAcls | Network access control rules for the endpoints. | DataCollectionEndpointNetworkAcls |
DataCollectionEndpointResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Data Collection Endpoint | AVM Resource Module for Data Collection Endpoint |
ARM template resource definition
The dataCollectionEndpoints 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.Insights/dataCollectionEndpoints resource, add the following JSON to your template.
{
"type": "Microsoft.Insights/dataCollectionEndpoints",
"apiVersion": "2023-03-11",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"configurationAccess": {
},
"description": "string",
"immutableId": "string",
"logsIngestion": {
},
"metricsIngestion": {
},
"networkAcls": {
"publicNetworkAccess": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Insights/dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-03-11' |
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| kind | The kind of the resource. | 'Linux' 'Windows' |
| location | The geo-location where the resource lives. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Insights/dataCollectionEndpoints' |
DataCollectionEndpointConfigurationAccess
| Name | Description | Value |
|---|
DataCollectionEndpointLogsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointMetricsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
DataCollectionEndpointResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
DataCollectionEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| configurationAccess | The endpoint used by clients to access their configuration. | DataCollectionEndpointConfigurationAccess |
| description | Description of the data collection endpoint. | string |
| immutableId | The immutable ID of this data collection endpoint resource. This property is READ-ONLY. | string |
| logsIngestion | The endpoint used by clients to ingest logs. | DataCollectionEndpointLogsIngestion |
| metricsIngestion | The endpoint used by clients to ingest metrics. | DataCollectionEndpointMetricsIngestion |
| networkAcls | Network access control rules for the endpoints. | DataCollectionEndpointNetworkAcls |
DataCollectionEndpointResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The dataCollectionEndpoints 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.Insights/dataCollectionEndpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/dataCollectionEndpoints@2023-03-11"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
configurationAccess = {
}
description = "string"
immutableId = "string"
logsIngestion = {
}
metricsIngestion = {
}
networkAcls = {
publicNetworkAccess = "string"
}
}
}
}
Property Values
Microsoft.Insights/dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| kind | The kind of the resource. | 'Linux' 'Windows' |
| location | The geo-location where the resource lives. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Insights/dataCollectionEndpoints@2023-03-11" |
DataCollectionEndpointConfigurationAccess
| Name | Description | Value |
|---|
DataCollectionEndpointLogsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointMetricsIngestion
| Name | Description | Value |
|---|
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
DataCollectionEndpointResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
DataCollectionEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| configurationAccess | The endpoint used by clients to access their configuration. | DataCollectionEndpointConfigurationAccess |
| description | Description of the data collection endpoint. | string |
| immutableId | The immutable ID of this data collection endpoint resource. This property is READ-ONLY. | string |
| logsIngestion | The endpoint used by clients to ingest logs. | DataCollectionEndpointLogsIngestion |
| metricsIngestion | The endpoint used by clients to ingest metrics. | DataCollectionEndpointMetricsIngestion |
| networkAcls | Network access control rules for the endpoints. | DataCollectionEndpointNetworkAcls |
DataCollectionEndpointResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Data Collection Endpoint | AVM Resource Module for Data Collection Endpoint |