Role Assignments - List For Scope

Service:

Authorization

API Version:

2022-04-01

Listar todas as atribuições de função que se aplicam a um escopo.

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}

Parâmetros de URI

Name	In	Required	Type	Description
scope	path	True	string	O escopo da operação ou do recurso. Escopos válidos são: assinatura (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', ou recurso (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	A versão da API a ser usada para esta operação.
$filter	query		string	O filtro a ser aplicado na operação. Use $filter=atScope() para retornar todas as atribuições de função em ou acima do escopo. Use $filter=principalId eq {id} para retornar todas as atribuições de função em, acima ou abaixo do escopo da entidade de segurança especificada.
$skipToken	query		string	O skipToken a ser aplicado na operação. Use $skipToken={skiptoken} para retornar atribuições de função paged após a passagem skipToken. Só há suporte em chamadas no nível do provedor.
tenantId	query		string	ID do locatário para solicitação entre locatários

Respostas

Name	Type	Description
200 OK	RoleAssignmentListResult	Retorna uma matriz de atribuições de função.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Permissões

Para chamar essa API, você precisa de uma função atribuída que tenha as permissões a seguir. Para obter mais informações, veja Funções internas do Azure.

Microsoft.Authorization/roleAssignments/read

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar sua conta de usuário

Exemplos

List role assignments for scope

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

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

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/tree/main/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()
	client, err := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListForScopePager("subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2", &armauthorization.RoleAssignmentsClientListForScopeOptions{Filter: nil,
		TenantID:  nil,
		SkipToken: nil,
	})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

Definições

ErrorAdditionalInfo	As informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PrincipalType	O tipo principal da ID da entidade de segurança atribuída.
RoleAssignment	Atribuições de Funções
RoleAssignmentListResult	Resultado da operação de lista de atribuição de função.

ErrorAdditionalInfo

As informações adicionais sobre o erro de gerenciamento de recursos.

Name	Type	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Type	Description
error	ErrorDetail	O objeto de erro.

PrincipalType

O tipo principal da ID da entidade de segurança atribuída.

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

RoleAssignment

Atribuições de Funções

Name	Type	Default Value	Description
id	string		ID de atribuição de função.
name	string		O nome da atribuição de função.
properties.condition	string		As condições na atribuição de função. Isso limita os recursos aos quais ele pode ser atribuído. por exemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string		Versão da condição. Atualmente, o único valor aceito é '2.0'
properties.createdBy	string		Id do usuário que criou a atribuição
properties.createdOn	string		Tempo em que foi criado
properties.delegatedManagedIdentityResourceId	string		Id do recurso de identidade gerenciada delegada
properties.description	string		Descrição da atribuição de função
properties.principalId	string		A ID da entidade de segurança.
properties.principalType	PrincipalType	User	O tipo principal da ID da entidade de segurança atribuída.
properties.roleDefinitionId	string		A ID de definição de função.
properties.scope	string		O escopo da atribuição de função.
properties.updatedBy	string		Id do usuário que atualizou a atribuição
properties.updatedOn	string		Hora em que foi atualizado
type	string		O tipo de atribuição de função.

RoleAssignmentListResult

Resultado da operação de lista de atribuição de função.

Name	Type	Description
nextLink	string	O skipToken a ser usado para obter o próximo conjunto de resultados.
value	RoleAssignment[]	Lista de atribuições de função.