Partilhar 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 URI

Nome Em Necessário Tipo Descrição
scope
path True

string

O âmbito da definição de funções.

api-version
query True

string

minLength: 1

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 fornecido também.

Respostas

Nome Tipo Descrição
200 OK

RoleDefinitionListResult

OK - Retorna uma matriz de definições de função.

Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Alcances

Nome Descrição
user_impersonation personificar a sua conta de utilizador

Exemplos

List role definitions for scope

Pedido 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 Descrição
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Permission

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

RoleDefinition

Definição de funções.

RoleDefinitionListResult

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

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Nome Tipo Descrição
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Descrição
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

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 Descrição
error

ErrorDetail

O objeto de erro.

Permission

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

Nome Tipo Descrição
actions

string[]

Ações permitidas.

dataActions

string[]

Ações de dados permitidos.

notActions

string[]

Ações negadas.

notDataActions

string[]

Ações de dados negados.

RoleDefinition

Definição de funções.

Nome Tipo Descrição
id

string

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

name

string

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

properties.assignableScopes

string[]

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

properties.createdBy

string

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

properties.createdOn

string (date-time)

Tempo 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 (date-time)

Hora em que foi atualizado

type

string

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

RoleDefinitionListResult

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

Nome Tipo Descrição
nextLink

string

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

value

RoleDefinition[]

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