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
|
The API version to use for this operation.
|
|
$expand
|
query |
|
string
|
Specifies whether to expand the values.
|
Responses
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
Sample Request
GET https://management.azure.com/providers/Microsoft.Authorization/providerOperations?api-version=2022-04-01
/** Samples for ProviderOperationsMetadata List. */
public final class Main {
/*
* x-ms-original-file:
* specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
* GetAllProviderOperations.json
*/
/**
* Sample code: List provider operations metadata for all resource providers.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
listProviderOperationsMetadataForAllResourceProviders(com.azure.resourcemanager.AzureResourceManager azure) {
azure.accessManagement().roleAssignments().manager().roleServiceClient().getProviderOperationsMetadatas()
.list(null, 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.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: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/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
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: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/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("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewProviderOperationsMetadataClient().NewListPager(&armauthorization.ProviderOperationsMetadataClientListOptions{Expand: 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.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
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: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetAllProviderOperations.json
*/
async function listProviderOperationsMetadataForAllResourceProviders() {
const credential = new DefaultAzureCredential();
const client = new AuthorizationManagementClient(credential);
const resArray = new Array();
for await (let item of client.providerOperationsMetadataOperations.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
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;
// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetAllProviderOperations.json
// this example is just showing the usage of "ProviderOperationsMetadata_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;
// get the collection of this AuthorizationProviderOperationsMetadataResource
AuthorizationProviderOperationsMetadataCollection collection = tenantResource.GetAllAuthorizationProviderOperationsMetadata();
// invoke the operation and iterate over the result
await foreach (AuthorizationProviderOperationsMetadataResource item in collection.GetAllAsync())
{
// the variable item 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
AuthorizationProviderOperationsMetadataData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"id": "id",
"name": "name",
"type": "type",
"displayName": "displayName",
"resourceTypes": [
{
"name": "name",
"displayName": "name",
"operations": []
}
],
"operations": []
}
]
}
Definitions
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.
|
ProviderOperation
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.
|
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.
|
Provider operations metadata list
| Name |
Type |
Description |
|
nextLink
|
string
|
The URL to use for getting the next set of results.
|
|
value
|
ProviderOperationsMetadata[]
|
The list of providers.
|
ResourceType
Resource Type
| Name |
Type |
Description |
|
displayName
|
string
|
The resource type display name.
|
|
name
|
string
|
The resource type name.
|
|
operations
|
ProviderOperation[]
|
The resource type operations.
|