Data Collection Endpoints - Create

Creates or updates a data collection endpoint.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}?api-version=2023-03-11

URI Parameters

Name In Required Type Description
dataCollectionEndpointName
path True

string

The name of the data collection endpoint. The name is case insensitive.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
location True

string

The geo-location where the resource lives.

identity

Identity

Managed service identity of the resource.

kind

KnownDataCollectionEndpointResourceKind

The kind of the resource.

properties.configurationAccess

ConfigurationAccess

The endpoint used by clients to access their configuration.

properties.description

string

Description of the data collection endpoint.

properties.immutableId

string

The immutable ID of this data collection endpoint resource. This property is READ-ONLY.

properties.logsIngestion

LogsIngestion

The endpoint used by clients to ingest logs.

properties.metricsIngestion

MetricsIngestion

The endpoint used by clients to ingest metrics.

properties.networkAcls

NetworkAcls

Network access control rules for the endpoints.

tags

object

Resource tags.

Responses

Name Type Description
200 OK

DataCollectionEndpointResource

Data collection endpoint was successfully updated

201 Created

DataCollectionEndpointResource

Data collection endpoint was successfully created

Other Status Codes

ErrorResponseCommonV2

Error

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

Create a data collection endpoint
Update a data collection endpoint

Create a data collection endpoint

Sample request

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint?api-version=2023-03-11

{
  "location": "eastus",
  "properties": {
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    }
  }
}

Sample response

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:40:59.2431682Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}
{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:40:59.2431682Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

Update a data collection endpoint

Sample request

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint?api-version=2023-03-11

{
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "properties": {}
}

Sample response

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:51:04.551992Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}
{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:51:04.551992Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

Definitions

Name Description
ConfigurationAccess

The endpoint used by clients to access their configuration.

createdByType

The type of identity that created the resource.

DataCollectionEndpointResource

Definition of ARM tracked top level resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponseCommonV2

Error response

FailoverConfiguration

Failover configuration on this endpoint. This property is READ-ONLY.

Identity

Managed service identity of the resource.

KnownDataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.

KnownDataCollectionEndpointResourceKind

The kind of the resource.

KnownLocationSpecProvisioningStatus

The resource provisioning state in this location.

KnownPublicNetworkAccessOptions

The configuration to set whether network access from public internet to the endpoints are allowed.

LocationSpec
LogsIngestion

The endpoint used by clients to ingest logs.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Metadata

Metadata for the resource. This property is READ-ONLY.

MetricsIngestion

The endpoint used by clients to ingest metrics.

NetworkAcls

Network access control rules for the endpoints.

PrivateLinkScopedResource
SystemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

User assigned identity properties

ConfigurationAccess

The endpoint used by clients to access their configuration.

Name Type Description
endpoint

string

The endpoint. This property is READ-ONLY.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataCollectionEndpointResource

Definition of ARM tracked top level resource.

Name Type Description
etag

string

Resource entity tag (ETag).

id

string

Fully qualified ID of the resource.

identity

Identity

Managed service identity of the resource.

kind

KnownDataCollectionEndpointResourceKind

The kind of the resource.

location

string

The geo-location where the resource lives.

name

string

The name of the resource.

properties.configurationAccess

ConfigurationAccess

The endpoint used by clients to access their configuration.

properties.description

string

Description of the data collection endpoint.

properties.failoverConfiguration

FailoverConfiguration

Failover configuration on this endpoint. This property is READ-ONLY.

properties.immutableId

string

The immutable ID of this data collection endpoint resource. This property is READ-ONLY.

properties.logsIngestion

LogsIngestion

The endpoint used by clients to ingest logs.

properties.metadata

Metadata

Metadata for the resource. This property is READ-ONLY.

properties.metricsIngestion

MetricsIngestion

The endpoint used by clients to ingest metrics.

properties.networkAcls

NetworkAcls

Network access control rules for the endpoints.

properties.privateLinkScopedResources

PrivateLinkScopedResource[]

List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY.

properties.provisioningState

KnownDataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.

systemData

SystemData

Metadata pertaining to creation and last modification of the resource.

tags

object

Resource tags.

type

string

The type of the resource.

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

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponseCommonV2

Error response

Name Type Description
error

ErrorDetail

The error object.

FailoverConfiguration

Failover configuration on this endpoint. This property is READ-ONLY.

Name Type Description
activeLocation

string

Active location where data flow will occur.

locations

LocationSpec[]

Locations that are configured for failover.

Identity

Managed service identity of the resource.

Name Type Description
principalId

string

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId

string

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identities
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.

KnownDataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

KnownDataCollectionEndpointResourceKind

The kind of the resource.

Name Type Description
Linux

string

Windows

string

KnownLocationSpecProvisioningStatus

The resource provisioning state in this location.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

KnownPublicNetworkAccessOptions

The configuration to set whether network access from public internet to the endpoints are allowed.

Name Type Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

LocationSpec

Name Type Description
location

string

Name of location.

provisioningStatus

KnownLocationSpecProvisioningStatus

The resource provisioning state in this location.

LogsIngestion

The endpoint used by clients to ingest logs.

Name Type Description
endpoint

string

The endpoint. This property is READ-ONLY.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

Metadata

Metadata for the resource. This property is READ-ONLY.

Name Type Description
provisionedBy

string

Azure offering managing this resource on-behalf-of customer.

provisionedByImmutableId

string

Immutable Id of azure offering managing this resource on-behalf-of customer.

provisionedByResourceId

string

Resource Id of azure offering managing this resource on-behalf-of customer.

MetricsIngestion

The endpoint used by clients to ingest metrics.

Name Type Description
endpoint

string

The endpoint. This property is READ-ONLY.

NetworkAcls

Network access control rules for the endpoints.

Name Type Description
publicNetworkAccess

KnownPublicNetworkAccessOptions

The configuration to set whether network access from public internet to the endpoints are allowed.

PrivateLinkScopedResource

Name Type Description
resourceId

string

The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.

scopeId

string

The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

SystemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentity

User assigned identity properties

Name Type Description
clientId

string

The client ID of the assigned identity.

principalId

string

The principal ID of the assigned identity.