Operations - List

Service:

Managed Grafana

API Version:

2023-09-01

List all available API operations provided by Microsoft.Dashboard.

GET https://management.azure.com/providers/Microsoft.Dashboard/operations?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationListResult	OK. Return all available API operations provided by Microsoft.Dashboard.
Other Status Codes	ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Examples

Operations_List

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Dashboard/operations?api-version=2023-09-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dashboard import DashboardManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dashboard
# USAGE
    python operations_list.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 = DashboardManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.operations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2023-09-01/examples/Operations_List.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

Go

package armdashboard_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dashboard/armdashboard"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2023-09-01/examples/Operations_List.json
func ExampleOperationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdashboard.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationListResult = armdashboard.OperationListResult{
		// 	Value: []*armdashboard.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.Dashboard/grafana/write"),
		// 			ActionType: to.Ptr(armdashboard.ActionTypeInternal),
		// 			Display: &armdashboard.OperationDisplay{
		// 				Description: to.Ptr("Write grafana workspace resource"),
		// 				Operation: to.Ptr("write"),
		// 				Provider: to.Ptr("Microsoft.Dashboard"),
		// 				Resource: to.Ptr("grafana"),
		// 			},
		// 			Origin: to.Ptr(armdashboard.OriginUser),
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to List all available API operations provided by Microsoft.Dashboard.
 *
 * @summary List all available API operations provided by Microsoft.Dashboard.
 * x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2023-09-01/examples/Operations_List.json
 */
async function operationsList() {
  const subscriptionId =
    process.env["DASHBOARD_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new DashboardManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.operations.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "name": "Microsoft.Dashboard/grafana/write",
      "display": {
        "provider": "Microsoft.Dashboard",
        "resource": "grafana",
        "operation": "write",
        "description": "Write grafana workspace resource"
      },
      "origin": "user",
      "actionType": "Internal"
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
ActionType	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
Display	Localized display information for this particular operation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Operation	REST API Operation
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

ActionType

Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Name	Type	Description
Internal	string

Display

Localized display information for this particular operation.

Name	Type	Description
description	string	The short, localized friendly description of the operation; suitable for tool tips and detailed views.
operation	string	The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
provider	string	The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
resource	string	The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Operation

REST API Operation

Name	Type	Description
actionType	ActionType	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
display	Display	Localized display information for this particular operation.
isDataAction	boolean	Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
name	string	The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
origin	Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of operation list results (if there are any).
value	Operation[]	List of operations supported by the resource provider

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Name	Type	Description
system	string
user	string
user,system	string