az monitor data-collection endpoint

Reference

Note

This reference is part of the monitor-control-service extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az monitor data-collection endpoint command. Learn more about extensions.

Manage data collection endpoint for monitor control service.

Commands

Name	Description	Type	Status
az monitor data-collection endpoint association	Monitor data-collection endpoint association.	Extension	GA
az monitor data-collection endpoint association list	List associations for the specified data collection endpoint.	Extension	GA
az monitor data-collection endpoint create	Create a data collection endpoint.	Extension	GA
az monitor data-collection endpoint delete	Delete a data collection endpoint.	Extension	GA
az monitor data-collection endpoint list	List all data collection endpoints in the specified subscription.	Extension	GA
az monitor data-collection endpoint show	Get the specified data collection endpoint.	Extension	GA
az monitor data-collection endpoint update	Update a data collection endpoint.	Extension	GA

az monitor data-collection endpoint create

Create a data collection endpoint.

az monitor data-collection endpoint create --data-collection-endpoint-name
                                           --public-network-access
                                           --resource-group
                                           [--description]
                                           [--identity]
                                           [--kind]
                                           [--location]
                                           [--tags]

Examples

Create data collection endpoint

az monitor data-collection endpoint create -g "myResourceGroup" -l "eastus2euap" --name "myCollectionEndpoint" --public-network-access "Enabled"

Required Parameters

--data-collection-endpoint-name --name -n

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

--public-network-access

The configuration to set whether network access from public internet to the endpoints are allowed. Allowed values: Disabled, Enabled, SecuredByPerimeter.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--description

Description of the association.

--identity

Managed service identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--kind

The kind of the resource. Allowed values: Linux, Windows.

--location -l

The geo-location where the resource lives.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az monitor data-collection endpoint delete

Delete a data collection endpoint.

az monitor data-collection endpoint delete [--data-collection-endpoint-name]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete data collection endpoint

az monitor data-collection endpoint delete --name "myCollectionEndpoint" --resource-group "myResourceGroup"

Optional Parameters

--data-collection-endpoint-name --name -n

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az monitor data-collection endpoint list

List all data collection endpoints in the specified subscription.

az monitor data-collection endpoint list [--max-items]
                                         [--next-token]
                                         [--resource-group]

Examples

List data collection endpoints by resource group

az monitor data-collection endpoint list --resource-group "myResourceGroup"

List data collection endpoints by subscription

az monitor data-collection endpoint list

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az monitor data-collection endpoint show

Get the specified data collection endpoint.

az monitor data-collection endpoint show [--data-collection-endpoint-name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

Get data collection endpoint

az monitor data-collection endpoint show --name "myCollectionEndpoint" --resource-group "myResourceGroup"

Optional Parameters

--data-collection-endpoint-name --name -n

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

--ids

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az monitor data-collection endpoint update

Update a data collection endpoint.

az monitor data-collection endpoint update [--add]
                                           [--data-collection-endpoint-name]
                                           [--description]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--identity]
                                           [--ids]
                                           [--kind]
                                           [--public-network-access]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]
                                           [--tags]

Examples

Update data collection endpoint

az monitor data-collection endpoint update --tags tag1="A" tag2="B" tag3="C" --name "myCollectionEndpoint" --resource-group "myResourceGroup"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--data-collection-endpoint-name --name -n

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

--description

Description of the association.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--identity

Managed service identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

--kind

The kind of the resource. Allowed values: Linux, Windows.

--public-network-access

The configuration to set whether network access from public internet to the endpoints are allowed. Allowed values: Disabled, Enabled, SecuredByPerimeter.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via

az monitor data-collection endpoint

Commands

az monitor data-collection endpoint create

Examples

Required Parameters

Optional Parameters

az monitor data-collection endpoint delete

Examples

Optional Parameters

az monitor data-collection endpoint list

Examples

Optional Parameters

az monitor data-collection endpoint show

Examples

Optional Parameters

az monitor data-collection endpoint update

Examples

Optional Parameters

Additional resources