Issue - Fetch Background Visualization

Service:: Monitor

API Version:: 2025-10-03

Fetch the background visualization of the issue

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}/issues/{issueName}/fetchBackgroundVisualization?api-version=2025-10-03

URI Parameters

Name	In	Required	Type	Description
azureMonitorWorkspaceName	path	True	string pattern: ^(?!-)[a-zA-Z0-9-]+[^-]$	The name of the Azure Monitor Workspace. The name is case insensitive
issueName	path	True	string pattern: ^(?!-)[a-zA-Z0-9-]+[^-]$	The name of the IssueResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BackgroundVisualization	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Issue_FetchBackgroundVisualization_MaximumSet

Sample request

POST https://management.azure.com/subscriptions/aceaa046-91f0-492a-96dc-45e10a9183dc/resourceGroups/rg1/providers/Microsoft.Monitor/accounts/myWorkspace/issues/3f29e1b2b05f8371595dc761fed8e8b3/fetchBackgroundVisualization?api-version=2025-10-03

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitorworkspaces import MonitorWorkspacesMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitorworkspaces
# USAGE
    python issue_fetch_background_visualization_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorWorkspacesMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.issue.fetch_background_visualization(
        resource_group_name="rg1",
        azure_monitor_workspace_name="myWorkspace",
        issue_name="3f29e1b2b05f8371595dc761fed8e8b3",
    )
    print(response)


# x-ms-original-file: 2025-10-03/Issue_FetchBackgroundVisualization_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitorworkspaces_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitorworkspaces"
)

// Generated from example definition: 2025-10-03/Issue_FetchBackgroundVisualization_MaximumSet_Gen.json
func ExampleIssueClient_FetchBackgroundVisualization() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitorworkspaces.NewClientFactory("aceaa046-91f0-492a-96dc-45e10a9183dc", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIssueClient().FetchBackgroundVisualization(ctx, "rg1", "myWorkspace", "3f29e1b2b05f8371595dc761fed8e8b3", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armmonitorworkspaces.IssueClientFetchBackgroundVisualizationResponse{
	// 	BackgroundVisualization: armmonitorworkspaces.BackgroundVisualization{
	// 		Visualization: to.Ptr("{\"type\":\"AdaptiveCard\",\"version\":\"1.3\",\"body\":[{\"type\":\"TextBlock\",\"text\":\"Issue Background Visualization\",\"size\":\"Large\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"This adaptive card provides background context for the issue including related metrics, logs, and diagnostic information.\",\"wrap\":true},{\"type\":\"FactSet\",\"facts\":[{\"title\":\"Affected Resources\",\"value\":\"5 virtual machines\"},{\"title\":\"Impact Duration\",\"value\":\"2 hours 15 minutes\"},{\"title\":\"Severity Level\",\"value\":\"High\"}]},{\"type\":\"Container\",\"items\":[{\"type\":\"TextBlock\",\"text\":\"Key Metrics\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"CPU Utilization: 95%\\nMemory Usage: 87%\\nDisk I/O: High\",\"wrap\":true}]}]}"),
	// 		Origin: &armmonitorworkspaces.Origin{
	// 			AddedBy: to.Ptr("171a811c-2a3a-4e6c-b742-f78f5f6ca51c"),
	// 			AddedByType: to.Ptr(armmonitorworkspaces.AddedByTypeManual),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitorworkspaces");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to fetch the background visualization of the issue
 *
 * @summary fetch the background visualization of the issue
 * x-ms-original-file: 2025-10-03/Issue_FetchBackgroundVisualization_MaximumSet_Gen.json
 */
async function issueFetchBackgroundVisualizationMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "aceaa046-91f0-492a-96dc-45e10a9183dc";
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.issue.fetchBackgroundVisualization(
    "rg1",
    "myWorkspace",
    "3f29e1b2b05f8371595dc761fed8e8b3",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "visualization": "{\"type\":\"AdaptiveCard\",\"version\":\"1.3\",\"body\":[{\"type\":\"TextBlock\",\"text\":\"Issue Background Visualization\",\"size\":\"Large\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"This adaptive card provides background context for the issue including related metrics, logs, and diagnostic information.\",\"wrap\":true},{\"type\":\"FactSet\",\"facts\":[{\"title\":\"Affected Resources\",\"value\":\"5 virtual machines\"},{\"title\":\"Impact Duration\",\"value\":\"2 hours 15 minutes\"},{\"title\":\"Severity Level\",\"value\":\"High\"}]},{\"type\":\"Container\",\"items\":[{\"type\":\"TextBlock\",\"text\":\"Key Metrics\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"CPU Utilization: 95%\\nMemory Usage: 87%\\nDisk I/O: High\",\"wrap\":true}]}]}",
  "origin": {
    "addedBy": "171a811c-2a3a-4e6c-b742-f78f5f6ca51c",
    "addedByType": "Manual"
  }
}

Definitions

Name	Description
AddedByType	The type of entity that added data to the issue
BackgroundVisualization	The issue background visualization
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Origin	Details about the origin of the entity - the source that added it to the issue

AddedByType

Enumeration

The type of entity that added data to the issue

Value	Description
Manual	The data was added manually by a user
Automatic	The data was added automatically

BackgroundVisualization

Object

The issue background visualization

Name	Type	Description
origin	Origin	The background visualization origin
visualization	string	The background visualization content, in Adaptive Card format

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Origin

Object

Details about the origin of the entity - the source that added it to the issue

Name	Type	Description
addedBy	string	The ID of the origin - for example, in case of 'Manual', the user ID/app ID, and in case of 'Automatic', the name of the automatic system
addedByType	AddedByType	The source of the origin - Manual or Automatic