monitors

Creates, updates, deletes, gets or lists a monitors resource.

Overview

Name	monitors
Type	Resource
Id	azure_isv.newrelicobservability.monitors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountCreationSource	string	Source of account creation. Known values are: "LIFTR" and "NEWRELIC".
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	Liftr resource preference. The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionId	string	Marketplace Subscription Id.
marketplaceSubscriptionStatus	string	NewRelic Organization properties of the resource. Known values are: "Active" and "Suspended".
monitoringStatus	string	MonitoringStatus of the resource. Known values are: "Enabled" and "Disabled".
newRelicAccountProperties	object	MarketplaceSubscriptionStatus of the resource.
orgCreationSource	string	Source of org creation. Known values are: "LIFTR" and "NEWRELIC".
planData	object	Plan details.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
saaSData	object	SaaS details.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User Info.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountCreationSource	string	Source of account creation. Known values are: "LIFTR" and "NEWRELIC".
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	Liftr resource preference. The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionId	string	Marketplace Subscription Id.
marketplaceSubscriptionStatus	string	NewRelic Organization properties of the resource. Known values are: "Active" and "Suspended".
monitoringStatus	string	MonitoringStatus of the resource. Known values are: "Enabled" and "Disabled".
newRelicAccountProperties	object	MarketplaceSubscriptionStatus of the resource.
orgCreationSource	string	Source of org creation. Known values are: "LIFTR" and "NEWRELIC".
planData	object	Plan details.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
saaSData	object	SaaS details.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User Info.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountCreationSource	string	Source of account creation. Known values are: "LIFTR" and "NEWRELIC".
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	Liftr resource preference. The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionId	string	Marketplace Subscription Id.
marketplaceSubscriptionStatus	string	NewRelic Organization properties of the resource. Known values are: "Active" and "Suspended".
monitoringStatus	string	MonitoringStatus of the resource. Known values are: "Enabled" and "Disabled".
newRelicAccountProperties	object	MarketplaceSubscriptionStatus of the resource.
orgCreationSource	string	Source of org creation. Known values are: "LIFTR" and "NEWRELIC".
planData	object	Plan details.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
saaSData	object	SaaS details.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User Info.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, monitor_name, subscription_id		Retrieves the properties and configuration details of a specific New Relic monitor resource, providing insight into its setup and status.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieves a list of all New Relic monitor resources either a specific resource group.
list_by_subscription	select	subscription_id		Lists all New Relic monitor resources either within a specific subscription.
create_or_update	insert	resource_group_name, monitor_name, subscription_id, location		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.
update	update	resource_group_name, monitor_name, subscription_id		Updates an existing New Relic monitor resource from your Azure subscription.
create_or_update	replace	resource_group_name, monitor_name, subscription_id, location		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	delete	resource_group_name, monitor_name, subscription_id, userEmail		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.
list_app_services	exec	resource_group_name, monitor_name, subscription_id, userEmail		Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring.
list_hosts	exec	resource_group_name, monitor_name, subscription_id, userEmail		Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability.
list_monitored_resources	exec	resource_group_name, monitor_name, subscription_id		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.
list_linked_resources	exec	resource_group_name, monitor_name, subscription_id		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. 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.
get_metric_rules	exec	resource_group_name, monitor_name, subscription_id, userEmail		Retrieves the metric rules that are configured in the New Relic monitor resource.
get_metric_status	exec	resource_group_name, monitor_name, subscription_id, userEmail		Retrieves the metric status that are configured in the New Relic monitor resource.
switch_billing	exec	resource_group_name, monitor_name, subscription_id, userEmail		Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace.
refresh_ingestion_key	exec	resource_group_name, monitor_name, subscription_id		Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor.
vm_host_payload	exec	resource_group_name, monitor_name, subscription_id		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.
latest_linked_saa_s	exec	resource_group_name, monitor_name, subscription_id		Returns the latest SaaS linked to the newrelic organization of the underlying monitor.
link_saa_s	exec	resource_group_name, monitor_name, subscription_id		Links a new SaaS to the newrelic organization of the underlying monitor. Links a new SaaS to the newrelic organization of the underlying monitor.
resubscribe	exec	resource_group_name, monitor_name, subscription_id		Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace. Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
monitor_name	string	Monitor resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
userEmail	string	User Email. Required.

SELECT examples

get

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

SELECT
id,
name,
accountCreationSource,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionId,
marketplaceSubscriptionStatus,
monitoringStatus,
newRelicAccountProperties,
orgCreationSource,
planData,
provisioningState,
saaSAzureSubscriptionStatus,
saaSData,
subscriptionState,
systemData,
tags,
type,
userInfo
FROM azure_isv.newrelicobservability.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
accountCreationSource,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionId,
marketplaceSubscriptionStatus,
monitoringStatus,
newRelicAccountProperties,
orgCreationSource,
planData,
provisioningState,
saaSAzureSubscriptionStatus,
saaSData,
subscriptionState,
systemData,
tags,
type,
userInfo
FROM azure_isv.newrelicobservability.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all New Relic monitor resources either within a specific subscription.

SELECT
id,
name,
accountCreationSource,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionId,
marketplaceSubscriptionStatus,
monitoringStatus,
newRelicAccountProperties,
orgCreationSource,
planData,
provisioningState,
saaSAzureSubscriptionStatus,
saaSData,
subscriptionState,
systemData,
tags,
type,
userInfo
FROM azure_isv.newrelicobservability.monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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.

INSERT INTO azure_isv.newrelicobservability.monitors (
tags,
location,
identity,
properties,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the monitors resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the monitors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      newRelicAccountProperties:
        userId: "{{ userId }}"
        accountInfo:
          accountId: "{{ accountId }}"
          ingestionKey: "{{ ingestionKey }}"
          region: "{{ region }}"
        organizationInfo:
          organizationId: "{{ organizationId }}"
        singleSignOnProperties:
          singleSignOnState: "{{ singleSignOnState }}"
          enterpriseAppId: "{{ enterpriseAppId }}"
          singleSignOnUrl: "{{ singleSignOnUrl }}"
          provisioningState: "{{ provisioningState }}"
      userInfo:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        phoneNumber: "{{ phoneNumber }}"
        country: "{{ country }}"
      planData:
        usageType: "{{ usageType }}"
        billingCycle: "{{ billingCycle }}"
        planDetails: "{{ planDetails }}"
        effectiveDate: "{{ effectiveDate }}"
      saaSData:
        saaSResourceId: "{{ saaSResourceId }}"
      orgCreationSource: "{{ orgCreationSource }}"
      accountCreationSource: "{{ accountCreationSource }}"
      subscriptionState: "{{ subscriptionState }}"
      saaSAzureSubscriptionStatus: "{{ saaSAzureSubscriptionStatus }}"

UPDATE examples

update

Updates an existing New Relic monitor resource from your Azure subscription.

UPDATE azure_isv.newrelicobservability.monitors
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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.

REPLACE azure_isv.newrelicobservability.monitors
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

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 FROM azure_isv.newrelicobservability.monitors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND userEmail = '{{ userEmail }}' --required
;

Lifecycle Methods

list_app_services

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

EXEC azure_isv.newrelicobservability.monitors.list_app_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureResourceIds": "{{ azureResourceIds }}", 
"userEmail": "{{ userEmail }}"
}'
;

list_hosts

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

EXEC azure_isv.newrelicobservability.monitors.list_hosts 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"vmIds": "{{ vmIds }}", 
"userEmail": "{{ userEmail }}"
}'
;

list_monitored_resources

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.

EXEC azure_isv.newrelicobservability.monitors.list_monitored_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_linked_resources

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

EXEC azure_isv.newrelicobservability.monitors.list_linked_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_metric_rules

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

EXEC azure_isv.newrelicobservability.monitors.get_metric_rules 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"userEmail": "{{ userEmail }}"
}'
;

get_metric_status

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

EXEC azure_isv.newrelicobservability.monitors.get_metric_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureResourceIds": "{{ azureResourceIds }}", 
"userEmail": "{{ userEmail }}"
}'
;

switch_billing

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

EXEC azure_isv.newrelicobservability.monitors.switch_billing 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureResourceId": "{{ azureResourceId }}", 
"organizationId": "{{ organizationId }}", 
"planData": "{{ planData }}", 
"userEmail": "{{ userEmail }}"
}'
;

refresh_ingestion_key

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

EXEC azure_isv.newrelicobservability.monitors.refresh_ingestion_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

vm_host_payload

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.

EXEC azure_isv.newrelicobservability.monitors.vm_host_payload 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

latest_linked_saa_s

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

EXEC azure_isv.newrelicobservability.monitors.latest_linked_saa_s 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

link_saa_s

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

EXEC azure_isv.newrelicobservability.monitors.link_saa_s 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"saaSResourceId": "{{ saaSResourceId }}"
}'
;

resubscribe

Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace. Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace.

EXEC azure_isv.newrelicobservability.monitors.resubscribe 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"planId": "{{ planId }}", 
"termId": "{{ termId }}", 
"subscriptionId": "{{ subscriptionId }}", 
"resourceGroup": "{{ resourceGroup }}", 
"organizationId": "{{ organizationId }}", 
"publisherId": "{{ publisherId }}", 
"offerId": "{{ offerId }}"
}'
;