Role Eligibility Schedule Requests - Create

Dienst:

Authorization

API-Version:

2020-10-01

Erstellt eine Anforderung für einen Rollenberechtigungszeitplan.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
roleEligibilityScheduleRequestName	path	True	string	Der Name der zu erstellenden Rollenberechtigung. Es kann sich um eine beliebige gültige GUID sein.
scope	path	True	string	Der Bereich der zu erstellenden Anforderung des Rollenberechtigungszeitplans. Der Bereich kann eine beliebige REST-Ressource instance sein. Verwenden Sie beispielsweise "/subscriptions/{subscription-id}/" für ein Abonnement, "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}" für eine Ressourcengruppe und "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}" für eine Ressource.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.principalId	True	string	Die Prinzipal-ID.
properties.requestType	True	RequestType	Der Typ der Anforderung zum Zeitplan für die Rollenzuweisung. Beispiel: SelfActivate, AdminAssign usw.
properties.roleDefinitionId	True	string	Hierbei handelt es sich um die Rollendefinitions-ID.
properties.condition		string	Die Bedingungen für die Rollenzuweisung. Dies schränkt die Ressourcen ein, denen sie zugewiesen werden kann. Beispiel: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion		string	Version der Bedingung. Der derzeit akzeptierte Wert ist "2,0".
properties.justification		string	Begründung für die Rollenberechtigung
properties.scheduleInfo		ScheduleInfo	Zeitplaninformationen des Rollenberechtigungszeitplans
properties.targetRoleEligibilityScheduleId		string	Die resultierende Rollenberechtigungszeitplan-ID oder die Rollenberechtigungszeitplan-ID, die aktualisiert wird
properties.targetRoleEligibilityScheduleInstanceId		string	Der Zeitplan für die Rollenberechtigung instance ID, die aktualisiert wird
properties.ticketInfo		TicketInfo	Ticketinformationen zur Rollenberechtigung

Antworten

Name	Typ	Beschreibung
201 Created	RoleEligibilityScheduleRequest	Erstellt: Gibt Informationen zur Anforderung des Rollenberechtigungszeitplans zurück.
Other Status Codes	CloudError	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

PutRoleEligibilityScheduleRequest

Beispielanforderung

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization.Models;
using Azure.ResourceManager.Authorization;

// 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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
ExpandedProperties	Erweiterte Informationen zu Ressource, Rolle und Prinzipal
Expiration	Ablauf des Rollenberechtigungszeitplans
Principal	Details des Prinzipals
principalType	Der Prinzipaltyp der zugewiesenen Prinzipal-ID.
RequestType	Der Typ der Anforderung zum Zeitplan für die Rollenzuweisung. Beispiel: SelfActivate, AdminAssign usw.
RoleDefinition	Details zur Rollendefinition
RoleEligibilityScheduleRequest	Anforderung des Rollenberechtigungszeitplans
ScheduleInfo	Zeitplaninformationen des Rollenberechtigungszeitplans
Scope	Details zum Ressourcenbereich
Status	Die status der Anforderung des Rollenberechtigungszeitplans.
TicketInfo	Ticketinformationen zur Rollenberechtigung
Type	Typ des Ablaufzeitplans für die Rollenberechtigung

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

ExpandedProperties

Erweiterte Informationen zu Ressource, Rolle und Prinzipal

Name	Typ	Beschreibung
principal	Principal	Details des Prinzipals
roleDefinition	RoleDefinition	Details zur Rollendefinition
scope	Scope	Details zum Ressourcenbereich

Expiration

Ablauf des Rollenberechtigungszeitplans

Name	Typ	Beschreibung
duration	string	Dauer des Rollenberechtigungszeitplans in TimeSpan.
endDateTime	string	End DateTime des Rollenberechtigungszeitplans.
type	Type	Typ des Ablaufzeitplans für die Rollenberechtigung

Principal

Details des Prinzipals

Name	Typ	Beschreibung
displayName	string	Anzeigename des Prinzipals
email	string	Email ID des Prinzipals
id	string	ID des Prinzipals
type	string	Typ des Prinzipals

principalType

Der Prinzipaltyp der zugewiesenen Prinzipal-ID.

Name	Typ	Beschreibung
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

Der Typ der Anforderung zum Zeitplan für die Rollenzuweisung. Beispiel: SelfActivate, AdminAssign usw.

Name	Typ	Beschreibung
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

Details zur Rollendefinition

Name	Typ	Beschreibung
displayName	string	Anzeigename der Rollendefinition
id	string	ID der Rollendefinition
type	string	Typ der Rollendefinition

RoleEligibilityScheduleRequest

Anforderung des Rollenberechtigungszeitplans

Name	Typ	Beschreibung
id	string	Die Anforderungs-ID des Rollenberechtigungszeitplans.
name	string	Der Anforderungsname des Rollenberechtigungszeitplans.
properties.approvalId	string	Die approvalId der Anforderung des Rollenberechtigungszeitplans.
properties.condition	string	Die Bedingungen für die Rollenzuweisung. Dies schränkt die Ressourcen ein, denen sie zugewiesen werden kann. Beispiel: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Version der Bedingung. Der derzeit akzeptierte Wert ist "2,0".
properties.createdOn	string	DateTime, wenn die Anforderung zum Rollenberechtigungszeitplan erstellt wurde
properties.expandedProperties	ExpandedProperties	Zusätzliche Eigenschaften der Prinzipal-, Bereichs- und Rollendefinition
properties.justification	string	Begründung für die Rollenberechtigung
properties.principalId	string	Die Prinzipal-ID.
properties.principalType	principalType	Der Prinzipaltyp der zugewiesenen Prinzipal-ID.
properties.requestType	RequestType	Der Typ der Anforderung zum Zeitplan für die Rollenzuweisung. Beispiel: SelfActivate, AdminAssign usw.
properties.requestorId	string	ID des Benutzers, der diese Anforderung erstellt hat
properties.roleDefinitionId	string	Hierbei handelt es sich um die Rollendefinitions-ID.
properties.scheduleInfo	ScheduleInfo	Zeitplaninformationen des Rollenberechtigungszeitplans
properties.scope	string	Der Anforderungsbereich des Rollenberechtigungszeitplans.
properties.status	Status	Die status der Anforderung des Rollenberechtigungszeitplans.
properties.targetRoleEligibilityScheduleId	string	Die resultierende Rollenberechtigungszeitplan-ID oder die Rollenberechtigungszeitplan-ID, die aktualisiert wird
properties.targetRoleEligibilityScheduleInstanceId	string	Der Zeitplan für die Rollenberechtigung instance ID, die aktualisiert wird
properties.ticketInfo	TicketInfo	Ticketinformationen zur Rollenberechtigung
type	string	Der Anforderungstyp des Rollenberechtigungszeitplans.

ScheduleInfo

Zeitplaninformationen des Rollenberechtigungszeitplans

Name	Typ	Beschreibung
expiration	Expiration	Ablauf des Rollenberechtigungszeitplans
startDateTime	string	Starten Sie DateTime des Rollenberechtigungszeitplans.

Scope

Details zum Ressourcenbereich

Name	Typ	Beschreibung
displayName	string	Anzeigename der Ressource
id	string	Bereichs-ID der Ressource
type	string	Typ der Ressource

Status

Die status der Anforderung des Rollenberechtigungszeitplans.

Name	Typ	Beschreibung
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

Ticketinformationen zur Rollenberechtigung

Name	Typ	Beschreibung
ticketNumber	string	Ticketnummer für die Rollenberechtigung
ticketSystem	string	Name des Ticketsystems für die Rollenberechtigung

Type

Typ des Ablaufzeitplans für die Rollenberechtigung

Name	Typ	Beschreibung
AfterDateTime	string
AfterDuration	string
NoExpiration	string