Role Definitions - Create Or Update

Service:

Authorization

API Version:

2022-04-01

Tworzy lub aktualizuje definicję roli.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
roleDefinitionId	path	True	string	Identyfikator definicji roli.
scope	path	True	string	Zakres definicji roli.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.assignableScopes	string[]	Zakresy przypisywane przez definicję roli.
properties.description	string	Opis definicji roli.
properties.permissions	Permission[]	Uprawnienia definicji roli.
properties.roleName	string	Nazwa roli.
properties.type	string	Typ roli.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	RoleDefinition	OK — zwraca informacje o definicji roli.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Uprawnienia

Aby wywołać ten interfejs API, musisz mieć przypisaną rolę z następującymi uprawnieniami. Aby uzyskać więcej informacji, zobacz Role wbudowane platformy Azure.

Microsoft.Authorization/roleDefinitions/write

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create role definition

Sample Request

HTTP

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

{}

Java

import com.azure.resourcemanager.authorization.fluent.models.RoleDefinitionInner;

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

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/PutRoleDefinition.json
func ExampleRoleDefinitionsClient_CreateOrUpdate() {
	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)
	}
	_, err = clientFactory.NewRoleDefinitionsClient().CreateOrUpdate(ctx, "scope", "roleDefinitionId", armauthorization.RoleDefinition{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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 Creates or updates a role definition.
 *
 * @summary Creates or updates a role definition.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/PutRoleDefinition.json
 */
async function createRoleDefinition() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "scope";
  const roleDefinitionId = "roleDefinitionId";
  const roleDefinition = {};
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleDefinitions.createOrUpdate(
    scope,
    roleDefinitionId,
    roleDefinition
  );
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/PutRoleDefinition.json
// this example is just showing the usage of "RoleDefinitions_CreateOrUpdate" 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 AuthorizationRoleDefinitionResource created on azure
// for more information of creating AuthorizationRoleDefinitionResource, please refer to the document of AuthorizationRoleDefinitionResource
string scope = "scope";
ResourceIdentifier roleDefinitionId = new ResourceIdentifier("roleDefinitionId");
ResourceIdentifier authorizationRoleDefinitionResourceId = AuthorizationRoleDefinitionResource.CreateResourceIdentifier(scope, roleDefinitionId);
AuthorizationRoleDefinitionResource authorizationRoleDefinition = client.GetAuthorizationRoleDefinitionResource(authorizationRoleDefinitionResourceId);

// invoke the operation
AuthorizationRoleDefinitionData data = new AuthorizationRoleDefinitionData();
ArmOperation<AuthorizationRoleDefinitionResource> lro = await authorizationRoleDefinition.UpdateAsync(WaitUntil.Completed, data);
AuthorizationRoleDefinitionResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:

201

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Permission	Uprawnienia definicji roli.
RoleDefinition	Definicja roli.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Permission

Uprawnienia definicji roli.

Nazwa	Typ	Opis
actions	string[]	Dozwolone akcje.
dataActions	string[]	Dozwolone akcje danych.
notActions	string[]	Odrzucone akcje.
notDataActions	string[]	Odrzucone akcje danych.

RoleDefinition

Definicja roli.

Nazwa	Typ	Opis
id	string	Identyfikator definicji roli.
name	string	Nazwa definicji roli.
properties.assignableScopes	string[]	Zakresy przypisywane przez definicję roli.
properties.createdBy	string	Identyfikator użytkownika, który utworzył przypisanie
properties.createdOn	string	Czas jego utworzenia
properties.description	string	Opis definicji roli.
properties.permissions	Permission[]	Uprawnienia definicji roli.
properties.roleName	string	Nazwa roli.
properties.type	string	Typ roli.
properties.updatedBy	string	Identyfikator użytkownika, który zaktualizował przypisanie
properties.updatedOn	string	Czas aktualizacji
type	string	Typ definicji roli.