az monitor data-collection endpoint

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the monitor-control-service extension for the Azure CLI (version 2.15.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

az monitor data-collection endpoint create	Create a data collection endpoint.
az monitor data-collection endpoint delete	Delete a data collection endpoint.
az monitor data-collection endpoint list	List all data collection endpoints.
az monitor data-collection endpoint show	Show the specified data collection endpoint.
az monitor data-collection endpoint update	Update a data collection endpoint.

az monitor data-collection endpoint create

Create a data collection endpoint.

az monitor data-collection endpoint create --name
                                           --public-network-access {Disabled, Enabled}
                                           --resource-group
                                           [--description]
                                           [--kind {Linux, Windows}]
                                           [--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

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

accepted values: Disabled, Enabled

--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 data collection endpoint.

--kind

The kind of the resource.

accepted values: Linux, Windows

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--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 --name
                                           --resource-group
                                           [--yes]

Examples

Delete data collection endpoint

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

Required Parameters

--name -n

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

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

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.

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

az monitor data-collection endpoint list [--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

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

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

Show the specified data collection endpoint.

az monitor data-collection endpoint show --name
                                         --resource-group

Examples

Get data collection endpoint

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

Required Parameters

--name -n

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

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

--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 --name
                                           --resource-group
                                           [--description]
                                           [--kind {Linux, Windows}]
                                           [--public-network-access {Disabled, Enabled}]
                                           [--tags]

Examples

Update data collection endpoint

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

Required Parameters

--name -n

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

--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 data collection endpoint.

--kind

The kind of the resource.

accepted values: Linux, Windows

--public-network-access

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

accepted values: Disabled, Enabled

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

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