Role Assignments - List For Scope

Reference

Service:: Authorization

API Version:: 2022-04-01

Vypíše všechna přiřazení rolí, která se vztahují k oboru.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	Rozsah operace nebo prostředku. Platné obory jsou: předplatné (formát:/subscriptions/{id_předplatného}),skupina prostředků (formát:/subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků} nebo prostředek (formát:/subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředků}/[{parentResourcePath}/]{typ_prostředku}/{název_prostředku}'
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Filtr, který se má použít na operaci. Pomocí $filter=atScope() vrátíte všechna přiřazení rolí v oboru nebo nad jeho rozsahem. Pomocí $filter=principalId eq {id} vrátíte všechna přiřazení rolí v rozsahu, nad nebo pod oborem pro zadaný objekt zabezpečení.
$skipToken	query		string	SkipToken, který se má použít v operaci. Použijte $skipToken={skiptoken} k vrácení stránkovaných přiřazení rolí za předaným skipTokenem. Podporováno pouze u volání na úrovni poskytovatele.
tenantId	query		string	ID tenanta pro žádosti mezi tenanty

Odpovědi

Name	Typ	Description
200 OK	RoleAssignmentListResult	Vrátí pole přiřazení rolí.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Oprávnění

Pokud chcete volat toto rozhraní API, musíte mít přiřazenou roli s následujícími oprávněními. Další informace najdete v tématu Předdefinované role v Azure.

Microsoft.Authorization/roleAssignments/read

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List role assignments for scope

Sample Request

GET https://management.azure.com/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments?api-version=2022-04-01


/** Samples for RoleAssignments ListForScope. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
     * RoleAssignments_ListForScope.json
     */
    /**
     * Sample code: List role assignments for scope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listRoleAssignmentsForScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignments().listForScope(
            "subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2", null, null, 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 role_assignments_list_for_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_assignments.list_for_scope(
        scope="subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/RoleAssignments_ListForScope.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/RoleAssignments_ListForScope.json
func ExampleRoleAssignmentsClient_NewListForScopePager() {
	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.NewRoleAssignmentsClient().NewListForScopePager("subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2", &armauthorization.RoleAssignmentsClientListForScopeOptions{Filter: nil,
		TenantID:  nil,
		SkipToken: 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.RoleAssignmentListResult = armauthorization.RoleAssignmentListResult{
		// 	Value: []*armauthorization.RoleAssignment{
		// 		{
		// 			Name: to.Ptr("b0f43c54-e787-4862-89b1-a653fa9cf747"),
		// 			Type: to.Ptr("Microsoft.Authorization/roleAssignments"),
		// 			ID: to.Ptr("/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments/b0f43c54-e787-4862-89b1-a653fa9cf747"),
		// 			Properties: &armauthorization.RoleAssignmentProperties{
		// 				PrincipalID: to.Ptr("ce2ce14e-85d7-4629-bdbc-454d0519d987"),
		// 				PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d"),
		// 				Scope: to.Ptr("/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2"),
		// 			},
		// 	}},
		// }
	}
}

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 List all role assignments that apply to a scope.
 *
 * @summary List all role assignments that apply to a scope.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/RoleAssignments_ListForScope.json
 */
async function listRoleAssignmentsForScope() {
  const scope = "subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.roleAssignments.listForScope(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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;
using Azure.ResourceManager.Authorization.Models;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/RoleAssignments_ListForScope.json
// this example is just showing the usage of "RoleAssignments_ListForScope" 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 RoleAssignmentResource
string scope = "subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleAssignmentCollection collection = client.GetRoleAssignments(scopeId);

// invoke the operation and iterate over the result
await foreach (RoleAssignmentResource 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
    RoleAssignmentData 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": {
        "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
        "principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
        "principalType": "User",
        "scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2"
      },
      "id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments/b0f43c54-e787-4862-89b1-a653fa9cf747",
      "type": "Microsoft.Authorization/roleAssignments",
      "name": "b0f43c54-e787-4862-89b1-a653fa9cf747"
    }
  ]
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
PrincipalType	Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.
RoleAssignment	Přiřazení rolí
RoleAssignmentListResult	Výsledek operace seznamu přiřazení rolí

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PrincipalType

Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.

Name	Typ	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RoleAssignment

Přiřazení rolí

Name	Typ	Výchozí hodnota	Description
id	string		ID přiřazení role.
name	string		Název přiřazení role.
properties.condition	string		Podmínky přiřazení role. Tím se omezí prostředky, ke kterým se dá přiřadit. např.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string		Verze podmínky. Jediná akceptovaná hodnota je aktuálně 2,0.
properties.createdBy	string		ID uživatele, který vytvořil přiřazení
properties.createdOn	string		Čas vytvoření
properties.delegatedManagedIdentityResourceId	string		ID prostředku delegovaná spravovaná identita
properties.description	string		Popis přiřazení role
properties.principalId	string		ID objektu zabezpečení.
properties.principalType	PrincipalType	User	Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.
properties.roleDefinitionId	string		ID definice role.
properties.scope	string		Obor přiřazení role.
properties.updatedBy	string		ID uživatele, který aktualizoval přiřazení
properties.updatedOn	string		Čas aktualizace
type	string		Typ přiřazení role.

RoleAssignmentListResult

Výsledek operace seznamu přiřazení rolí

Name	Typ	Description
nextLink	string	SkipToken, který se použije k získání další sady výsledků.
value	RoleAssignment[]	Seznam přiřazení rolí.