Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The monitors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a NewRelic.Observability/monitors resource, add the following Bicep to your template.
resource symbolicname 'NewRelic.Observability/monitors@2024-03-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
accountCreationSource: 'string'
newRelicAccountProperties: {
accountInfo: {
accountId: 'string'
ingestionKey: 'string'
region: 'string'
}
organizationInfo: {
organizationId: 'string'
}
singleSignOnProperties: {
enterpriseAppId: 'string'
provisioningState: 'string'
singleSignOnState: 'string'
singleSignOnUrl: 'string'
}
userId: 'string'
}
orgCreationSource: 'string'
planData: {
billingCycle: 'string'
effectiveDate: 'string'
planDetails: 'string'
usageType: 'string'
}
saaSAzureSubscriptionStatus: 'string'
subscriptionState: 'string'
userInfo: {
country: 'string'
emailAddress: 'string'
firstName: 'string'
lastName: 'string'
phoneNumber: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
NewRelic.Observability/monitors
Name | Description | Value |
---|---|---|
identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
location | The geo-location where the resource lives | string (required) |
name | The resource name | string (required) |
properties | The resource-specific properties for this resource. | MonitorProperties (required) |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AccountInfo
Name | Description | Value |
---|---|---|
accountId | Account id | string |
ingestionKey | ingestion key of account | string Constraints: Sensitive value. Pass in as a secure parameter. |
region | Region where New Relic account is present | string |
ManagedServiceIdentity
Name | Description | Value |
---|---|---|
type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
Name | Description | Value |
---|---|---|
accountCreationSource | Source of account creation | 'LIFTR' 'NEWRELIC' |
newRelicAccountProperties | MarketplaceSubscriptionStatus of the resource | NewRelicAccountProperties |
orgCreationSource | Source of org creation | 'LIFTR' 'NEWRELIC' |
planData | Plan details | PlanData |
saaSAzureSubscriptionStatus | Status of Azure Subscription where Marketplace SaaS is located. | string |
subscriptionState | State of the Azure Subscription containing the monitor resource | string |
userInfo | User Info | UserInfo |
NewRelicAccountProperties
Name | Description | Value |
---|---|---|
accountInfo | NewRelic Account Information | AccountInfo |
organizationInfo | NewRelic Organization Information | OrganizationInfo |
singleSignOnProperties | date when plan was applied | NewRelicSingleSignOnProperties |
userId | User id | string |
NewRelicSingleSignOnProperties
Name | Description | Value |
---|---|---|
enterpriseAppId | The Id of the Enterprise App used for Single sign-on. | string |
provisioningState | Provisioning state | 'Accepted' 'Canceled' 'Creating' 'Deleted' 'Deleting' 'Failed' 'NotSpecified' 'Succeeded' 'Updating' |
singleSignOnState | Single sign-on state | 'Disable' 'Enable' 'Existing' 'Initial' |
singleSignOnUrl | The login URL specific to this NewRelic Organization | string |
OrganizationInfo
Name | Description | Value |
---|---|---|
organizationId | Organization id | string |
PlanData
Name | Description | Value |
---|---|---|
billingCycle | Different billing cycles like Monthly/Weekly. | string |
effectiveDate | date when plan was applied | string |
planDetails | plan id as published by NewRelic | string |
usageType | Different usage type like PAYG/COMMITTED. this could be enum | 'COMMITTED' 'PAYG' |
TrackedResourceTags
Name | Description | Value |
---|
UserAssignedIdentities
Name | Description | Value |
---|
UserAssignedIdentity
Name | Description | Value |
---|
UserInfo
Name | Description | Value |
---|---|---|
country | country if user | string |
emailAddress | User Email | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
firstName | First name | string Constraints: Max length = 50 |
lastName | Last name | string Constraints: Max length = 50 |
phoneNumber | Contact phone number | string Constraints: Max length = 40 |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
Bicep File | Description |
---|---|
Create a Azure Native New Relic Resource | This template sets up an 'Azure Native New Relic Service' to monitor resources in your Azure subscription. |
ARM template resource definition
The monitors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a NewRelic.Observability/monitors resource, add the following JSON to your template.
{
"type": "NewRelic.Observability/monitors",
"apiVersion": "2024-03-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"accountCreationSource": "string",
"newRelicAccountProperties": {
"accountInfo": {
"accountId": "string",
"ingestionKey": "string",
"region": "string"
},
"organizationInfo": {
"organizationId": "string"
},
"singleSignOnProperties": {
"enterpriseAppId": "string",
"provisioningState": "string",
"singleSignOnState": "string",
"singleSignOnUrl": "string"
},
"userId": "string"
},
"orgCreationSource": "string",
"planData": {
"billingCycle": "string",
"effectiveDate": "string",
"planDetails": "string",
"usageType": "string"
},
"saaSAzureSubscriptionStatus": "string",
"subscriptionState": "string",
"userInfo": {
"country": "string",
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
NewRelic.Observability/monitors
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2024-03-01' |
identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
location | The geo-location where the resource lives | string (required) |
name | The resource name | string (required) |
properties | The resource-specific properties for this resource. | MonitorProperties (required) |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
type | The resource type | 'NewRelic.Observability/monitors' |
AccountInfo
Name | Description | Value |
---|---|---|
accountId | Account id | string |
ingestionKey | ingestion key of account | string Constraints: Sensitive value. Pass in as a secure parameter. |
region | Region where New Relic account is present | string |
ManagedServiceIdentity
Name | Description | Value |
---|---|---|
type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
Name | Description | Value |
---|---|---|
accountCreationSource | Source of account creation | 'LIFTR' 'NEWRELIC' |
newRelicAccountProperties | MarketplaceSubscriptionStatus of the resource | NewRelicAccountProperties |
orgCreationSource | Source of org creation | 'LIFTR' 'NEWRELIC' |
planData | Plan details | PlanData |
saaSAzureSubscriptionStatus | Status of Azure Subscription where Marketplace SaaS is located. | string |
subscriptionState | State of the Azure Subscription containing the monitor resource | string |
userInfo | User Info | UserInfo |
NewRelicAccountProperties
Name | Description | Value |
---|---|---|
accountInfo | NewRelic Account Information | AccountInfo |
organizationInfo | NewRelic Organization Information | OrganizationInfo |
singleSignOnProperties | date when plan was applied | NewRelicSingleSignOnProperties |
userId | User id | string |
NewRelicSingleSignOnProperties
Name | Description | Value |
---|---|---|
enterpriseAppId | The Id of the Enterprise App used for Single sign-on. | string |
provisioningState | Provisioning state | 'Accepted' 'Canceled' 'Creating' 'Deleted' 'Deleting' 'Failed' 'NotSpecified' 'Succeeded' 'Updating' |
singleSignOnState | Single sign-on state | 'Disable' 'Enable' 'Existing' 'Initial' |
singleSignOnUrl | The login URL specific to this NewRelic Organization | string |
OrganizationInfo
Name | Description | Value |
---|---|---|
organizationId | Organization id | string |
PlanData
Name | Description | Value |
---|---|---|
billingCycle | Different billing cycles like Monthly/Weekly. | string |
effectiveDate | date when plan was applied | string |
planDetails | plan id as published by NewRelic | string |
usageType | Different usage type like PAYG/COMMITTED. this could be enum | 'COMMITTED' 'PAYG' |
TrackedResourceTags
Name | Description | Value |
---|
UserAssignedIdentities
Name | Description | Value |
---|
UserAssignedIdentity
Name | Description | Value |
---|
UserInfo
Name | Description | Value |
---|---|---|
country | country if user | string |
emailAddress | User Email | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
firstName | First name | string Constraints: Max length = 50 |
lastName | Last name | string Constraints: Max length = 50 |
phoneNumber | Contact phone number | string Constraints: Max length = 40 |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
Template | Description |
---|---|
Create a Azure Native New Relic Resource |
This template sets up an 'Azure Native New Relic Service' to monitor resources in your Azure subscription. |
Terraform (AzAPI provider) resource definition
The monitors resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a NewRelic.Observability/monitors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "NewRelic.Observability/monitors@2024-03-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
accountCreationSource = "string"
newRelicAccountProperties = {
accountInfo = {
accountId = "string"
ingestionKey = "string"
region = "string"
}
organizationInfo = {
organizationId = "string"
}
singleSignOnProperties = {
enterpriseAppId = "string"
provisioningState = "string"
singleSignOnState = "string"
singleSignOnUrl = "string"
}
userId = "string"
}
orgCreationSource = "string"
planData = {
billingCycle = "string"
effectiveDate = "string"
planDetails = "string"
usageType = "string"
}
saaSAzureSubscriptionStatus = "string"
subscriptionState = "string"
userInfo = {
country = "string"
emailAddress = "string"
firstName = "string"
lastName = "string"
phoneNumber = "string"
}
}
}
}
Property Values
NewRelic.Observability/monitors
Name | Description | Value |
---|---|---|
identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
location | The geo-location where the resource lives | string (required) |
name | The resource name | string (required) |
properties | The resource-specific properties for this resource. | MonitorProperties (required) |
tags | Resource tags | Dictionary of tag names and values. |
type | The resource type | "NewRelic.Observability/monitors@2024-03-01" |
AccountInfo
Name | Description | Value |
---|---|---|
accountId | Account id | string |
ingestionKey | ingestion key of account | string Constraints: Sensitive value. Pass in as a secure parameter. |
region | Region where New Relic account is present | string |
ManagedServiceIdentity
Name | Description | Value |
---|---|---|
type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
Name | Description | Value |
---|---|---|
accountCreationSource | Source of account creation | 'LIFTR' 'NEWRELIC' |
newRelicAccountProperties | MarketplaceSubscriptionStatus of the resource | NewRelicAccountProperties |
orgCreationSource | Source of org creation | 'LIFTR' 'NEWRELIC' |
planData | Plan details | PlanData |
saaSAzureSubscriptionStatus | Status of Azure Subscription where Marketplace SaaS is located. | string |
subscriptionState | State of the Azure Subscription containing the monitor resource | string |
userInfo | User Info | UserInfo |
NewRelicAccountProperties
Name | Description | Value |
---|---|---|
accountInfo | NewRelic Account Information | AccountInfo |
organizationInfo | NewRelic Organization Information | OrganizationInfo |
singleSignOnProperties | date when plan was applied | NewRelicSingleSignOnProperties |
userId | User id | string |
NewRelicSingleSignOnProperties
Name | Description | Value |
---|---|---|
enterpriseAppId | The Id of the Enterprise App used for Single sign-on. | string |
provisioningState | Provisioning state | 'Accepted' 'Canceled' 'Creating' 'Deleted' 'Deleting' 'Failed' 'NotSpecified' 'Succeeded' 'Updating' |
singleSignOnState | Single sign-on state | 'Disable' 'Enable' 'Existing' 'Initial' |
singleSignOnUrl | The login URL specific to this NewRelic Organization | string |
OrganizationInfo
Name | Description | Value |
---|---|---|
organizationId | Organization id | string |
PlanData
Name | Description | Value |
---|---|---|
billingCycle | Different billing cycles like Monthly/Weekly. | string |
effectiveDate | date when plan was applied | string |
planDetails | plan id as published by NewRelic | string |
usageType | Different usage type like PAYG/COMMITTED. this could be enum | 'COMMITTED' 'PAYG' |
TrackedResourceTags
Name | Description | Value |
---|
UserAssignedIdentities
Name | Description | Value |
---|
UserAssignedIdentity
Name | Description | Value |
---|
UserInfo
Name | Description | Value |
---|---|---|
country | country if user | string |
emailAddress | User Email | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
firstName | First name | string Constraints: Max length = 50 |
lastName | Last name | string Constraints: Max length = 50 |
phoneNumber | Contact phone number | string Constraints: Max length = 40 |