Data Collection Endpoints - Create

Reference

Service:: Monitor

API Version:: 2022-06-01

Creates or updates a data collection endpoint.

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

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 or update data collection endpoint

Sample Request

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint?api-version=2022-06-01

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

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/examples/DataCollectionEndpointsCreate.json
func ExampleDataCollectionEndpointsClient_Create() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataCollectionEndpointsClient().Create(ctx, "myResourceGroup", "myCollectionEndpoint", &armmonitor.DataCollectionEndpointsClientCreateOptions{Body: &armmonitor.DataCollectionEndpointResource{
		Location: to.Ptr("eastus"),
		Properties: &armmonitor.DataCollectionEndpointResourceProperties{
			NetworkACLs: &armmonitor.DataCollectionEndpointNetworkACLs{
				PublicNetworkAccess: to.Ptr(armmonitor.KnownPublicNetworkAccessOptionsEnabled),
			},
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataCollectionEndpointResource = armmonitor.DataCollectionEndpointResource{
	// 	Name: to.Ptr("myCollectionEndpoint"),
	// 	Type: to.Ptr("Microsoft.Insights/dataCollectionEndpoints"),
	// 	Etag: to.Ptr("070057da-0000-0000-0000-5ba70d6c0000"),
	// 	ID: to.Ptr("/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armmonitor.DataCollectionEndpointResourceProperties{
	// 		ConfigurationAccess: &armmonitor.DataCollectionEndpointConfigurationAccess{
	// 			Endpoint: to.Ptr("https://mycollectionendpoint-abcd.eastus-1.control.monitor.azure.com"),
	// 		},
	// 		LogsIngestion: &armmonitor.DataCollectionEndpointLogsIngestion{
	// 			Endpoint: to.Ptr("https://mycollectionendpoint-abcd.eastus-1.ingest.monitor.azure.com"),
	// 		},
	// 		NetworkACLs: &armmonitor.DataCollectionEndpointNetworkACLs{
	// 			PublicNetworkAccess: to.Ptr(armmonitor.KnownPublicNetworkAccessOptionsEnabled),
	// 		},
	// 	},
	// 	SystemData: &armmonitor.DataCollectionEndpointResourceSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T12:34:56.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armmonitor.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T12:34:56.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armmonitor.CreatedByTypeUser),
	// 	},
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("A"),
	// 		"tag2": to.Ptr("B"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a data collection endpoint.
 *
 * @summary Creates or updates a data collection endpoint.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/examples/DataCollectionEndpointsCreate.json
 */
async function createOrUpdateDataCollectionEndpoint() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "703362b3-f278-4e4b-9179-c76eaf41ffc2";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "myResourceGroup";
  const dataCollectionEndpointName = "myCollectionEndpoint";
  const body = {
    location: "eastus",
    networkAcls: { publicNetworkAccess: "Enabled" },
  };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.dataCollectionEndpoints.create(
    resourceGroupName,
    dataCollectionEndpointName,
    options,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/examples/DataCollectionEndpointsCreate.json
// this example is just showing the usage of "DataCollectionEndpoints_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "703362b3-f278-4e4b-9179-c76eaf41ffc2";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DataCollectionEndpointResource
DataCollectionEndpointCollection collection = resourceGroupResource.GetDataCollectionEndpoints();

// invoke the operation
string dataCollectionEndpointName = "myCollectionEndpoint";
DataCollectionEndpointData data = new DataCollectionEndpointData(new AzureLocation("eastus"))
{
    PublicNetworkAccess = MonitorPublicNetworkAccess.Enabled,
};
ArmOperation<DataCollectionEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, dataCollectionEndpointName, data);
DataCollectionEndpointResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataCollectionEndpointData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint",
  "name": "myCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "configurationAccess": {
      "endpoint": "https://mycollectionendpoint-abcd.eastus-1.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mycollectionendpoint-abcd.eastus-1.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    }
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Status code:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint",
  "name": "myCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "configurationAccess": {
      "endpoint": "https://mycollectionendpoint-abcd.eastus-1.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mycollectionendpoint-abcd.eastus-1.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    }
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

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.
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.

Data Collection Endpoints - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or update data collection endpoint

Sample Request

Sample Response

Definitions

ConfigurationAccess

createdByType

DataCollectionEndpointResource

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

FailoverConfiguration

Identity

KnownDataCollectionEndpointProvisioningState

KnownDataCollectionEndpointResourceKind

KnownLocationSpecProvisioningStatus

KnownPublicNetworkAccessOptions

LocationSpec

LogsIngestion

ManagedServiceIdentityType

Metadata

MetricsIngestion

NetworkAcls

PrivateLinkScopedResource

SystemData

UserAssignedIdentity

Additional resources