Microsoft.Insights dataCollectionEndpoints 2022-06-01
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@2022-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
configurationAccess: {}
description: 'string'
immutableId: 'string'
logsIngestion: {}
metricsIngestion: {}
networkAcls: {
publicNetworkAccess: 'string'
}
}
}
Property values
dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | The geo-location where the resource lives. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of the resource. | 'Linux' 'Windows' |
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
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. | object |
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 |
DataCollectionEndpointConfigurationAccess
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointLogsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointMetricsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
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": "2022-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"configurationAccess": {},
"description": "string",
"immutableId": "string",
"logsIngestion": {},
"metricsIngestion": {},
"networkAcls": {
"publicNetworkAccess": "string"
}
}
}
Property values
dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Insights/dataCollectionEndpoints' |
| apiVersion | The resource api version | '2022-06-01' |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of the resource. | 'Linux' 'Windows' |
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
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. | object |
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 |
DataCollectionEndpointConfigurationAccess
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointLogsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointMetricsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
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@2022-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
configurationAccess = {}
description = "string"
immutableId = "string"
logsIngestion = {}
metricsIngestion = {}
networkAcls = {
publicNetworkAccess = "string"
}
}
kind = "string"
})
}
Property values
dataCollectionEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Insights/dataCollectionEndpoints@2022-06-01" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| kind | The kind of the resource. | "Linux" "Windows" |
| identity | Managed service identity of the resource. | DataCollectionEndpointResourceIdentity |
| properties | Resource properties. | DataCollectionEndpointResourceProperties |
DataCollectionEndpointResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required) |
| identity_ids | 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. | Array of user identity IDs. |
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 |
DataCollectionEndpointConfigurationAccess
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointLogsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointMetricsIngestion
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
DataCollectionEndpointNetworkAcls
| Name | Description | Value |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | "Disabled" "Enabled" "SecuredByPerimeter" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for