Role Definitions - List

Service:

Authorization

API Version:

2022-04-01

Obtenha todas as definições de funções que sejam aplicáveis no âmbito e acima.

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

Parâmetros do URI

Name	In	Required	Type	Description
scope	path	True	string	O âmbito da definição de papel.
api-version	query	True	string	A versão API a ser utilizada para esta operação.
$filter	query		string	O filtro para aplicar na operação. Utilize também o filtroScopeAndBelow para pesquisar abaixo do âmbito dado.

Respostas

Name	Type	Description
200 OK	RoleDefinitionListResult	OK - Devolve uma série de definições de funções.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

List role definitions for scope

Sample Request

HTTP

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

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/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()
	client, err := armauthorization.NewRoleDefinitionsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("scope", &armauthorization.RoleDefinitionsClientListOptions{Filter: 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
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definições

ErrorAdditionalInfo	O erro de gestão de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Permission	Permissões de definição de funções.
RoleDefinition	Definição de papel.
RoleDefinitionListResult	Resultado da operação da lista de definição de função.

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name	Type	Description
info	object	A informação adicional.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	A informação adicional do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Resposta de erro

Name	Type	Description
error	ErrorDetail	O objeto de erro.

Permission

Permissões de definição de funções.

Name	Type	Description
actions	string[]	Ações permitidas.
dataActions	string[]	Permitiu ações de dados.
notActions	string[]	Ações negadas.
notDataActions	string[]	Ações de Dados Negadas.

RoleDefinition

Definição de papel.

Name	Type	Description
id	string	A definição de papel ID.
name	string	O nome de definição de papel.
properties.assignableScopes	string[]	Definição de função atribui âmbitos atribuíveis.
properties.description	string	A descrição da definição de função.
properties.permissions	Permission[]	Permissões de definição de funções.
properties.roleName	string	O nome do papel.
properties.type	string	O tipo de papel.
type	string	O tipo de definição de função.

RoleDefinitionListResult

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

Name	Type	Description
nextLink	string	O URL a utilizar para obter o próximo conjunto de resultados.
value	RoleDefinition[]	Lista de definição de papéis.