monitors

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

Overview

Name	monitors
Type	Resource
Id	azure_isv.newrelic.monitors

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, monitorName		Get a NewRelicMonitorResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List NewRelicMonitorResource resources by resource group
list_by_subscription	select	subscriptionId		List NewRelicMonitorResource resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, monitorName, data__properties		Create a NewRelicMonitorResource
update	update	subscriptionId, resourceGroupName, monitorName		Update a NewRelicMonitorResource
delete	delete	subscriptionId, resourceGroupName, userEmail, monitorName		Delete a NewRelicMonitorResource
switch_billing	exec	subscriptionId, resourceGroupName, monitorName, userEmail		Switches the billing for NewRelic monitor resource.
refresh_ingestion_key	exec	subscriptionId, resourceGroupName, monitorName		Refreshes the ingestion key for all monitors linked to the same account associated to this monitor.
vm_host_payload	exec	subscriptionId, resourceGroupName, monitorName		Returns the payload that needs to be passed in the request body for installing NewRelic agent on a VM.
resubscribe	exec	subscriptionId, resourceGroupName, monitorName

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
monitorName	string	Monitor resource name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
userEmail	string	User Email.

SELECT examples

get

Get a NewRelicMonitorResource

SELECT
identity,
location,
properties,
tags
FROM azure_isv.newrelic.monitors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND monitorName = '{{ monitorName }}' -- required
;

list_by_resource_group

List NewRelicMonitorResource resources by resource group

SELECT
identity,
location,
properties,
tags
FROM azure_isv.newrelic.monitors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List NewRelicMonitorResource resources by subscription ID

SELECT
identity,
location,
properties,
tags
FROM azure_isv.newrelic.monitors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a NewRelicMonitorResource

INSERT INTO azure_isv.newrelic.monitors (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
monitorName
)
SELECT 
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ monitorName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: monitors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the monitors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the monitors resource.
    - name: monitorName
      value: string
      description: Required parameter for the monitors resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: identity
      value: object
      description: |
        The managed service identities assigned to this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a NewRelicMonitorResource

UPDATE azure_isv.newrelic.monitors
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND monitorName = '{{ monitorName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete a NewRelicMonitorResource

DELETE FROM azure_isv.newrelic.monitors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND userEmail = '{{ userEmail }}' --required
AND monitorName = '{{ monitorName }}' --required
;

Lifecycle Methods

switch_billing

Switches the billing for NewRelic monitor resource.

EXEC azure_isv.newrelic.monitors.switch_billing 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@monitorName='{{ monitorName }}' --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 this monitor.

EXEC azure_isv.newrelic.monitors.refresh_ingestion_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@monitorName='{{ monitorName }}' --required
;

vm_host_payload

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

EXEC azure_isv.newrelic.monitors.vm_host_payload 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@monitorName='{{ monitorName }}' --required
;

resubscribe

Success

EXEC azure_isv.newrelic.monitors.resubscribe 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@monitorName='{{ monitorName }}' --required 
@@json=
'{
"planId": "{{ planId }}", 
"termId": "{{ termId }}", 
"subscriptionId": "{{ subscriptionId }}", 
"resourceGroup": "{{ resourceGroup }}", 
"organizationId": "{{ organizationId }}", 
"publisherId": "{{ publisherId }}", 
"offerId": "{{ offerId }}"
}'
;