Rufen Sie alle Rollendefinitionen ab, die im Bereich und darüber gelten.
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01
Mit optionalen Parametern:
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?$filter={$filter}&api-version=2022-04-01
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
scope
|
path |
True
|
string
|
Der Bereich der Rollendefinition.
|
|
api-version
|
query |
True
|
string
|
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
|
|
$filter
|
query |
|
string
|
Der Filter, der auf den Vorgang angewendet werden soll. Verwenden Sie den atScopeAndBelow-Filter, um auch unterhalb des angegebenen Bereichs zu suchen.
|
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
RoleDefinitionListResult
|
OK: Gibt ein Array von Rollendefinitionen zurück.
|
|
Other Status Codes
|
ErrorResponse
|
Fehlerantwort mit Beschreibung des Grunds für den Fehler.
|
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name |
Beschreibung |
|
user_impersonation
|
Identitätswechsel Ihres Benutzerkontos
|
Beispiele
List role definitions for scope
Beispielanforderung
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);
// 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 AuthorizationRoleDefinitionResource
string scope = "scope";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
AuthorizationRoleDefinitionCollection collection = client.GetAuthorizationRoleDefinitions(scopeId);
// 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
Beispiel für eine Antwort
{
"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"
}
]
}
Definitionen
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
| Name |
Typ |
Beschreibung |
|
info
|
object
|
Zusätzliche Informationen.
|
|
type
|
string
|
Typ der zusätzlichen Informationen.
|
ErrorDetail
Die Fehlerdetails.
| Name |
Typ |
Beschreibung |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Die zusätzlichen Fehlerinformationen.
|
|
code
|
string
|
Der Fehlercode.
|
|
details
|
ErrorDetail[]
|
Die Fehlerdetails.
|
|
message
|
string
|
Die Fehlermeldung.
|
|
target
|
string
|
Das Fehlerziel.
|
ErrorResponse
Fehlerantwort
| Name |
Typ |
Beschreibung |
|
error
|
ErrorDetail
|
Das Fehlerobjekt.
|
Permission
Rollendefinitionsberechtigungen.
| Name |
Typ |
Beschreibung |
|
actions
|
string[]
|
Zulässige Aktionen.
|
|
dataActions
|
string[]
|
Zulässige Datenaktionen.
|
|
notActions
|
string[]
|
Abgelehnte Aktionen.
|
|
notDataActions
|
string[]
|
Aktionen für verweigerte Daten.
|
RoleDefinition
Rollendefinition.
| Name |
Typ |
Beschreibung |
|
id
|
string
|
Hierbei handelt es sich um die Rollendefinitions-ID.
|
|
name
|
string
|
Der Rollendefinitionsname.
|
|
properties.assignableScopes
|
string[]
|
Zuweisbare Bereiche für Rollendefinitionen.
|
|
properties.createdBy
|
string
|
ID des Benutzers, der die Zuweisung erstellt hat
|
|
properties.createdOn
|
string
|
Erstellungszeit
|
|
properties.description
|
string
|
Die Beschreibung der Rollendefinition.
|
|
properties.permissions
|
Permission[]
|
Rollendefinitionsberechtigungen.
|
|
properties.roleName
|
string
|
Der Name der Rolle.
|
|
properties.type
|
string
|
Der Rollentyp.
|
|
properties.updatedBy
|
string
|
ID des Benutzers, der die Zuweisung aktualisiert hat
|
|
properties.updatedOn
|
string
|
Aktualisierungszeit
|
|
type
|
string
|
Der Rollendefinitionstyp.
|
RoleDefinitionListResult
Ergebnis des Vorgangs "Rollendefinitionsliste".
| Name |
Typ |
Beschreibung |
|
nextLink
|
string
|
Die URL, die zum Abrufen der nächsten Ergebnismenge verwendet werden soll.
|
|
value
|
RoleDefinition[]
|
Rollendefinitionsliste.
|