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:
For a list of changed properties in each API version, see change log.
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"
}
}
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 |
Name | Description | Value |
---|---|---|
type | The identity type. | 'None' 'UserAssigned' |
userAssignedIdentities | Customer Managed Identity | MyWorkbookUserAssignedIdentities |
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |