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 Microsoft.Logz/monitors resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Logz/monitors@2022-01-01-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
logzOrganizationProperties: {
companyName: 'string'
enterpriseAppId: 'string'
singleSignOnUrl: 'string'
}
marketplaceSubscriptionStatus: 'string'
monitoringStatus: 'string'
planData: {
billingCycle: 'string'
effectiveDate: 'string'
planDetails: 'string'
usageType: 'string'
}
userInfo: {
emailAddress: 'string'
firstName: 'string'
lastName: 'string'
phoneNumber: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
IdentityProperties
| Name | Description | Value |
|---|---|---|
| type | 'SystemAssigned' 'UserAssigned' |
LogzMonitorResourceTags
| Name | Description | Value |
|---|
LogzOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyName | Name of the Logz organization. | string |
| enterpriseAppId | The Id of the Enterprise App used for Single sign on. | string |
| singleSignOnUrl | The login URL specific to this Logz Organization. | string |
Microsoft.Logz/monitors
| Name | Description | Value |
|---|---|---|
| identity | IdentityProperties | |
| location | string (required) | |
| name | The resource name | string (required) |
| properties | Properties specific to the monitor resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| logzOrganizationProperties | LogzOrganizationProperties | |
| marketplaceSubscriptionStatus | Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. | 'Active' 'Suspended' |
| monitoringStatus | Flag specifying if the resource monitoring is enabled or disabled. | 'Disabled' 'Enabled' |
| planData | PlanData | |
| userInfo | UserInfo |
PlanData
| Name | Description | Value |
|---|---|---|
| billingCycle | different billing cycles like MONTHLY/WEEKLY. this could be enum | string Constraints: Max length = 50 |
| effectiveDate | date when plan was applied | string |
| planDetails | plan id as published by Logz | string Constraints: Max length = 50 |
| usageType | different usage type like PAYG/COMMITTED. this could be enum | string Constraints: Max length = 50 |
UserInfo
| Name | Description | Value |
|---|---|---|
| emailAddress | Email of the user used by Logz for contacting them if needed | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First Name of the user | string Constraints: Max length = 50 |
| lastName | Last Name of the user | string Constraints: Max length = 50 |
| phoneNumber | Phone number of the user used by Logz for contacting them if needed | string Constraints: Max length = 40 |
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 Microsoft.Logz/monitors resource, add the following JSON to your template.
{
"type": "Microsoft.Logz/monitors",
"apiVersion": "2022-01-01-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"logzOrganizationProperties": {
"companyName": "string",
"enterpriseAppId": "string",
"singleSignOnUrl": "string"
},
"marketplaceSubscriptionStatus": "string",
"monitoringStatus": "string",
"planData": {
"billingCycle": "string",
"effectiveDate": "string",
"planDetails": "string",
"usageType": "string"
},
"userInfo": {
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
IdentityProperties
| Name | Description | Value |
|---|---|---|
| type | 'SystemAssigned' 'UserAssigned' |
LogzMonitorResourceTags
| Name | Description | Value |
|---|
LogzOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyName | Name of the Logz organization. | string |
| enterpriseAppId | The Id of the Enterprise App used for Single sign on. | string |
| singleSignOnUrl | The login URL specific to this Logz Organization. | string |
Microsoft.Logz/monitors
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-01-01-preview' |
| identity | IdentityProperties | |
| location | string (required) | |
| name | The resource name | string (required) |
| properties | Properties specific to the monitor resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Logz/monitors' |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| logzOrganizationProperties | LogzOrganizationProperties | |
| marketplaceSubscriptionStatus | Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. | 'Active' 'Suspended' |
| monitoringStatus | Flag specifying if the resource monitoring is enabled or disabled. | 'Disabled' 'Enabled' |
| planData | PlanData | |
| userInfo | UserInfo |
PlanData
| Name | Description | Value |
|---|---|---|
| billingCycle | different billing cycles like MONTHLY/WEEKLY. this could be enum | string Constraints: Max length = 50 |
| effectiveDate | date when plan was applied | string |
| planDetails | plan id as published by Logz | string Constraints: Max length = 50 |
| usageType | different usage type like PAYG/COMMITTED. this could be enum | string Constraints: Max length = 50 |
UserInfo
| Name | Description | Value |
|---|---|---|
| emailAddress | Email of the user used by Logz for contacting them if needed | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First Name of the user | string Constraints: Max length = 50 |
| lastName | Last Name of the user | string Constraints: Max length = 50 |
| phoneNumber | Phone number of the user used by Logz for contacting them if needed | string Constraints: Max length = 40 |
Usage Examples
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 Microsoft.Logz/monitors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Logz/monitors@2022-01-01-preview"
name = "string"
identity = {
type = "string"
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
logzOrganizationProperties = {
companyName = "string"
enterpriseAppId = "string"
singleSignOnUrl = "string"
}
marketplaceSubscriptionStatus = "string"
monitoringStatus = "string"
planData = {
billingCycle = "string"
effectiveDate = "string"
planDetails = "string"
usageType = "string"
}
userInfo = {
emailAddress = "string"
firstName = "string"
lastName = "string"
phoneNumber = "string"
}
}
})
}
Property Values
IdentityProperties
| Name | Description | Value |
|---|---|---|
| type | 'SystemAssigned' 'UserAssigned' |
LogzMonitorResourceTags
| Name | Description | Value |
|---|
LogzOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyName | Name of the Logz organization. | string |
| enterpriseAppId | The Id of the Enterprise App used for Single sign on. | string |
| singleSignOnUrl | The login URL specific to this Logz Organization. | string |
Microsoft.Logz/monitors
| Name | Description | Value |
|---|---|---|
| identity | IdentityProperties | |
| location | string (required) | |
| name | The resource name | string (required) |
| properties | Properties specific to the monitor resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Logz/monitors@2022-01-01-preview" |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| logzOrganizationProperties | LogzOrganizationProperties | |
| marketplaceSubscriptionStatus | Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. | 'Active' 'Suspended' |
| monitoringStatus | Flag specifying if the resource monitoring is enabled or disabled. | 'Disabled' 'Enabled' |
| planData | PlanData | |
| userInfo | UserInfo |
PlanData
| Name | Description | Value |
|---|---|---|
| billingCycle | different billing cycles like MONTHLY/WEEKLY. this could be enum | string Constraints: Max length = 50 |
| effectiveDate | date when plan was applied | string |
| planDetails | plan id as published by Logz | string Constraints: Max length = 50 |
| usageType | different usage type like PAYG/COMMITTED. this could be enum | string Constraints: Max length = 50 |
UserInfo
| Name | Description | Value |
|---|---|---|
| emailAddress | Email of the user used by Logz for contacting them if needed | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First Name of the user | string Constraints: Max length = 50 |
| lastName | Last Name of the user | string Constraints: Max length = 50 |
| phoneNumber | Phone number of the user used by Logz for contacting them if needed | string Constraints: Max length = 40 |