Role Eligibility Schedule Requests - Create

Service:

Authorization

API Version:

2020-10-01

Létrehoz egy szerepkör jogosultsági ütemezési kérését.

PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}?api-version=2020-10-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
roleEligibilityScheduleRequestName	path	True	string	A létrehozásra jogosult szerepkör neve. Bármilyen érvényes GUID lehet.
scope	path	True	string	A létrehozandó szerepkör jogosultsági ütemezési kérésének hatóköre. A hatókör bármely REST-erőforráspéldány lehet. Használja például az "/subscriptions/{subscription-id}/" elemet egy erőforráscsoporthoz tartozó "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}" előfizetéshez, és "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}" erőforráshoz.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.principalId	True	string	Az egyszerű azonosító.
properties.requestType	True	RequestType	A szerepkör-hozzárendelés ütemezési kérésének típusa. Pl.: SelfActivate, AdminAssign stb.
properties.roleDefinitionId	True	string	A szerepkördefiníció azonosítója.
properties.condition		string	A szerepkör-hozzárendelés feltételei. Ez korlátozza azokat az erőforrásokat, amelyekhez hozzárendelhető. Például: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion		string	A feltétel verziója. Jelenleg elfogadott érték: "2.0"
properties.justification		string	A szerepkör jogosultságának indoklása
properties.scheduleInfo		ScheduleInfo	A szerepkör jogosultsági ütemezésének ütemezési adatai
properties.targetRoleEligibilityScheduleId		string	Az eredményül kapott szerepkör jogosultsági ütemezésének azonosítója vagy a szerepkör jogosultsági ütemezésének frissítése folyamatban van
properties.targetRoleEligibilityScheduleInstanceId		string	A szerepkör jogosultsági ütemezésének példányazonosítója frissítve van
properties.ticketInfo		TicketInfo	A szerepkör jogosultságának jegyadatai

Válaszok

Name	Típus	Description
201 Created	RoleEligibilityScheduleRequest	Létrehozva – A szerepkör jogosultsági ütemezési kérésével kapcsolatos információkat adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

PutRoleEligibilityScheduleRequest

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6?api-version=2020-10-01

{
  "properties": {
    "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
    "requestType": "AdminAssign",
    "scheduleInfo": {
      "startDateTime": "2020-09-09T21:31:27.91Z",
      "expiration": {
        "type": "AfterDuration",
        "endDateTime": null,
        "duration": "P365D"
      }
    },
    "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
    "conditionVersion": "1.0"
  }
}

Java

import com.azure.resourcemanager.authorization.fluent.models.RoleEligibilityScheduleRequestInner;
import com.azure.resourcemanager.authorization.models.RequestType;
import com.azure.resourcemanager.authorization.models.RoleEligibilityScheduleRequestPropertiesScheduleInfo;
import com.azure.resourcemanager.authorization.models.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration;
import com.azure.resourcemanager.authorization.models.Type;
import java.time.OffsetDateTime;

/** Samples for RoleEligibilityScheduleRequests Create. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * PutRoleEligibilityScheduleRequest.json
     */
    /**
     * Sample code: PutRoleEligibilityScheduleRequest.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void putRoleEligibilityScheduleRequest(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleEligibilityScheduleRequests()
            .createWithResponse("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "64caffb6-55c0-4deb-a585-68e948ea1ad6",
                new RoleEligibilityScheduleRequestInner().withRoleDefinitionId(
                    "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608")
                    .withPrincipalId("a3bb8764-cb92-4276-9d2a-ca1e895e55ea").withRequestType(RequestType.ADMIN_ASSIGN)
                    .withScheduleInfo(new RoleEligibilityScheduleRequestPropertiesScheduleInfo()
                        .withStartDateTime(OffsetDateTime.parse("2020-09-09T21:31:27.91Z"))
                        .withExpiration(new RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration()
                            .withType(Type.AFTER_DURATION).withDuration("P365D")))
                    .withCondition("@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]"
                        + " StringEqualsIgnoreCase 'foo_storage_container'")
                    .withConditionVersion("1.0"),
                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"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/2020-10-01/examples/PutRoleEligibilityScheduleRequest.json
func ExampleRoleEligibilityScheduleRequestsClient_Create() {
	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.NewRoleEligibilityScheduleRequestsClient().Create(ctx, "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", "64caffb6-55c0-4deb-a585-68e948ea1ad6", armauthorization.RoleEligibilityScheduleRequest{
		Properties: &armauthorization.RoleEligibilityScheduleRequestProperties{
			Condition:        to.Ptr("@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'"),
			ConditionVersion: to.Ptr("1.0"),
			PrincipalID:      to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
			RequestType:      to.Ptr(armauthorization.RequestTypeAdminAssign),
			RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
			ScheduleInfo: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfo{
				Expiration: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration{
					Type:     to.Ptr(armauthorization.TypeAfterDuration),
					Duration: to.Ptr("P365D"),
				},
				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:31:27.910Z"); return t }()),
			},
		},
	}, 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 a role eligibility schedule request.
 *
 * @summary Creates a role eligibility schedule request.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/PutRoleEligibilityScheduleRequest.json
 */
async function putRoleEligibilityScheduleRequest() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const roleEligibilityScheduleRequestName = "64caffb6-55c0-4deb-a585-68e948ea1ad6";
  const parameters = {
    condition:
      "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
    conditionVersion: "1.0",
    principalId: "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    requestType: "AdminAssign",
    roleDefinitionId:
      "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
    scheduleInfo: {
      expiration: {
        type: "AfterDuration",
        duration: "P365D",
        endDateTime: undefined,
      },
      startDateTime: new Date("2020-09-09T21:31:27.91Z"),
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleEligibilityScheduleRequests.create(
    scope,
    roleEligibilityScheduleRequestName,
    parameters
  );
  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 System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;
using Azure.ResourceManager.Authorization.Models;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/PutRoleEligibilityScheduleRequest.json
// this example is just showing the usage of "RoleEligibilityScheduleRequests_Create" 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 RoleEligibilityScheduleRequestResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleEligibilityScheduleRequestCollection collection = client.GetRoleEligibilityScheduleRequests(scopeId);

// invoke the operation
string roleEligibilityScheduleRequestName = "64caffb6-55c0-4deb-a585-68e948ea1ad6";
RoleEligibilityScheduleRequestData data = new RoleEligibilityScheduleRequestData()
{
    RoleDefinitionId = new ResourceIdentifier("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
    PrincipalId = Guid.Parse("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
    RequestType = RoleManagementScheduleRequestType.AdminAssign,
    Condition = "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
    ConditionVersion = "1.0",
    StartOn = DateTimeOffset.Parse("2020-09-09T21:31:27.91Z"),
    ExpirationType = RoleManagementScheduleExpirationType.AfterDuration,
    EndOn = null,
    Duration = XmlConvert.ToTimeSpan("P365D"),
};
ArmOperation<RoleEligibilityScheduleRequestResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, roleEligibilityScheduleRequestName, data);
RoleEligibilityScheduleRequestResource 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
RoleEligibilityScheduleRequestData 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": {
    "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
    "targetRoleEligibilityScheduleInstanceId": null,
    "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
    "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
    "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "principalType": "User",
    "requestType": "AdminAssign",
    "status": "Provisioned",
    "approvalId": null,
    "scheduleInfo": {
      "startDateTime": "2020-09-09T21:31:27.91Z",
      "expiration": {
        "type": "AfterDuration",
        "endDateTime": null,
        "duration": "P365D"
      }
    },
    "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
    },
    "justification": null,
    "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "createdOn": "2020-09-09T21:32:27.91Z",
    "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
    "conditionVersion": "1.0",
    "expandedProperties": {
      "scope": {
        "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
        "displayName": "Pay-As-You-Go",
        "type": "subscription"
      },
      "roleDefinition": {
        "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
        "displayName": "Contributor",
        "type": "BuiltInRole"
      },
      "principal": {
        "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
        "displayName": "User Account",
        "email": "user@my-tenant.com",
        "type": "User"
      }
    }
  },
  "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6",
  "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6",
  "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests"
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpandedProperties	Bővített információ az erőforrásról, a szerepkörről és az egyszerűségről
Expiration	A szerepkör jogosultsági ütemezésének lejárata
Principal	A rendszerbiztonsági tag adatai
principalType	A hozzárendelt egyszerű azonosító egyszerű típusa.
RequestType	A szerepkör-hozzárendelés ütemezési kérésének típusa. Pl.: SelfActivate, AdminAssign stb.
RoleDefinition	A szerepkördefiníció részletei
RoleEligibilityScheduleRequest	Szerepkör jogosultsági ütemezési kérése
ScheduleInfo	A szerepkör jogosultsági ütemezésének ütemezési adatai
Scope	Az erőforrás hatókörének részletei
Status	A szerepkör jogosultsági ütemezési kérésének állapota.
TicketInfo	A szerepkör jogosultságának jegyadatai
Type	A szerepkör jogosultsági ütemezésének lejárati típusa

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Hibaválasz a szolgáltatástól.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

ExpandedProperties

Bővített információ az erőforrásról, a szerepkörről és az egyszerűségről

Name	Típus	Description
principal	Principal	A rendszerbiztonsági tag adatai
roleDefinition	RoleDefinition	A szerepkördefiníció részletei
scope	Scope	Az erőforrás hatókörének részletei

Expiration

A szerepkör jogosultsági ütemezésének lejárata

Name	Típus	Description
duration	string	A szerepkör jogosultsági ütemezésének időtartama a TimeSpanban.
endDateTime	string	A szerepkör jogosultsági ütemezésének befejezési dátumideje.
type	Type	A szerepkör jogosultsági ütemezésének lejárati típusa

Principal

A rendszerbiztonsági tag adatai

Name	Típus	Description
displayName	string	A rendszernév megjelenítendő neve
email	string	Email tag azonosítója
id	string	Az egyszerű azonosító
type	string	A rendszernév típusa

principalType

A hozzárendelt egyszerű azonosító egyszerű típusa.

Name	Típus	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

A szerepkör-hozzárendelés ütemezési kérésének típusa. Pl.: SelfActivate, AdminAssign stb.

Name	Típus	Description
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

A szerepkördefiníció részletei

Name	Típus	Description
displayName	string	A szerepkördefiníció megjelenítendő neve
id	string	A szerepkördefiníció azonosítója
type	string	A szerepkördefiníció típusa

RoleEligibilityScheduleRequest

Szerepkör jogosultsági ütemezési kérése

Name	Típus	Description
id	string	A szerepkör jogosultsági ütemezésének kérésazonosítója.
name	string	A szerepkör jogosultsági ütemezési kérésének neve.
properties.approvalId	string	A szerepkör jogosultsági ütemezési kérésének jóváhagyási azonosítója.
properties.condition	string	A szerepkör-hozzárendelés feltételei. Ez korlátozza azokat az erőforrásokat, amelyekhez hozzárendelhető. Például: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion	string	A feltétel verziója. Jelenleg elfogadott érték: "2.0"
properties.createdOn	string	DateTime a szerepkör jogosultsági ütemezési kérésének létrehozásakor
properties.expandedProperties	ExpandedProperties	A főnév, a hatókör és a szerepkördefiníció további tulajdonságai
properties.justification	string	A szerepkör jogosultságának indoklása
properties.principalId	string	Az egyszerű azonosító.
properties.principalType	principalType	A hozzárendelt egyszerű azonosító egyszerű típusa.
properties.requestType	RequestType	A szerepkör-hozzárendelés ütemezési kérésének típusa. Pl.: SelfActivate, AdminAssign stb.
properties.requestorId	string	A kérést létrehozó felhasználó azonosítója
properties.roleDefinitionId	string	A szerepkördefiníció azonosítója.
properties.scheduleInfo	ScheduleInfo	A szerepkör jogosultsági ütemezésének ütemezési adatai
properties.scope	string	A szerepkör jogosultsági ütemezésének kérési hatóköre.
properties.status	Status	A szerepkör jogosultsági ütemezési kérésének állapota.
properties.targetRoleEligibilityScheduleId	string	Az eredményül kapott szerepkör jogosultsági ütemezésének azonosítója vagy a szerepkör jogosultsági ütemezésének frissítése folyamatban van
properties.targetRoleEligibilityScheduleInstanceId	string	A szerepkör jogosultsági ütemezésének példányazonosítója frissítve van
properties.ticketInfo	TicketInfo	A szerepkör jogosultságának jegyadatai
type	string	A szerepkör jogosultsági ütemezésének kéréstípusa.

ScheduleInfo

A szerepkör jogosultsági ütemezésének ütemezési adatai

Name	Típus	Description
expiration	Expiration	A szerepkör jogosultsági ütemezésének lejárata
startDateTime	string	A szerepkör jogosultsági ütemezésének dátum/idő kezdete.

Scope

Az erőforrás hatókörének részletei

Name	Típus	Description
displayName	string	Az erőforrás megjelenítendő neve
id	string	Az erőforrás hatókör-azonosítója
type	string	Az erőforrás típusa

Status

A szerepkör jogosultsági ütemezési kérésének állapota.

Name	Típus	Description
Accepted	string
AdminApproved	string
AdminDenied	string
Canceled	string
Denied	string
Failed	string
FailedAsResourceIsLocked	string
Granted	string
Invalid	string
PendingAdminDecision	string
PendingApproval	string
PendingApprovalProvisioning	string
PendingEvaluation	string
PendingExternalProvisioning	string
PendingProvisioning	string
PendingRevocation	string
PendingScheduleCreation	string
Provisioned	string
ProvisioningStarted	string
Revoked	string
ScheduleCreated	string
TimedOut	string

TicketInfo

A szerepkör jogosultságának jegyadatai

Name	Típus	Description
ticketNumber	string	A szerepkör jogosultságának jegyszáma
ticketSystem	string	A szerepkör-jogosultság jegyrendszerneve

Type

A szerepkör jogosultsági ütemezésének lejárati típusa

Name	Típus	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string