Microsoft.Insights myWorkbooks 2021-03-08
Bicep resource definition
The myWorkbooks resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
The myWorkbooks 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.Insights/myWorkbooks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Insights/myWorkbooks@2021-03-08' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
scope: resourceSymbolicName
etag: {}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
category: 'string'
displayName: 'string'
serializedData: 'string'
sourceId: 'string'
storageUri: 'string'
tags: [
'string'
]
version: 'string'
}
}
Property values
myWorkbooks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Resource location | string |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| etag | Resource etag | object |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
MyWorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MyWorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| displayName | The user-defined name of the private workbook. | string (required) |
| serializedData | Configuration of this particular private workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceId | Optional resourceId for a source resource. | string |
| storageUri | BYOS Storage Account URI | string |
| tags | A list of 0 or more tags that are associated with this private workbook definition | string[] |
| version | This instance's version of the data model. This can change as new features are added that can be marked private workbook. | string |
ARM template resource definition
The myWorkbooks resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
The myWorkbooks 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.Insights/myWorkbooks resource, add the following JSON to your template.
{
"type": "Microsoft.Insights/myWorkbooks",
"apiVersion": "2021-03-08",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"scope": "string",
"etag": {},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"category": "string",
"displayName": "string",
"serializedData": "string",
"sourceId": "string",
"storageUri": "string",
"tags": [ "string" ],
"version": "string"
}
}
Property values
myWorkbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Insights/myWorkbooks' |
| apiVersion | The resource api version | '2021-03-08' |
| name | The resource name | string (required) |
| location | Resource location | string |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
| etag | Resource etag | object |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
MyWorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MyWorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| displayName | The user-defined name of the private workbook. | string (required) |
| serializedData | Configuration of this particular private workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceId | Optional resourceId for a source resource. | string |
| storageUri | BYOS Storage Account URI | string |
| tags | A list of 0 or more tags that are associated with this private workbook definition | string[] |
| version | This instance's version of the data model. This can change as new features are added that can be marked private workbook. | string |
Terraform (AzAPI provider) resource definition
The myWorkbooks resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
The myWorkbooks 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.Insights/myWorkbooks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/myWorkbooks@2021-03-08"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
identity_ids = []
body = jsonencode({
properties = {
category = "string"
displayName = "string"
serializedData = "string"
sourceId = "string"
storageUri = "string"
tags = [
"string"
]
version = "string"
}
kind = "string"
etag = {}
type = "UserAssigned"
}
})
}
Property values
myWorkbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Insights/myWorkbooks@2021-03-08" |
| name | The resource name | string (required) |
| location | Resource location | string |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| kind | The kind of workbook. Choices are user and shared. | "shared" "user" |
| etag | Resource etag | object |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "UserAssigned" |
| identity_ids | Customer Managed Identity | Array of user identity IDs. |
MyWorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MyWorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| displayName | The user-defined name of the private workbook. | string (required) |
| serializedData | Configuration of this particular private workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceId | Optional resourceId for a source resource. | string |
| storageUri | BYOS Storage Account URI | string |
| tags | A list of 0 or more tags that are associated with this private workbook definition | string[] |
| version | This instance's version of the data model. This can change as new features are added that can be marked private workbook. | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for