MonitorsOperations interface

Package:

@azure/arm-newrelicobservability

Interface representing a Monitors operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginLinkSaaS
beginLinkSaaSAndWait
beginResubscribe
beginResubscribeAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Creates a new or updates an existing New Relic monitor resource in your Azure subscription. This sets up the integration between Azure and your New Relic account, enabling observability and monitoring of your Azure resources through New Relic
delete	Deletes an existing New Relic monitor resource from your Azure subscription, removing the integration and stopping the observability of your Azure resources through New Relic
get	Retrieves the properties and configuration details of a specific New Relic monitor resource, providing insight into its setup and status
getMetricRules	Retrieves the metric rules that are configured in the New Relic monitor resource
getMetricStatus	Retrieves the metric status that are configured in the New Relic monitor resource
latestLinkedSaaS	Returns the latest SaaS linked to the newrelic organization of the underlying monitor.
linkSaaS	Links a new SaaS to the newrelic organization of the underlying monitor.
listAppServices	Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring
listByResourceGroup	Retrieves a list of all New Relic monitor resources either a specific resource group
listBySubscription	Lists all New Relic monitor resources either within a specific subscription
listHosts	Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability
listLinkedResources	Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration
listMonitoredResources	Lists all Azure resources that are currently being monitored by the specified New Relic monitor resource, providing insight into the coverage of your observability setup
refreshIngestionKey	Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor.
resubscribe	A long-running resource action.
switchBilling	Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace
update	Updates an existing New Relic monitor resource from your Azure subscription
vmHostPayload	Returns the payload that needs to be passed in the request body for installing the New Relic agent on a VM, providing the necessary configuration details

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

(resourceGroupName: string, monitorName: string, resource: NewRelicMonitorResource, options?: MonitorsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, monitorName: string, resource: NewRelicMonitorResource, options?: MonitorsCreateOrUpdateOptionalParams) => Promise<NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, resource: NewRelicMonitorResource, options?: MonitorsCreateOrUpdateOptionalParams) => Promise<NewRelicMonitorResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, monitorName: string, userEmail: string, options?: MonitorsDeleteOptionalParams) => Promise<void>

beginLinkSaaS

Warning

This API is now deprecated.

use linkSaaS instead

beginLinkSaaS: (resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

Property Value

(resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

beginLinkSaaSAndWait

Warning

This API is now deprecated.

use linkSaaS instead

beginLinkSaaSAndWait: (resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => Promise<NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => Promise<NewRelicMonitorResource>

beginResubscribe

Warning

This API is now deprecated.

use resubscribe instead

beginResubscribe: (resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

beginResubscribeAndWait

Warning

This API is now deprecated.

use resubscribe instead

beginResubscribeAndWait: (resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => Promise<NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => Promise<NewRelicMonitorResource>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

Property Value

(resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => Promise<NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => Promise<NewRelicMonitorResource>

createOrUpdate

Creates a new or updates an existing New Relic monitor resource in your Azure subscription. This sets up the integration between Azure and your New Relic account, enabling observability and monitoring of your Azure resources through New Relic

createOrUpdate: (resourceGroupName: string, monitorName: string, resource: NewRelicMonitorResource, options?: MonitorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, resource: NewRelicMonitorResource, options?: MonitorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

delete

Deletes an existing New Relic monitor resource from your Azure subscription, removing the integration and stopping the observability of your Azure resources through New Relic

delete: (resourceGroupName: string, monitorName: string, userEmail: string, options?: MonitorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, monitorName: string, userEmail: string, options?: MonitorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the properties and configuration details of a specific New Relic monitor resource, providing insight into its setup and status

get: (resourceGroupName: string, monitorName: string, options?: MonitorsGetOptionalParams) => Promise<NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsGetOptionalParams) => Promise<NewRelicMonitorResource>

getMetricRules

Retrieves the metric rules that are configured in the New Relic monitor resource

getMetricRules: (resourceGroupName: string, monitorName: string, request: MetricsRequest, options?: MonitorsGetMetricRulesOptionalParams) => Promise<MetricRules>

Property Value

(resourceGroupName: string, monitorName: string, request: MetricsRequest, options?: MonitorsGetMetricRulesOptionalParams) => Promise<MetricRules>

getMetricStatus

Retrieves the metric status that are configured in the New Relic monitor resource

getMetricStatus: (resourceGroupName: string, monitorName: string, request: MetricsStatusRequest, options?: MonitorsGetMetricStatusOptionalParams) => Promise<MetricsStatusResponse>

Property Value

(resourceGroupName: string, monitorName: string, request: MetricsStatusRequest, options?: MonitorsGetMetricStatusOptionalParams) => Promise<MetricsStatusResponse>

latestLinkedSaaS

Returns the latest SaaS linked to the newrelic organization of the underlying monitor.

latestLinkedSaaS: (resourceGroupName: string, monitorName: string, options?: MonitorsLatestLinkedSaaSOptionalParams) => Promise<LatestLinkedSaaSResponse>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsLatestLinkedSaaSOptionalParams) => Promise<LatestLinkedSaaSResponse>

linkSaaS

Links a new SaaS to the newrelic organization of the underlying monitor.

linkSaaS: (resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, body: SaaSData, options?: MonitorsLinkSaaSOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

listAppServices

Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring

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

Property Value

(resourceGroupName: string, monitorName: string, request: AppServicesGetRequest, options?: MonitorsListAppServicesOptionalParams) => PagedAsyncIterableIterator<AppServiceInfo, AppServiceInfo[], PageSettings>

listByResourceGroup

Retrieves a list of all New Relic monitor resources either a specific resource group

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

Property Value

(resourceGroupName: string, options?: MonitorsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NewRelicMonitorResource, NewRelicMonitorResource[], PageSettings>

listBySubscription

Lists all New Relic monitor resources either within a specific subscription

listBySubscription: (options?: MonitorsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<NewRelicMonitorResource, NewRelicMonitorResource[], PageSettings>

Property Value

(options?: MonitorsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<NewRelicMonitorResource, NewRelicMonitorResource[], PageSettings>

listHosts

Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability

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

Property Value

(resourceGroupName: string, monitorName: string, request: HostsGetRequest, options?: MonitorsListHostsOptionalParams) => PagedAsyncIterableIterator<VMInfo, VMInfo[], PageSettings>

listLinkedResources

Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration

listLinkedResources: (resourceGroupName: string, monitorName: string, options?: MonitorsListLinkedResourcesOptionalParams) => PagedAsyncIterableIterator<LinkedResource, LinkedResource[], PageSettings>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsListLinkedResourcesOptionalParams) => PagedAsyncIterableIterator<LinkedResource, LinkedResource[], PageSettings>

listMonitoredResources

Lists all Azure resources that are currently being monitored by the specified New Relic monitor resource, providing insight into the coverage of your observability setup

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

Property Value

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

refreshIngestionKey

Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor.

refreshIngestionKey: (resourceGroupName: string, monitorName: string, options?: MonitorsRefreshIngestionKeyOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsRefreshIngestionKeyOptionalParams) => Promise<void>

resubscribe

A long-running resource action.

resubscribe: (resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsResubscribeOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

switchBilling

Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace

switchBilling: (resourceGroupName: string, monitorName: string, request: SwitchBillingRequest, options?: MonitorsSwitchBillingOptionalParams) => Promise<void | NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, request: SwitchBillingRequest, options?: MonitorsSwitchBillingOptionalParams) => Promise<void | NewRelicMonitorResource>

update

Updates an existing New Relic monitor resource from your Azure subscription

update: (resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

Property Value

(resourceGroupName: string, monitorName: string, properties: NewRelicMonitorResourceUpdate, options?: MonitorsUpdateOptionalParams) => PollerLike<OperationState<NewRelicMonitorResource>, NewRelicMonitorResource>

vmHostPayload

Returns the payload that needs to be passed in the request body for installing the New Relic agent on a VM, providing the necessary configuration details

vmHostPayload: (resourceGroupName: string, monitorName: string, options?: MonitorsVmHostPayloadOptionalParams) => Promise<VMExtensionPayload>

Property Value

(resourceGroupName: string, monitorName: string, options?: MonitorsVmHostPayloadOptionalParams) => Promise<VMExtensionPayload>