Using Azure monitor workbook templates as source for groups from template

Question

Using Azure monitor workbook templates as source for groups from template

Sriram J Iyer 0

Is use of workbook templates (not workbooks) as source for groups supported? It works well when I use workbook resource IDs, but I get this error when I use workbook template IDs. Is there a different format for templates? User's image

Pavan Minukuri 1,235 Reputation points Microsoft External Staff

2024-12-11T21:25:04.32+00:00
Hi @Sriram J Iyer
Based on the provided information, it seems that you are trying to use a workbook template as a source for groups in your project. While using workbook resource IDs works well, you are encountering an error when using workbook template IDs.

To answer your question, yes, using workbook templates as a source for groups is supported in some cases. However, the format for using workbook templates is different from using workbook resource IDs.

When using a workbook resource ID, you would use the following format:

"sourceContent":

However, when using a workbook template ID, you would use the following format:

"sourceContent":

Make sure that you are using the correct format for the type of source you are using. If you are still encountering errors, please provide more information about the specific error message you are receiving so that I can assist you further

Please let us know if you required anything.
Sriram J Iyer 0 Reputation points

2024-12-11T22:40:53.0133333+00:00

Hi @Pavan Minukuri Thanks for taking the time to answer my questions. Your summarization of the question is correct. It is awesome to know that it is supported. However, you lost me after that. You have the same JSON fragment for both workbook and workbook template. Moreover, I don't see "sourcecontent" anywhere in the schema https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json. I took a stab at it by changing loadFromTemplateId to sourceContent. No it did not go well. When I hit apply after changing in advance editor it hangs. So obviously a very bad guess. Please clarify where I would use sourceContent.
Sriram J Iyer 0 Reputation points

2024-12-12T19:44:27.5433333+00:00
Thanks for steps for schema validation. But going back to my original question, how do I set a workbook template as the source for a group? You suggested use correct format

"sourceContent":

Where should I use this format?

Pavan Minukuri 1,235 Microsoft External Staff

Sorry for the delay @Sriram J Iyer To set a workbook template as the source for a group in Azure Monitor Workbooks, use the JSON format in an Azure Resource Manager (ARM) template. In the template, define the content of your workbook in the "sourceContent" property.
Prepare Your Workbook JSON Export your workbook as JSON. Go to your workbook in the Azure portal, select Edit, and use the Export option to save it as a JSON file.

Define the ARM Template In your ARM template, reference the workbook JSON under the "sourceContent" property. Here’s a simple example of how to structure your ARM template.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "microsoft.insights/workbooks",
      "apiVersion": "2020-08-01",
      "name": "[parameters('workbookName')]",
      "location": "[parameters('location')]",
      "properties": {
        "displayName": "[parameters('displayName')]",
        "sourceContent": {
          // Place your exported workbook JSON here
          "version": "1.0",
          "items": [
            // Your workbook items go here
          ]
        },
        "category": "workbook"
      }
    }
  ],
  "parameters": {
    "workbookName": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}

You can deploy this ARM template using Azure CLI or PowerShell. For example, using Azure CLI:

az deployment group create --resource-group <your-resource-group> --template-file <path-to-your-template.json> --parameters workbookName=<your-workbook-name> location=<your-location> displayName=<your-display-name>

Please let us know if anything required.

Pavan Minukuri 1,235 Reputation points Microsoft External Staff

2024-12-19T16:16:51.53+00:00

Hi Sriram J Iyer
We haven't heard back from you. Please reply if you have any questions in this matter and we will gladly continue the discussion. Thankyou...!
Sriram J Iyer 0 Reputation points

2024-12-19T21:06:38.77+00:00

I have not yet tried creating a workbook as you have outlined above. But, I don't think it is going to help me. I embarked on groups because I have a rather massive workbook that I am trying to split into smaller workbooks templates simplify editing. Anyways, I will test it after the holiday break and get back.

1 answer

Your answer

Pavan Minukuri 1,235 Reputation points Microsoft External Staff

2024-12-11T21:25:04.32+00:00

Hi @Sriram J Iyer
Based on the provided information, it seems that you are trying to use a workbook template as a source for groups in your project. While using workbook resource IDs works well, you are encountering an error when using workbook template IDs.

To answer your question, yes, using workbook templates as a source for groups is supported in some cases. However, the format for using workbook templates is different from using workbook resource IDs.

When using a workbook resource ID, you would use the following format:

"sourceContent":

However, when using a workbook template ID, you would use the following format:

"sourceContent":

Make sure that you are using the correct format for the type of source you are using. If you are still encountering errors, please provide more information about the specific error message you are receiving so that I can assist you further

Please let us know if you required anything.
Sriram J Iyer 0 Reputation points

2024-12-11T22:40:53.0133333+00:00

Hi @Pavan Minukuri Thanks for taking the time to answer my questions. Your summarization of the question is correct. It is awesome to know that it is supported. However, you lost me after that. You have the same JSON fragment for both workbook and workbook template. Moreover, I don't see "sourcecontent" anywhere in the schema https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json. I took a stab at it by changing loadFromTemplateId to sourceContent. No it did not go well. When I hit apply after changing in advance editor it hangs. So obviously a very bad guess. Please clarify where I would use sourceContent.
Sriram J Iyer 0 Reputation points

2024-12-12T19:44:27.5433333+00:00

Thanks for steps for schema validation. But going back to my original question, how do I set a workbook template as the source for a group? You suggested use correct format

"sourceContent":

Where should I use this format?
Pavan Minukuri 1,235 Reputation points Microsoft External Staff

2024-12-18T20:52:54.7333333+00:00

Sorry for the delay @Sriram J Iyer To set a workbook template as the source for a group in Azure Monitor Workbooks, use the JSON format in an Azure Resource Manager (ARM) template. In the template, define the content of your workbook in the "sourceContent" property.
Prepare Your Workbook JSON Export your workbook as JSON. Go to your workbook in the Azure portal, select Edit, and use the Export option to save it as a JSON file.

Define the ARM Template In your ARM template, reference the workbook JSON under the "sourceContent" property. Here’s a simple example of how to structure your ARM template.

{ "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", "contentVersion": "1.0.0.0", "resources": [ { "type": "microsoft.insights/workbooks", "apiVersion": "2020-08-01", "name": "[parameters('workbookName')]", "location": "[parameters('location')]", "properties": { "displayName": "[parameters('displayName')]", "sourceContent": { // Place your exported workbook JSON here "version": "1.0", "items": [ // Your workbook items go here ] }, "category": "workbook" } } ], "parameters": { "workbookName": { "type": "string" }, "location": { "type": "string" }, "displayName": { "type": "string" } } }

You can deploy this ARM template using Azure CLI or PowerShell. For example, using Azure CLI:

az deployment group create --resource-group <your-resource-group> --template-file <path-to-your-template.json> --parameters workbookName=<your-workbook-name> location=<your-location> displayName=<your-display-name>

Please let us know if anything required.
Pavan Minukuri 1,235 Reputation points Microsoft External Staff

2024-12-19T16:16:51.53+00:00

Hi Sriram J Iyer
We haven't heard back from you. Please reply if you have any questions in this matter and we will gladly continue the discussion. Thankyou...!
Sriram J Iyer 0 Reputation points

2024-12-19T21:06:38.77+00:00

I have not yet tried creating a workbook as you have outlined above. But, I don't think it is going to help me. I embarked on groups because I have a rather massive workbook that I am trying to split into smaller workbooks templates simplify editing. Anyways, I will test it after the holiday break and get back.

Answer 1

Hi Sriram J Iyer
Thanks for reply back
To clarify the use of sourceContent in your JSON schema, first understand the schema's structure and purpose, especially for workbooks and workbook templates.
Understanding JSON schema structure:
1.JSON Schema Basics: A JSON schema defines the structure, required fields, and data types of a JSON object using keywords like $schema, type, properties, and required.

2.Using sourceContent : If sourceContent is not defined in your schema, it won't be recognized during validation. Define it explicitly in the properties section.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sourceContent": {
      "type": "string",
      "description": "The content source for the workbook"
    }
  },
  "required": ["sourceContent"]
}

3.Common Issues: Replacing loadFromTemplateId with sourceContent without defining sourceContent can cause errors or unexpected behavior. Ensure all properties are properly defined.

4.Debugging Steps:

Check if loadFromTemplateId is referenced elsewhere and ensure its functionality matches your intent for sourceContent.

Validate the updated schema using a validator tool to avoid syntax errors before applying changes.

If you required anything let us know.

Share via

Using Azure monitor workbook templates as source for groups from template

1 answer

Your answer