Role Assignments - List For Scope

Служба:

Authorization

Версия API:

2022-04-01

Вывод списка всех назначений ролей, которые применяются к области.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	Область операции или ресурса. Допустимые области: подписка (формат :/subscriptions/{subscriptionId}), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" или ресурс (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
$filter	query		string	Фильтр, применяемый к операции. Используйте $filter=atScope() для возврата всех назначений ролей в области или выше. Используйте $filter=principalId eq {id} для возврата всех назначений ролей, указанных выше или ниже области для указанного субъекта.
$skipToken	query		string	SkipToken, который будет применяться к операции. Используйте $skipToken={skiptoken}, чтобы возвращать назначения страничных ролей после переданного skipToken. Поддерживается только на вызовах уровня поставщика.
tenantId	query		string	Идентификатор клиента для запроса между клиентами

Ответы

Имя	Тип	Описание
200 OK	RoleAssignmentListResult	Возвращает массив назначений ролей.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Разрешения

Для вызова этого API вам должна быть назначена роль со следующими разрешениями. Дополнительные сведения см. в статье Встроенные роли Azure.

Microsoft.Authorization/roleAssignments/read

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List role assignments for scope

Образец запроса

HTTP

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

Java

/**
 * 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

Python

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

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: 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

JavaScript

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

dotnet

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

// 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);

// get the collection of this RoleAssignmentResource
string scope = "subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2";
RoleAssignmentCollection collection = client.GetRoleAssignments(new ResourceIdentifier(scope));

// 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

Пример ответа

Код состояния:

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"
    }
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PrincipalType	Основной тип назначенного идентификатора субъекта.
RoleAssignment	Назначения ролей
RoleAssignmentListResult	Результат операции списка назначений ролей.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

PrincipalType

Перечисление

Основной тип назначенного идентификатора субъекта.

Значение	Описание
Device
ForeignGroup
Group
ServicePrincipal
User

RoleAssignment

Object

Назначения ролей

Имя	Тип	Default value	Описание
id	string		Идентификатор назначения роли.
name	string		Имя назначения роли.
properties.condition	string		Условия назначения роли. Это ограничивает ресурсы, которыми его можно назначить. например: @Resource[Microsoft.Storage/storageAccounts/blobServices/container:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion	string		Версия условия. В настоящее время единственным допустимым значением является "2.0"
properties.createdBy	string		Идентификатор пользователя, создавшего назначение
properties.createdOn	string (date-time)		Время его создания
properties.delegatedManagedIdentityResourceId	string		Идентификатор делегированного ресурса управляемого удостоверения
properties.description	string		Описание назначения ролей
properties.principalId	string		Идентификатор субъекта.
properties.principalType	PrincipalType	User	Основной тип назначенного идентификатора субъекта.
properties.roleDefinitionId	string		Идентификатор определения роли.
properties.scope	string		Область назначения ролей.
properties.updatedBy	string		Идентификатор пользователя, который обновил назначение
properties.updatedOn	string (date-time)		Время обновления
type	string		Тип назначения роли.

RoleAssignmentListResult

Object

Результат операции списка назначений ролей.

Имя	Тип	Описание
nextLink	string	SkipToken, используемый для получения следующего набора результатов.
value	RoleAssignment[]	Список назначений ролей.