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 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' = {
etag: {
{customized property}: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
category: 'string'
displayName: 'string'
serializedData: 'string'
sourceId: 'string'
storageUri: 'string'
tags: [
'string'
]
version: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Insights/myWorkbooks
| Name | Description | Value |
|---|---|---|
| etag | Resource etag | MyWorkbookResourceEtag |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
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 |
MyWorkbookResourceEtag
| Name | Description | Value |
|---|
MyWorkbookResourceTags
| Name | Description | Value |
|---|
MyWorkbookUserAssignedIdentities
| Name | Description | Value |
|---|
ARM template resource definition
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",
"etag": {
"{customized property}": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
}
},
"kind": "string",
"location": "string",
"properties": {
"category": "string",
"displayName": "string",
"serializedData": "string",
"sourceId": "string",
"storageUri": "string",
"tags": [ "string" ],
"version": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Insights/myWorkbooks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-03-08' |
| etag | Resource etag | MyWorkbookResourceEtag |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Insights/myWorkbooks' |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
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 |
MyWorkbookResourceEtag
| Name | Description | Value |
|---|
MyWorkbookResourceTags
| Name | Description | Value |
|---|
MyWorkbookUserAssignedIdentities
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
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"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = {
{customized property} = "string"
}
kind = "string"
properties = {
category = "string"
displayName = "string"
serializedData = "string"
sourceId = "string"
storageUri = "string"
tags = [
"string"
]
version = "string"
}
}
}
Property Values
Microsoft.Insights/myWorkbooks
| Name | Description | Value |
|---|---|---|
| etag | Resource etag | MyWorkbookResourceEtag |
| identity | Identity used for BYOS | MyWorkbookManagedIdentity |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Metadata describing a workbook for an Azure resource. | MyWorkbookProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Insights/myWorkbooks@2021-03-08" |
MyWorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
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 |
MyWorkbookResourceEtag
| Name | Description | Value |
|---|
MyWorkbookResourceTags
| Name | Description | Value |
|---|
MyWorkbookUserAssignedIdentities
| Name | Description | Value |
|---|