Share via

DataCollectionEndpoints interface

  • Reference
Package:
@azure/arm-monitor

Interface representing a DataCollectionEndpoints.

Methods

create(string, string, DataCollectionEndpointsCreateOptionalParams)

Creates or updates a data collection endpoint.
delete(string, string, DataCollectionEndpointsDeleteOptionalParams)

Deletes a data collection endpoint.
get(string, string, DataCollectionEndpointsGetOptionalParams)

Returns the specified data collection endpoint.
listByResourceGroup(string, DataCollectionEndpointsListByResourceGroupOptionalParams)

Lists all data collection endpoints in the specified resource group.
listBySubscription(DataCollectionEndpointsListBySubscriptionOptionalParams)

Lists all data collection endpoints in the specified subscription
update(string, string, DataCollectionEndpointsUpdateOptionalParams)

Updates part of a data collection endpoint.

Method Details

create(string, string, DataCollectionEndpointsCreateOptionalParams)

Creates or updates a data collection endpoint.

function create(resourceGroupName: string, dataCollectionEndpointName: string, options?: DataCollectionEndpointsCreateOptionalParams): Promise<DataCollectionEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataCollectionEndpointName

string

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

options
DataCollectionEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<DataCollectionEndpointResource>

delete(string, string, DataCollectionEndpointsDeleteOptionalParams)

Deletes a data collection endpoint.

function delete(resourceGroupName: string, dataCollectionEndpointName: string, options?: DataCollectionEndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataCollectionEndpointName

string

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

options
DataCollectionEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DataCollectionEndpointsGetOptionalParams)

Returns the specified data collection endpoint.

function get(resourceGroupName: string, dataCollectionEndpointName: string, options?: DataCollectionEndpointsGetOptionalParams): Promise<DataCollectionEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataCollectionEndpointName

string

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

options
DataCollectionEndpointsGetOptionalParams

The options parameters.

Returns

Promise<DataCollectionEndpointResource>

listByResourceGroup(string, DataCollectionEndpointsListByResourceGroupOptionalParams)

Lists all data collection endpoints in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: DataCollectionEndpointsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DataCollectionEndpointResource, DataCollectionEndpointResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
DataCollectionEndpointsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataCollectionEndpointResource, DataCollectionEndpointResource[], PageSettings>

listBySubscription(DataCollectionEndpointsListBySubscriptionOptionalParams)

Lists all data collection endpoints in the specified subscription

function listBySubscription(options?: DataCollectionEndpointsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DataCollectionEndpointResource, DataCollectionEndpointResource[], PageSettings>

Parameters

options
DataCollectionEndpointsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataCollectionEndpointResource, DataCollectionEndpointResource[], PageSettings>

update(string, string, DataCollectionEndpointsUpdateOptionalParams)

Updates part of a data collection endpoint.

function update(resourceGroupName: string, dataCollectionEndpointName: string, options?: DataCollectionEndpointsUpdateOptionalParams): Promise<DataCollectionEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataCollectionEndpointName

string

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

options
DataCollectionEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<DataCollectionEndpointResource>