Managed Dashboards - Update

Service:

Managed Grafana

API Version:

2024-11-01-preview

Update a dashboard for Grafana resource.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/dashboards/{dashboardName}?api-version=2024-11-01-preview

URI Parameters

Name	In	Required	Type	Description
dashboardName	path	True	string pattern: ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$	The name of the Azure Managed Dashboard.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
tags	object	The new tags of the managed dashboard resource.

Responses

Name	Type	Description
200 OK	ManagedDashboard	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

Dashboard_Update

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/dashboards/myDashboard?api-version=2024-11-01-preview

{
  "tags": {
    "Environment": "Dev 2"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Grafana.Models;
using Azure.ResourceManager.Grafana;

// Generated from example definition: 2024-11-01-preview/Dashboard_Update.json
// this example is just showing the usage of "ManagedDashboard_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedDashboardResource created on azure
// for more information of creating ManagedDashboardResource, please refer to the document of ManagedDashboardResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
string dashboardName = "myDashboard";
ResourceIdentifier managedDashboardResourceId = ManagedDashboardResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, dashboardName);
ManagedDashboardResource managedDashboard = client.GetManagedDashboardResource(managedDashboardResourceId);

// invoke the operation
ManagedDashboardPatch patch = new ManagedDashboardPatch
{
    Tags =
    {
    ["Environment"] = "Dev 2"
    },
};
ManagedDashboardResource result = await managedDashboard.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedDashboardData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "myDashboard",
  "type": "Microsoft.Dashboard/dashboards",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/dashboards/myDashboard",
  "location": "West US",
  "properties": {
    "provisioningState": "Succeeded"
  },
  "tags": {
    "Environment": "Dev 2"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedDashboard	The managed dashboard resource type.
ManagedDashboardUpdateParameters	The parameters for a PATCH request to a managed dashboard resource.
ProvisioningState
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

ManagedDashboard

Object

The managed dashboard resource type.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedDashboardUpdateParameters

Object

The parameters for a PATCH request to a managed dashboard resource.

Name	Type	Description
tags	object	The new tags of the managed dashboard resource.

ProvisioningState

Enumeration

Value	Description
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.