Role Definitions - List

Service:

Authorization

API Version:

2022-04-01

Dapatkan semua definisi peran yang berlaku pada cakupan dan di atasnya.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
scope	path	True	string	Cakupan definisi peran.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
$filter	query		string	Filter yang akan diterapkan pada operasi. Gunakan filter atScopeAndBelow untuk mencari di bawah cakupan yang diberikan juga.

Respons

Nama	Jenis	Deskripsi
200 OK	RoleDefinitionListResult	OK - Mengembalikan array definisi peran.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Izin

Untuk memanggil API ini, Anda harus diberi peran yang memiliki izin berikut. Untuk informasi selengkapnya, lihat Peran bawaan Azure.

Microsoft.Authorization/roleDefinitions/read

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List role definitions for scope

Sample Request

HTTP

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

Java

/** Samples for RoleDefinitions List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
     * GetRoleDefinitionAtScope.json
     */
    /**
     * Sample code: List role definitions for scope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listRoleDefinitionsForScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleDefinitions().list("scope",
            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

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_role_definition_at_scope.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.role_definitions.list(
        scope="scope",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/53b1affe357b3bfbb53721d0a2002382a046d3b0/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.json
func ExampleRoleDefinitionsClient_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.NewRoleDefinitionsClient().NewListPager("scope", &armauthorization.RoleDefinitionsClientListOptions{Filter: 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.RoleDefinitionListResult = armauthorization.RoleDefinitionListResult{
		// 	Value: []*armauthorization.RoleDefinition{
		// 		{
		// 			Name: to.Ptr("roleDefinitionId"),
		// 			Type: to.Ptr("Microsoft.Authorization/roleDefinitions"),
		// 			ID: to.Ptr("/subscriptions/subID/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId"),
		// 			Properties: &armauthorization.RoleDefinitionProperties{
		// 				RoleType: to.Ptr("roletype"),
		// 				Description: to.Ptr("Role description"),
		// 				AssignableScopes: []*string{
		// 					to.Ptr("/subscriptions/subId")},
		// 					Permissions: []*armauthorization.Permission{
		// 						{
		// 							Actions: []*string{
		// 								to.Ptr("action")},
		// 								DataActions: []*string{
		// 									to.Ptr("dataAction")},
		// 									NotActions: []*string{
		// 									},
		// 									NotDataActions: []*string{
		// 									},
		// 							}},
		// 							RoleName: to.Ptr("Role name"),
		// 						},
		// 				}},
		// 			}
	}
}

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 Get all role definitions that are applicable at scope and above.
 *
 * @summary Get all role definitions that are applicable at scope and above.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.json
 */
async function listRoleDefinitionsForScope() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "scope";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.roleDefinitions.list(scope)) {
    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

dotnet

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/GetRoleDefinitionAtScope.json
// this example is just showing the usage of "RoleDefinitions_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this AuthorizationRoleDefinitionResource
string scope = "scope";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
AuthorizationRoleDefinitionCollection collection = client.GetAuthorizationRoleDefinitions(scopeId);

// invoke the operation and iterate over the result
await foreach (AuthorizationRoleDefinitionResource 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
    AuthorizationRoleDefinitionData 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

Status code:

200

{
  "value": [
    {
      "properties": {
        "roleName": "Role name",
        "type": "roletype",
        "description": "Role description",
        "assignableScopes": [
          "/subscriptions/subId"
        ],
        "permissions": [
          {
            "actions": [
              "action"
            ],
            "notActions": [],
            "dataActions": [
              "dataAction"
            ],
            "notDataActions": []
          }
        ]
      },
      "id": "/subscriptions/subID/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "roleDefinitionId"
    }
  ]
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
Permission	Izin definisi peran.
RoleDefinition	Definisi peran.
RoleDefinitionListResult	Hasil operasi daftar definisi peran.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

Permission

Izin definisi peran.

Nama	Jenis	Deskripsi
actions	string[]	Tindakan yang diizinkan.
dataActions	string[]	Tindakan Data yang Diizinkan.
notActions	string[]	Tindakan yang ditolak.
notDataActions	string[]	Tindakan Data yang Ditolak.

RoleDefinition

Definisi peran.

Nama	Jenis	Deskripsi
id	string	ID definisi peran.
name	string	Nama definisi peran.
properties.assignableScopes	string[]	Cakupan yang dapat ditetapkan definisi peran.
properties.createdBy	string	Id pengguna yang membuat penugasan
properties.createdOn	string	Waktu pembuatannya
properties.description	string	Deskripsi definisi peran.
properties.permissions	Permission[]	Izin definisi peran.
properties.roleName	string	Nama peran.
properties.type	string	Jenis peran.
properties.updatedBy	string	Id pengguna yang memperbarui penugasan
properties.updatedOn	string	Waktu pembaruan
type	string	Jenis definisi peran.

RoleDefinitionListResult

Hasil operasi daftar definisi peran.

Nama	Jenis	Deskripsi
nextLink	string	URL yang digunakan untuk mendapatkan serangkaian hasil berikutnya.
value	RoleDefinition[]	Daftar definisi peran.