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

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of data collection endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionEndpoints)

list_by_resource_group

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of data collection endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionEndpoints)

list_by_subscription

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of data collection endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionEndpoints)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dataCollectionEndpointName
list_by_resource_group	select	subscriptionId, resourceGroupName
list_by_subscription	select	subscriptionId
create	insert	subscriptionId, resourceGroupName, dataCollectionEndpointName, data__location
update	update	subscriptionId, resourceGroupName, dataCollectionEndpointName
delete	delete	subscriptionId, resourceGroupName, dataCollectionEndpointName
reconcile_nsp	exec	subscriptionId, resourceGroupName, dataCollectionEndpointName, networkSecurityPerimeterConfigurationName

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
dataCollectionEndpointName	string	The name of the data collection endpoint. The name is case insensitive.
networkSecurityPerimeterConfigurationName	string	The name for a network security perimeter configuration
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataCollectionEndpointName = '{{ dataCollectionEndpointName }}' -- required
;

list_by_resource_group

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure.monitor.data_collection_endpoints (
data__properties,
data__location,
data__tags,
data__kind,
data__identity,
subscriptionId,
resourceGroupName,
dataCollectionEndpointName
)
SELECT 
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ kind }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataCollectionEndpointName }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_collection_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_collection_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_collection_endpoints resource.
    - name: dataCollectionEndpointName
      value: string
      description: Required parameter for the data_collection_endpoints resource.
    - name: properties
      value: object
      description: |
        Definition of data collection endpoint.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: kind
      value: string
      description: |
        The kind of the resource.
      valid_values: ['Linux', 'Windows']
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)

UPDATE examples

update

No description available.

UPDATE azure.monitor.data_collection_endpoints
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataCollectionEndpointName = '{{ dataCollectionEndpointName }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.monitor.data_collection_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataCollectionEndpointName = '{{ dataCollectionEndpointName }}' --required
;

Lifecycle Methods

reconcile_nsp

Request to reconcile the association accepted.

EXEC azure.monitor.data_collection_endpoints.reconcile_nsp 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataCollectionEndpointName='{{ dataCollectionEndpointName }}' --required, 
@networkSecurityPerimeterConfigurationName='{{ networkSecurityPerimeterConfigurationName }}' --required
;