Providers - Provider Permissions

Service:

Resource Management

API Version:

2021-04-01

Get the provider permissions.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/providerPermissions?api-version=2021-04-01

URI Parameters

Name	In	Required	Type	Description
resourceProviderNamespace	path	True	string	The namespace of the resource provider.
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ProviderPermissionListResult	OK - Returns information on the provider permissions.
Other Status Codes	CloudError	Error response describing why the operation failed.

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 provider resource types.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP/providerPermissions?api-version=2021-04-01

Go

package armresources_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderPermissions.json
func ExampleProvidersClient_ProviderPermissions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProvidersClient().ProviderPermissions(ctx, "Microsoft.TestRP", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProviderPermissionListResult = armresources.ProviderPermissionListResult{
	// 	Value: []*armresources.ProviderPermission{
	// 		{
	// 			ApplicationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			ProviderAuthorizationConsentState: to.Ptr(armresources.ProviderAuthorizationConsentStateConsented),
	// 			RoleDefinition: &armresources.RoleDefinition{
	// 				Name: to.Ptr("Contoso service role"),
	// 				ID: to.Ptr("00000000000000000000000000000000"),
	// 				IsServiceRole: to.Ptr(true),
	// 				Permissions: []*armresources.Permission{
	// 					{
	// 						Actions: []*string{
	// 							to.Ptr("Microsoft.Contoso/*")},
	// 							DataActions: []*string{
	// 							},
	// 							NotActions: []*string{
	// 							},
	// 							NotDataActions: []*string{
	// 							},
	// 					}},
	// 					Scopes: []*string{
	// 						to.Ptr("/")},
	// 					},
	// 			}},
	// 		}
}

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

/**
 * This sample demonstrates how to Get the provider permissions.
 *
 * @summary Get the provider permissions.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderPermissions.json
 */
async function getProviderResourceTypes() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceProviderNamespace = "Microsoft.TestRP";
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.providers.providerPermissions(resourceProviderNamespace);
  console.log(result);
}

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": [
    {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "roleDefinition": {
        "id": "00000000000000000000000000000000",
        "name": "Contoso service role",
        "isServiceRole": true,
        "permissions": [
          {
            "actions": [
              "Microsoft.Contoso/*"
            ],
            "notActions": [],
            "dataActions": [],
            "notDataActions": []
          }
        ],
        "scopes": [
          "/"
        ]
      },
      "providerAuthorizationConsentState": "Consented"
    }
  ]
}

Definitions

Name	Description
CloudError	An error response for a resource management request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
Permission	Role definition permissions.
ProviderAuthorizationConsentState	The provider authorization consent state.
ProviderPermission	The provider permission
ProviderPermissionListResult	List of provider permissions.
RoleDefinition	Role definition properties.

CloudError

An error response for a resource management request.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorResponse

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

Permission

Role definition permissions.

Name	Type	Description
actions	string[]	Allowed actions.
dataActions	string[]	Allowed Data actions.
notActions	string[]	Denied actions.
notDataActions	string[]	Denied Data actions.

ProviderAuthorizationConsentState

The provider authorization consent state.

Name	Type	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderPermission

The provider permission

Name	Type	Description
applicationId	string	The application id.
managedByRoleDefinition	RoleDefinition	Role definition properties.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	The provider authorization consent state.
roleDefinition	RoleDefinition	Role definition properties.

ProviderPermissionListResult

List of provider permissions.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	ProviderPermission[]	An array of provider permissions.

RoleDefinition

Role definition properties.

Name	Type	Description
id	string	The role definition ID.
isServiceRole	boolean	If this is a service role.
name	string	The role definition name.
permissions	Permission[]	Role definition permissions.
scopes	string[]	Role definition assignable scopes.