Role Definitions - Get By Id

Service:

Authorization

API Version:

2022-04-01

Ruft eine Rollendefinition nach ID ab.

GET https://management.azure.com/{roleId}?disambiguation_dummy&api-version=2022-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
roleId	path	True	string	Die vollqualifizierte Rollendefinitions-ID. Verwenden Sie das Format /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} für Rollendefinitionen auf Abonnementebene oder /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} für Rollendefinitionen auf Mandantenebene.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	RoleDefinition	OK: Gibt Informationen zur Rollendefinition zurück.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get role definition by ID

Sample Request

HTTP

GET https://management.azure.com/roleDefinitionId?disambiguation_dummy&api-version=2022-04-01

Java

/** Samples for RoleDefinitions GetById. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
     * GetRoleDefinitionById.json
     */
    /**
     * Sample code: Get role definition by ID.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleDefinitionByID(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleDefinitions()
            .getByIdWithResponse("roleDefinitionId", 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

Python

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_by_id.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.get_by_id(
        role_id="roleDefinitionId",
    )
    print(response)


# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionById.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

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/blob/53b1affe357b3bfbb53721d0a2002382a046d3b0/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionById.json
func ExampleRoleDefinitionsClient_GetByID() {
	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)
	}
	res, err := clientFactory.NewRoleDefinitionsClient().GetByID(ctx, "roleDefinitionId", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleDefinition = 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

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a role definition by ID.
 *
 * @summary Gets a role definition by ID.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetRoleDefinitionById.json
 */
async function getRoleDefinitionById() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const roleId = "roleDefinitionId";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleDefinitions.getById(roleId);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Permission	Rollendefinitionsberechtigungen.
RoleDefinition	Rollendefinition.

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[]	Verweigerte Aktionen.
notDataActions	string[]	Verweigerte Datenaktionen.

RoleDefinition

Rollendefinition.

Name	Typ	Beschreibung
id	string	Hierbei handelt es sich um die Rollendefinitions-ID.
name	string	Der Name der Rollendefinition.
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	Zeitpunkt der Aktualisierung
type	string	Der Rollendefinitionstyp.