Ottenere tutte le definizioni di ruolo applicabili all'ambito e versioni successive.
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01
Con parametri facoltativi:
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?$filter={$filter}&api-version=2022-04-01
Parametri dell'URI
Nome |
In |
Necessario |
Tipo |
Descrizione |
scope
|
path |
True
|
string
|
Ambito della definizione del ruolo.
|
api-version
|
query |
True
|
string
minLength: 1
|
Versione dell'API da usare per questa operazione.
|
$filter
|
query |
|
string
|
Filtro da applicare all'operazione. Usare anche il filtro atScopeAndBelow per cercare sotto l'ambito specificato.
|
Risposte
Nome |
Tipo |
Descrizione |
200 OK
|
RoleDefinitionListResult
|
OK: restituisce una matrice di definizioni di ruolo.
|
Other Status Codes
|
ErrorResponse
|
Risposta di errore che descrive perché l'operazione non è riuscita.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome |
Descrizione |
user_impersonation
|
rappresentare l'account utente
|
Esempio
List role definitions for scope
Esempio di richiesta
GET https://management.azure.com/scope/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01
/**
* Samples for RoleDefinitions List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
* GetRoleDefinitionAtScope.json
*/
/**
* Sample code: List role definitions for scope.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listRoleDefinitionsForScope(com.azure.resourcemanager.AzureResourceManager azure) {
azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleDefinitions().list("scope",
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.authorization import AuthorizationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-authorization
# USAGE
python get_role_definition_at_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_definitions.list(
scope="scope",
)
for item in response:
print(item)
# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.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
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/blob/53b1affe357b3bfbb53721d0a2002382a046d3b0/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()
clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewRoleDefinitionsClient().NewListPager("scope", &armauthorization.RoleDefinitionsClientListOptions{Filter: 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.RoleDefinitionListResult = armauthorization.RoleDefinitionListResult{
// Value: []*armauthorization.RoleDefinition{
// {
// Name: to.Ptr("roleDefinitionId"),
// Type: to.Ptr("Microsoft.Authorization/roleDefinitions"),
// ID: to.Ptr("/subscriptions/subID/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId"),
// Properties: &armauthorization.RoleDefinitionProperties{
// RoleType: to.Ptr("roletype"),
// Description: to.Ptr("Role description"),
// AssignableScopes: []*string{
// to.Ptr("/subscriptions/subId")},
// Permissions: []*armauthorization.Permission{
// {
// Actions: []*string{
// to.Ptr("action")},
// DataActions: []*string{
// to.Ptr("dataAction")},
// NotActions: []*string{
// },
// NotDataActions: []*string{
// },
// }},
// RoleName: to.Ptr("Role name"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get all role definitions that are applicable at scope and above.
*
* @summary Get all role definitions that are applicable at scope and above.
* x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.json
*/
async function listRoleDefinitionsForScope() {
const subscriptionId =
process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const scope = "scope";
const credential = new DefaultAzureCredential();
const client = new AuthorizationManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.roleDefinitions.list(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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization;
// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionAtScope.json
// this example is just showing the usage of "RoleDefinitions_List" 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 AuthorizationRoleDefinitionResource
string scope = "scope";
AuthorizationRoleDefinitionCollection collection = client.GetAuthorizationRoleDefinitions(new ResourceIdentifier(scope));
// invoke the operation and iterate over the result
await foreach (AuthorizationRoleDefinitionResource 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
AuthorizationRoleDefinitionData 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
Risposta di esempio
{
"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"
}
]
}
Definizioni
ErrorAdditionalInfo
Object
Informazioni aggiuntive sulla gestione delle risorse.
Nome |
Tipo |
Descrizione |
info
|
object
|
Informazioni aggiuntive.
|
type
|
string
|
Tipo di informazioni aggiuntive.
|
ErrorDetail
Object
Dettagli dell'errore.
Nome |
Tipo |
Descrizione |
additionalInfo
|
ErrorAdditionalInfo[]
|
Informazioni aggiuntive sull'errore.
|
code
|
string
|
Codice di errore.
|
details
|
ErrorDetail[]
|
Dettagli dell'errore.
|
message
|
string
|
Messaggio di errore.
|
target
|
string
|
Destinazione dell'errore.
|
ErrorResponse
Object
Risposta di errore
Permission
Object
Autorizzazioni di definizione del ruolo.
Nome |
Tipo |
Descrizione |
actions
|
string[]
|
Azioni consentite.
|
dataActions
|
string[]
|
Azioni dati consentite.
|
notActions
|
string[]
|
Azioni negate.
|
notDataActions
|
string[]
|
Azioni dati negate.
|
RoleDefinition
Object
Definizione del ruolo.
Nome |
Tipo |
Descrizione |
id
|
string
|
ID definizione del ruolo.
|
name
|
string
|
Nome della definizione del ruolo.
|
properties.assignableScopes
|
string[]
|
Ambiti assegnabili di definizione del ruolo.
|
properties.createdBy
|
string
|
ID dell'utente che ha creato l'assegnazione
|
properties.createdOn
|
string
(date-time)
|
Ora di creazione
|
properties.description
|
string
|
Descrizione della definizione del ruolo.
|
properties.permissions
|
Permission[]
|
Autorizzazioni di definizione del ruolo.
|
properties.roleName
|
string
|
Nome del ruolo.
|
properties.type
|
string
|
Tipo di ruolo.
|
properties.updatedBy
|
string
|
ID dell'utente che ha aggiornato l'assegnazione
|
properties.updatedOn
|
string
(date-time)
|
Ora in cui è stato aggiornato
|
type
|
string
|
Tipo di definizione del ruolo.
|
RoleDefinitionListResult
Object
Risultato dell'operazione dell'elenco delle definizioni di ruolo.
Nome |
Tipo |
Descrizione |
nextLink
|
string
|
URL da usare per ottenere il set successivo di risultati.
|
value
|
RoleDefinition[]
|
Elenco delle definizioni di ruolo.
|