data_collection_endpoints

Creates, updates, deletes, gets or lists a data_collection_endpoints resource.

Overview

Name	data_collection_endpoints
Type	Resource
Id	azure.monitor.data_collection_endpoints

Fields

The following fields are returned by SELECT queries:

get_nsp

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.monitor.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.monitor.models.ResourceAssociation
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationAccess	object	The endpoint used by clients to access their configuration.
description	string	Description of the data collection endpoint.
etag	string	Resource entity tag (ETag).
failoverConfiguration	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
identity	object	Managed service identity of the resource.
immutableId	string	The immutable ID of this data collection endpoint resource. This property is READ-ONLY.
kind	string	The kind of the resource. Known values are: "Linux" and "Windows". (Linux, Windows)
location	string	The geo-location where the resource lives. Required.
logsIngestion	object	The endpoint used by clients to ingest logs.
metadata	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
metricsIngestion	object	The endpoint used by clients to ingest metrics.
networkAcls	object	Network access control rules for the endpoints.
privateLinkScopedResources	array	List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY.
provisioningState	string	The resource provisioning state. This property is READ-ONLY. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
sku	object	The SKU of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationAccess	object	The endpoint used by clients to access their configuration.
description	string	Description of the data collection endpoint.
etag	string	Resource entity tag (ETag).
failoverConfiguration	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
identity	object	Managed service identity of the resource.
immutableId	string	The immutable ID of this data collection endpoint resource. This property is READ-ONLY.
kind	string	The kind of the resource. Known values are: "Linux" and "Windows". (Linux, Windows)
location	string	The geo-location where the resource lives. Required.
logsIngestion	object	The endpoint used by clients to ingest logs.
metadata	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
metricsIngestion	object	The endpoint used by clients to ingest metrics.
networkAcls	object	Network access control rules for the endpoints.
privateLinkScopedResources	array	List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY.
provisioningState	string	The resource provisioning state. This property is READ-ONLY. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
sku	object	The SKU of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationAccess	object	The endpoint used by clients to access their configuration.
description	string	Description of the data collection endpoint.
etag	string	Resource entity tag (ETag).
failoverConfiguration	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
identity	object	Managed service identity of the resource.
immutableId	string	The immutable ID of this data collection endpoint resource. This property is READ-ONLY.
kind	string	The kind of the resource. Known values are: "Linux" and "Windows". (Linux, Windows)
location	string	The geo-location where the resource lives. Required.
logsIngestion	object	The endpoint used by clients to ingest logs.
metadata	object	Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.
metricsIngestion	object	The endpoint used by clients to ingest metrics.
networkAcls	object	Network access control rules for the endpoints.
privateLinkScopedResources	array	List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY.
provisioningState	string	The resource provisioning state. This property is READ-ONLY. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
sku	object	The SKU of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_nsp	select	resource_group_name, data_collection_endpoint_name, network_security_perimeter_configuration_name, subscription_id		Gets the specified NSP configuration for the specified data collection endpoint. Gets the specified NSP configuration for the specified data collection endpoint.
get	select	resource_group_name, data_collection_endpoint_name, subscription_id		Returns the specified data collection endpoint. Returns the specified data collection endpoint.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all data collection endpoints in the specified resource group. Lists all data collection endpoints in the specified resource group.
list_by_subscription	select	subscription_id		Lists all data collection endpoints in the specified subscription. Lists all data collection endpoints in the specified subscription.
create	insert	resource_group_name, data_collection_endpoint_name, subscription_id, location		Creates or updates a data collection endpoint. Creates or updates a data collection endpoint.
update	update	resource_group_name, data_collection_endpoint_name, subscription_id		Updates part of a data collection endpoint. Updates part of a data collection endpoint.
delete	delete	resource_group_name, data_collection_endpoint_name, subscription_id		Deletes a data collection endpoint. Deletes a data collection endpoint.
list_nsp	exec	resource_group_name, data_collection_endpoint_name, subscription_id		Gets a list of NSP configurations for the specified data collection endpoint. Gets a list of NSP configurations for the specified data collection endpoint.
reconcile_nsp	exec	resource_group_name, data_collection_endpoint_name, network_security_perimeter_configuration_name, subscription_id		Reconciles the specified NSP configuration for the specified data collection endpoint. Reconciles the specified NSP configuration for the specified data collection endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
data_collection_endpoint_name	string	The name of the data collection endpoint. The name is case insensitive. Required.
network_security_perimeter_configuration_name	string	The name for a network security perimeter configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_nsp

Gets the specified NSP configuration for the specified data collection endpoint. Gets the specified NSP configuration for the specified data collection endpoint.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.monitor.data_collection_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_collection_endpoint_name = '{{ data_collection_endpoint_name }}' -- required
AND network_security_perimeter_configuration_name = '{{ network_security_perimeter_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns the specified data collection endpoint. Returns the specified data collection endpoint.

SELECT
id,
name,
configurationAccess,
description,
etag,
failoverConfiguration,
identity,
immutableId,
kind,
location,
logsIngestion,
metadata,
metricsIngestion,
networkAcls,
privateLinkScopedResources,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_collection_endpoint_name = '{{ data_collection_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all data collection endpoints in the specified resource group. Lists all data collection endpoints in the specified resource group.

SELECT
id,
name,
configurationAccess,
description,
etag,
failoverConfiguration,
identity,
immutableId,
kind,
location,
logsIngestion,
metadata,
metricsIngestion,
networkAcls,
privateLinkScopedResources,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all data collection endpoints in the specified subscription. Lists all data collection endpoints in the specified subscription.

SELECT
id,
name,
configurationAccess,
description,
etag,
failoverConfiguration,
identity,
immutableId,
kind,
location,
logsIngestion,
metadata,
metricsIngestion,
networkAcls,
privateLinkScopedResources,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or updates a data collection endpoint. Creates or updates a data collection endpoint.

INSERT INTO azure.monitor.data_collection_endpoints (
tags,
location,
properties,
kind,
sku,
identity,
resource_group_name,
data_collection_endpoint_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ data_collection_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_collection_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_collection_endpoints resource.
  - name: data_collection_endpoint_name
    value: "{{ data_collection_endpoint_name }}"
    description: Required parameter for the data_collection_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_collection_endpoints resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      :vartype properties: ~azure.mgmt.monitor.models.DataCollectionEndpointResourceProperties
    value:
      description: "{{ description }}"
      immutableId: "{{ immutableId }}"
      configurationAccess:
        endpoint: "{{ endpoint }}"
      logsIngestion:
        endpoint: "{{ endpoint }}"
      metricsIngestion:
        endpoint: "{{ endpoint }}"
      networkAcls:
        publicNetworkAccess: "{{ publicNetworkAccess }}"
      provisioningState: "{{ provisioningState }}"
      privateLinkScopedResources:
        - resourceId: "{{ resourceId }}"
          scopeId: "{{ scopeId }}"
      failoverConfiguration:
        activeLocation: "{{ activeLocation }}"
        locations:
          - location: "{{ location }}"
            provisioningStatus: "{{ provisioningStatus }}"
      metadata:
        provisionedBy: "{{ provisionedBy }}"
        provisionedByResourceId: "{{ provisionedByResourceId }}"
        provisionedByImmutableId: "{{ provisionedByImmutableId }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the resource. Known values are: "Linux" and "Windows".
    valid_values: ['Linux', 'Windows']
  - name: sku
    description: |
      The SKU of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: identity
    description: |
      Managed service identity of the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates part of a data collection endpoint. Updates part of a data collection endpoint.

UPDATE azure.monitor.data_collection_endpoints
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND data_collection_endpoint_name = '{{ data_collection_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a data collection endpoint. Deletes a data collection endpoint.

DELETE FROM azure.monitor.data_collection_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND data_collection_endpoint_name = '{{ data_collection_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_nsp

Gets a list of NSP configurations for the specified data collection endpoint. Gets a list of NSP configurations for the specified data collection endpoint.

EXEC azure.monitor.data_collection_endpoints.list_nsp 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_collection_endpoint_name='{{ data_collection_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reconcile_nsp

Reconciles the specified NSP configuration for the specified data collection endpoint. Reconciles the specified NSP configuration for the specified data collection endpoint.

EXEC azure.monitor.data_collection_endpoints.reconcile_nsp 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_collection_endpoint_name='{{ data_collection_endpoint_name }}' --required, 
@network_security_perimeter_configuration_name='{{ network_security_perimeter_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;