Provider Operations Metadata - List

Service:

Authorization

API Version:

2022-04-01

Gets provider operations metadata for all resource providers.

GET https://management.azure.com/providers/Microsoft.Authorization/providerOperations?api-version=2022-04-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Authorization/providerOperations?api-version=2022-04-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.
$expand	query		string	Specifies whether to expand the values.

Responses

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

Permissions

To call this API, you must be assigned a role that has the following permissions. For more information, see Azure built-in roles.

Microsoft.Authorization/providerOperations/read

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

List provider operations metadata for all resource providers

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Authorization/providerOperations?api-version=2022-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.authorization import AuthorizationManagementClient

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

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


# x-ms-original-file: 2022-04-01/GetAllProviderOperations.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 armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: 2022-04-01/GetAllProviderOperations.json
func ExampleProviderOperationsMetadataClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProviderOperationsMetadataClient().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 = armauthorization.ProviderOperationsMetadataClientListResponse{
		// 	ProviderOperationsMetadataListResult: armauthorization.ProviderOperationsMetadataListResult{
		// 		Value: []*armauthorization.ProviderOperationsMetadata{
		// 			{
		// 				Name: to.Ptr("name"),
		// 				Type: to.Ptr("type"),
		// 				DisplayName: to.Ptr("displayName"),
		// 				ID: to.Ptr("id"),
		// 				ResourceTypes: []*armauthorization.ResourceType{
		// 					{
		// 						Name: to.Ptr("name"),
		// 						DisplayName: to.Ptr("name"),
		// 						Operations: []*armauthorization.ProviderOperation{
		// 						},
		// 					},
		// 				},
		// 				Operations: []*armauthorization.ProviderOperation{
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets provider operations metadata for all resource providers.
 *
 * @summary gets provider operations metadata for all resource providers.
 * x-ms-original-file: 2022-04-01/GetAllProviderOperations.json
 */
async function listProviderOperationsMetadataForAllResourceProviders() {
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const resArray = new Array();
  for await (const item of client.providerOperationsMetadata.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": "name",
      "type": "type",
      "displayName": "displayName",
      "id": "id",
      "resourceTypes": [
        {
          "name": "name",
          "displayName": "name",
          "operations": []
        }
      ],
      "operations": []
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProviderOperation	Operation
ProviderOperationsMetadata	Provider Operations metadata
ProviderOperationsMetadataListResult	The response of a ProviderOperationsMetadata list operation.
ResourceType	Resource Type

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.

ProviderOperation

Object

Operation

Name	Type	Description
description	string	The operation description.
displayName	string	The operation display name.
isDataAction	boolean	The dataAction flag to specify the operation type.
name	string	The operation name.
origin	string	The operation origin.

ProviderOperationsMetadata

Object

Provider Operations metadata

Name	Type	Description
displayName	string	The provider display name.
id	string	The provider ID.
name	string	The provider name.
operations	ProviderOperation[]	The provider operations.
resourceTypes	ResourceType[]	The provider resource types
type	string	The provider type.

ProviderOperationsMetadataListResult

Object

The response of a ProviderOperationsMetadata list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	ProviderOperationsMetadata[]	The ProviderOperationsMetadata items on this page

ResourceType

Object

Resource Type

Name	Type	Description
displayName	string	The resource type display name.
name	string	The resource type name.
operations	ProviderOperation[]	The resource type operations.