Compartilhar via


Role Definitions - List

Obtenha todas as definições de função aplicáveis no escopo e acima.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
scope
path True

string

O escopo da definição de função.

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 o filtro atScopeAndBelow para pesquisar abaixo do escopo especificado também.

Respostas

Nome Tipo Description
200 OK

RoleDefinitionListResult

OK – retorna uma matriz de definições de função.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

List role definitions for scope

Solicitação de exemplo

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

Resposta de exemplo

{
  "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

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Permission

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

RoleDefinition

Definição de função.

RoleDefinitionListResult

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

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo 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

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

Permission

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

Nome Tipo Description
actions

string[]

Ações permitidas.

dataActions

string[]

Ações de dados permitidas.

notActions

string[]

Ações negadas.

notDataActions

string[]

Ações de dados negadas.

RoleDefinition

Definição de função.

Nome Tipo Description
id

string

A ID de definição de função.

name

string

O nome da definição da função.

properties.assignableScopes

string[]

Escopos atribuíveis à definição de função.

properties.createdBy

string

Id do usuário que criou a atribuição

properties.createdOn

string

Hora em que foi criado

properties.description

string

A descrição da definição de função.

properties.permissions

Permission[]

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

properties.roleName

string

O nome da função.

properties.type

string

O tipo de função.

properties.updatedBy

string

Id do usuário que atualizou a atribuição

properties.updatedOn

string

Hora em que ele foi atualizado

type

string

O tipo de definição de função.

RoleDefinitionListResult

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

Nome Tipo Description
nextLink

string

A URL a ser usada para obter o próximo conjunto de resultados.

value

RoleDefinition[]

Lista de definição de função.