Maps - List Subscription Operations

Reference

Service:: Maps Management

API Version:: 2023-06-01

List operations available for the Maps Resource Provider

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Maps/operations?api-version=2023-06-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	MapsOperations	The request was successful.
Other Status Codes	ErrorResponse	An unexpected error occurred.

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

Get Operations by Subscription

Sample Request

GET https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/providers/Microsoft.Maps/operations?api-version=2023-06-01

/** Samples for Maps List. */
public final class Main {
    /*
     * x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/GetOperationsSubscription.json
     */
    /**
     * Sample code: Get Operations by Subscription.
     *
     * @param manager Entry point to AzureMapsManager.
     */
    public static void getOperationsBySubscription(com.azure.resourcemanager.maps.AzureMapsManager manager) {
        manager.maps().list(com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.maps import AzureMapsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maps
# USAGE
    python get_operations_subscription.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 = AzureMapsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="21a9967a-e8a9-4656-a70b-96ff1c4d05a0",
    )

    response = client.maps.list_subscription_operations()
    for item in response:
        print(item)


# x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/GetOperationsSubscription.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 armmaps_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/maps/armmaps"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9403296f0b0e112b0d8222ad05fd1d79ee10e03/specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/GetOperationsSubscription.json
func ExampleClient_NewListSubscriptionOperationsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmaps.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListSubscriptionOperationsPager(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.Operations = armmaps.Operations{
		// 	Value: []*armmaps.OperationDetail{
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/register/action"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Register the provider"),
		// 				Operation: to.Ptr("Register the provider"),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/write"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Create or update a Maps Account."),
		// 				Operation: to.Ptr("Create or update a Maps Account."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/read"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Get a Maps Account."),
		// 				Operation: to.Ptr("Get a Maps Account."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/delete"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Delete a Maps Account."),
		// 				Operation: to.Ptr("Delete a Maps Account."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/listKeys/action"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("List Maps Account keys"),
		// 				Operation: to.Ptr("List keys"),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/regenerateKey/action"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Generate new Maps Account primary or secondary key"),
		// 				Operation: to.Ptr("Generate new primary or secondary key"),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Maps Account"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/creators/write"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Create or update a Maps Creator."),
		// 				Operation: to.Ptr("Create or update a Maps Creator."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Creator"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/creators/read"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Get a Maps Creator."),
		// 				Operation: to.Ptr("Get a Maps Creator."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Creator"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Maps/accounts/creators/delete"),
		// 			Display: &armmaps.OperationDisplay{
		// 				Description: to.Ptr("Delete a Maps Creator."),
		// 				Operation: to.Ptr("Delete a Maps Creator."),
		// 				Provider: to.Ptr("Microsoft Maps"),
		// 				Resource: to.Ptr("Creator"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to List operations available for the Maps Resource Provider
 *
 * @summary List operations available for the Maps Resource Provider
 * x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/GetOperationsSubscription.json
 */
async function getOperationsBySubscription() {
  const subscriptionId =
    process.env["MAPS_SUBSCRIPTION_ID"] || "21a9967a-e8a9-4656-a70b-96ff1c4d05a0";
  const credential = new DefaultAzureCredential();
  const client = new AzureMapsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.maps.listSubscriptionOperations()) {
    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.Maps/register/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "Register the provider",
        "description": "Register the provider"
      }
    },
    {
      "name": "Microsoft.Maps/accounts/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "Create or update a Maps Account.",
        "description": "Create or update a Maps Account."
      }
    },
    {
      "name": "Microsoft.Maps/accounts/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "Get a Maps Account.",
        "description": "Get a Maps Account."
      }
    },
    {
      "name": "Microsoft.Maps/accounts/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "Delete a Maps Account.",
        "description": "Delete a Maps Account."
      }
    },
    {
      "name": "Microsoft.Maps/accounts/listKeys/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "List keys",
        "description": "List Maps Account keys"
      }
    },
    {
      "name": "Microsoft.Maps/accounts/regenerateKey/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Maps Account",
        "operation": "Generate new primary or secondary key",
        "description": "Generate new Maps Account primary or secondary key"
      }
    },
    {
      "name": "Microsoft.Maps/accounts/creators/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Creator",
        "operation": "Create or update a Maps Creator.",
        "description": "Create or update a Maps Creator."
      }
    },
    {
      "name": "Microsoft.Maps/accounts/creators/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Creator",
        "operation": "Get a Maps Creator.",
        "description": "Get a Maps Creator."
      }
    },
    {
      "name": "Microsoft.Maps/accounts/creators/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Maps",
        "resource": "Creator",
        "operation": "Delete a Maps Creator.",
        "description": "Delete a Maps Creator."
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
Dimension	Dimension of map account, for example API Category, Api Name, Result Type, and Response Code.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MapsOperations	The set of operations available for Maps.
MetricSpecification	Metric specification of operation.
OperationDetail	Operation detail payload
OperationDisplay	Operation display payload
ServiceSpecification	One property of operation, include metric specifications.

Dimension

Dimension of map account, for example API Category, Api Name, Result Type, and Response Code.

Name	Type	Description
displayName	string	Display name of dimension.
internalMetricName	string	Internal metric name of the dimension.
internalName	string	Internal name of the dimension.
name	string	Display name of dimension.
sourceMdmNamespace	string	Source Mdm Namespace of the dimension.
toBeExportedToShoebox	boolean	Flag to indicate exporting to Azure Monitor.

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.

MapsOperations

The set of operations available for Maps.

Name	Type	Description
nextLink	string	URL client should use to fetch the next page (per server side paging). It's null for now, added for future use.
value	OperationDetail[]	An operation available for Maps.

MetricSpecification

Metric specification of operation.

Name	Type	Description
aggregationType	string	Aggregation type could be Average.
category	string	The category this metric specification belong to, could be Capacity.
dimensions	Dimension[]	Dimensions of map account.
displayDescription	string	Display description of metric specification.
displayName	string	Display name of metric specification.
fillGapWithZero	boolean	The property to decide fill gap with zero or not.
internalMetricName	string	Internal metric name.
lockAggregationType	string	Lock aggregation type for metrics.
name	string	Name of metric specification.
resourceIdDimensionNameOverride	string	Account Resource Id.
sourceMdmAccount	string	Source metrics account.
sourceMdmNamespace	string	Metrics namespace.
supportedAggregationTypes	string	Allowed aggregation types for metrics.
unit	string	Unit could be Count.

OperationDetail

Operation detail payload

Name	Type	Description
display	OperationDisplay	Display of the operation
isDataAction	boolean	Indicates whether the operation is a data action
name	string	Name of the operation
origin	string	Origin of the operation
properties.serviceSpecification	ServiceSpecification	One property of operation, include metric specifications.

OperationDisplay

Operation display payload

Name	Type	Description
description	string	Localized friendly description for the operation
operation	string	Localized friendly name for the operation
provider	string	Resource provider of the operation
resource	string	Resource of the operation

ServiceSpecification

One property of operation, include metric specifications.

Name	Type	Description
metricSpecifications	MetricSpecification[]	Metric specifications of operation.

Maps - List Subscription Operations

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Operations by Subscription

Sample Request

Sample Response

Definitions

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MapsOperations

MetricSpecification

OperationDetail

OperationDisplay

ServiceSpecification

Additional resources