Monitors interface

Package:

@azure/arm-dynatrace

Interface representing a Monitors.

Methods

beginCreateOrUpdate(string, string, MonitorResource, MonitorsCreateOrUpdateOptionalParams)	Create a MonitorResource
beginCreateOrUpdateAndWait(string, string, MonitorResource, MonitorsCreateOrUpdateOptionalParams)	Create a MonitorResource
beginDelete(string, string, MonitorsDeleteOptionalParams)	Delete a MonitorResource
beginDeleteAndWait(string, string, MonitorsDeleteOptionalParams)	Delete a MonitorResource
get(string, string, MonitorsGetOptionalParams)	Get a MonitorResource
getMarketplaceSaaSResourceDetails(MarketplaceSaaSResourceDetailsRequest, MonitorsGetMarketplaceSaaSResourceDetailsOptionalParams)	Get Marketplace SaaS resource details of a tenant under a specific subscription
getMetricStatus(string, string, MonitorsGetMetricStatusOptionalParams)	Get metric status
getSSODetails(string, string, MonitorsGetSSODetailsOptionalParams)	Gets the SSO configuration details from the partner.
getVMHostPayload(string, string, MonitorsGetVMHostPayloadOptionalParams)	Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM.
listAppServices(string, string, MonitorsListAppServicesOptionalParams)	Gets list of App Services with Dynatrace PaaS OneAgent enabled
listByResourceGroup(string, MonitorsListByResourceGroupOptionalParams)	List MonitorResource resources by resource group
listBySubscriptionId(MonitorsListBySubscriptionIdOptionalParams)	List all MonitorResource by subscriptionId
listHosts(string, string, MonitorsListHostsOptionalParams)	List the VM/VMSS resources currently being monitored by the Dynatrace resource.
listLinkableEnvironments(string, string, LinkableEnvironmentRequest, MonitorsListLinkableEnvironmentsOptionalParams)	Gets all the Dynatrace environments that a user can link a azure resource to
listMonitoredResources(string, string, MonitorsListMonitoredResourcesOptionalParams)	List the resources currently being monitored by the Dynatrace monitor resource.
update(string, string, MonitorResourceUpdate, MonitorsUpdateOptionalParams)	Update a MonitorResource

Method Details

beginCreateOrUpdate(string, string, MonitorResource, MonitorsCreateOrUpdateOptionalParams)

Create a MonitorResource

function beginCreateOrUpdate(resourceGroupName: string, monitorName: string, resource: MonitorResource, options?: MonitorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<MonitorResource>, MonitorResource>>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

resource

MonitorResource

Resource create parameters.

options

MonitorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MonitorResource>, MonitorResource>>

beginCreateOrUpdateAndWait(string, string, MonitorResource, MonitorsCreateOrUpdateOptionalParams)

Create a MonitorResource

function beginCreateOrUpdateAndWait(resourceGroupName: string, monitorName: string, resource: MonitorResource, options?: MonitorsCreateOrUpdateOptionalParams): Promise<MonitorResource>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

resource

MonitorResource

Resource create parameters.

options

MonitorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MonitorResource>

beginDelete(string, string, MonitorsDeleteOptionalParams)

Delete a MonitorResource

function beginDelete(resourceGroupName: string, monitorName: string, options?: MonitorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, MonitorsDeleteOptionalParams)

Delete a MonitorResource

function beginDeleteAndWait(resourceGroupName: string, monitorName: string, options?: MonitorsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, MonitorsGetOptionalParams)

Get a MonitorResource

function get(resourceGroupName: string, monitorName: string, options?: MonitorsGetOptionalParams): Promise<MonitorResource>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsGetOptionalParams

The options parameters.

Returns

Promise<MonitorResource>

getMarketplaceSaaSResourceDetails(MarketplaceSaaSResourceDetailsRequest, MonitorsGetMarketplaceSaaSResourceDetailsOptionalParams)

Get Marketplace SaaS resource details of a tenant under a specific subscription

function getMarketplaceSaaSResourceDetails(request: MarketplaceSaaSResourceDetailsRequest, options?: MonitorsGetMarketplaceSaaSResourceDetailsOptionalParams): Promise<MarketplaceSaaSResourceDetailsResponse>

Parameters

request

MarketplaceSaaSResourceDetailsRequest

Tenant Id

options

MonitorsGetMarketplaceSaaSResourceDetailsOptionalParams

The options parameters.

Returns

Promise<MarketplaceSaaSResourceDetailsResponse>

getMetricStatus(string, string, MonitorsGetMetricStatusOptionalParams)

Get metric status

function getMetricStatus(resourceGroupName: string, monitorName: string, options?: MonitorsGetMetricStatusOptionalParams): Promise<MetricsStatusResponse>

Parameters

resourceGroupName

string

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

monitorName

string

Name of the Monitor resource

options

MonitorsGetMetricStatusOptionalParams

The options parameters.

Returns

Promise<MetricsStatusResponse>

getSSODetails(string, string, MonitorsGetSSODetailsOptionalParams)

Gets the SSO configuration details from the partner.

function getSSODetails(resourceGroupName: string, monitorName: string, options?: MonitorsGetSSODetailsOptionalParams): Promise<SSODetailsResponse>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsGetSSODetailsOptionalParams

The options parameters.

Returns

Promise<SSODetailsResponse>

getVMHostPayload(string, string, MonitorsGetVMHostPayloadOptionalParams)

Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM.

function getVMHostPayload(resourceGroupName: string, monitorName: string, options?: MonitorsGetVMHostPayloadOptionalParams): Promise<VMExtensionPayload>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsGetVMHostPayloadOptionalParams

The options parameters.

Returns

Promise<VMExtensionPayload>

listAppServices(string, string, MonitorsListAppServicesOptionalParams)

Gets list of App Services with Dynatrace PaaS OneAgent enabled

function listAppServices(resourceGroupName: string, monitorName: string, options?: MonitorsListAppServicesOptionalParams): PagedAsyncIterableIterator<AppServiceInfo, AppServiceInfo[], PageSettings>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsListAppServicesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AppServiceInfo, AppServiceInfo[], PageSettings>

listByResourceGroup(string, MonitorsListByResourceGroupOptionalParams)

List MonitorResource resources by resource group

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

Parameters

resourceGroupName

string

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

options

MonitorsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MonitorResource, MonitorResource[], PageSettings>

listBySubscriptionId(MonitorsListBySubscriptionIdOptionalParams)

List all MonitorResource by subscriptionId

function listBySubscriptionId(options?: MonitorsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<MonitorResource, MonitorResource[], PageSettings>

Parameters

options

MonitorsListBySubscriptionIdOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MonitorResource, MonitorResource[], PageSettings>

listHosts(string, string, MonitorsListHostsOptionalParams)

List the VM/VMSS resources currently being monitored by the Dynatrace resource.

function listHosts(resourceGroupName: string, monitorName: string, options?: MonitorsListHostsOptionalParams): PagedAsyncIterableIterator<VMInfo, VMInfo[], PageSettings>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsListHostsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VMInfo, VMInfo[], PageSettings>

listLinkableEnvironments(string, string, LinkableEnvironmentRequest, MonitorsListLinkableEnvironmentsOptionalParams)

Gets all the Dynatrace environments that a user can link a azure resource to

function listLinkableEnvironments(resourceGroupName: string, monitorName: string, request: LinkableEnvironmentRequest, options?: MonitorsListLinkableEnvironmentsOptionalParams): PagedAsyncIterableIterator<LinkableEnvironmentResponse, LinkableEnvironmentResponse[], PageSettings>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

request

LinkableEnvironmentRequest

The details of the linkable environment request.

options

MonitorsListLinkableEnvironmentsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LinkableEnvironmentResponse, LinkableEnvironmentResponse[], PageSettings>

listMonitoredResources(string, string, MonitorsListMonitoredResourcesOptionalParams)

List the resources currently being monitored by the Dynatrace monitor resource.

function listMonitoredResources(resourceGroupName: string, monitorName: string, options?: MonitorsListMonitoredResourcesOptionalParams): PagedAsyncIterableIterator<MonitoredResource, MonitoredResource[], PageSettings>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

options

MonitorsListMonitoredResourcesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MonitoredResource, MonitoredResource[], PageSettings>

update(string, string, MonitorResourceUpdate, MonitorsUpdateOptionalParams)

Update a MonitorResource

function update(resourceGroupName: string, monitorName: string, resource: MonitorResourceUpdate, options?: MonitorsUpdateOptionalParams): Promise<MonitorResource>

Parameters

resourceGroupName

string

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

monitorName

string

Monitor resource name

resource

MonitorResourceUpdate

The resource properties to be updated.

options

MonitorsUpdateOptionalParams

The options parameters.

Returns

Promise<MonitorResource>