Role Eligibility Schedule Requests - Create

Servizio:

Authorization

Versione API:

2020-10-01

Crea una richiesta di pianificazione idoneità per i ruoli.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
roleEligibilityScheduleRequestName	path	True	string	Nome dell'idoneità al ruolo da creare. Può essere qualsiasi GUID valido.
scope	path	True	string	Ambito della richiesta di pianificazione dell'idoneità del ruolo da creare. L'ambito può essere qualsiasi istanza di risorsa REST. Ad esempio, usare '/subscriptions/{subscription-id}/' per una sottoscrizione, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' per un gruppo di risorse e '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' per una risorsa.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.principalId	True	string	ID principale.
properties.requestType	True	RequestType	Tipo della richiesta di pianificazione dell'assegnazione del ruolo. Ad esempio: SelfActivate, AdminAssign ecc
properties.roleDefinitionId	True	string	ID definizione del ruolo.
properties.condition		string	Condizioni sull'assegnazione di ruolo. Ciò limita le risorse a cui può essere assegnato. Ad esempio: @Resource[Microsoft.Storage/storageAccounts/BLOBServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion		string	Versione della condizione. Il valore attualmente accettato è '2.0'
properties.justification		string	Giustificazione dell'idoneità al ruolo
properties.scheduleInfo		ScheduleInfo	Pianificare le informazioni sulla pianificazione dell'idoneità del ruolo
properties.targetRoleEligibilityScheduleId		string	ID pianificazione di idoneità del ruolo risultante o id pianificazione di idoneità del ruolo da aggiornare
properties.targetRoleEligibilityScheduleInstanceId		string	ID dell'istanza dell'istanza di idoneità del ruolo da aggiornare
properties.ticketInfo		TicketInfo	Informazioni sul ticket dell'idoneità al ruolo

Risposte

Nome	Tipo	Descrizione
201 Created	RoleEligibilityScheduleRequest	Creato: restituisce informazioni sulla richiesta di pianificazione dell'idoneità del ruolo.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

PutRoleEligibilityScheduleRequest

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ExpandedProperties	Informazioni espanse di risorsa, ruolo e entità
Expiration	Scadenza della pianificazione dell'idoneità del ruolo
Principal	Dettagli dell'entità
principalType	Tipo principale dell'ID entità assegnato.
RequestType	Tipo della richiesta di pianificazione dell'assegnazione del ruolo. Ad esempio: SelfActivate, AdminAssign ecc
RoleDefinition	Dettagli della definizione del ruolo
RoleEligibilityScheduleRequest	Richiesta di pianificazione dell'idoneità del ruolo
ScheduleInfo	Pianificare le informazioni sulla pianificazione dell'idoneità del ruolo
Scope	Dettagli dell'ambito della risorsa
Status	Stato della richiesta di pianificazione dell'idoneità del ruolo.
TicketInfo	Informazioni sul ticket dell'idoneità al ruolo
Type	Tipo della scadenza della pianificazione dell'idoneità del ruolo

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal servizio.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

ExpandedProperties

Informazioni espanse di risorsa, ruolo e entità

Nome	Tipo	Descrizione
principal	Principal	Dettagli dell'entità
roleDefinition	RoleDefinition	Dettagli della definizione del ruolo
scope	Scope	Dettagli dell'ambito della risorsa

Expiration

Scadenza della pianificazione dell'idoneità del ruolo

Nome	Tipo	Descrizione
duration	string	Durata della pianificazione dell'idoneità del ruolo in TimeSpan.
endDateTime	string	End DateTime della pianificazione di idoneità del ruolo.
type	Type	Tipo della scadenza della pianificazione dell'idoneità del ruolo

Principal

Dettagli dell'entità

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità
email	string	Email id dell'entità
id	string	ID dell'entità
type	string	Tipo dell'entità

principalType

Tipo principale dell'ID entità assegnato.

Nome	Tipo	Descrizione
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

Tipo della richiesta di pianificazione dell'assegnazione del ruolo. Ad esempio: SelfActivate, AdminAssign ecc

Nome	Tipo	Descrizione
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

Dettagli della definizione del ruolo

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato della definizione del ruolo
id	string	ID della definizione del ruolo
type	string	Tipo della definizione del ruolo

RoleEligibilityScheduleRequest

Richiesta di pianificazione dell'idoneità del ruolo

Nome	Tipo	Descrizione
id	string	ID richiesta richiesta di idoneità del ruolo.
name	string	Nome della richiesta di pianificazione dell'idoneità del ruolo.
properties.approvalId	string	ApprovazioneId della richiesta di pianificazione dell'idoneità del ruolo.
properties.condition	string	Condizioni sull'assegnazione di ruolo. Ciò limita le risorse a cui può essere assegnato. Ad esempio: @Resource[Microsoft.Storage/storageAccounts/BLOBServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versione della condizione. Il valore attualmente accettato è '2.0'
properties.createdOn	string	DateTime quando è stata creata la richiesta di pianificazione dell'idoneità dei ruoli
properties.expandedProperties	ExpandedProperties	Proprietà aggiuntive di entità, ambito e definizione del ruolo
properties.justification	string	Giustificazione dell'idoneità al ruolo
properties.principalId	string	ID principale.
properties.principalType	principalType	Tipo principale dell'ID entità assegnato.
properties.requestType	RequestType	Tipo della richiesta di pianificazione dell'assegnazione del ruolo. Ad esempio: SelfActivate, AdminAssign ecc
properties.requestorId	string	ID dell'utente che ha creato questa richiesta
properties.roleDefinitionId	string	ID definizione del ruolo.
properties.scheduleInfo	ScheduleInfo	Pianificare le informazioni sulla pianificazione dell'idoneità del ruolo
properties.scope	string	Ambito della richiesta di pianificazione dell'idoneità del ruolo.
properties.status	Status	Stato della richiesta di pianificazione dell'idoneità del ruolo.
properties.targetRoleEligibilityScheduleId	string	ID pianificazione di idoneità del ruolo risultante o id pianificazione di idoneità del ruolo da aggiornare
properties.targetRoleEligibilityScheduleInstanceId	string	ID dell'istanza dell'istanza di idoneità del ruolo da aggiornare
properties.ticketInfo	TicketInfo	Informazioni sul ticket dell'idoneità al ruolo
type	string	Tipo di richiesta di pianificazione dell'idoneità del ruolo.

ScheduleInfo

Pianificare le informazioni sulla pianificazione dell'idoneità del ruolo

Nome	Tipo	Descrizione
expiration	Expiration	Scadenza della pianificazione dell'idoneità del ruolo
startDateTime	string	Avviare DateTime della pianificazione dell'idoneità del ruolo.

Scope

Dettagli dell'ambito della risorsa

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato della risorsa
id	string	ID ambito della risorsa
type	string	Tipo della risorsa

Status

Stato della richiesta di pianificazione dell'idoneità del ruolo.

Nome	Tipo	Descrizione
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

Informazioni sul ticket dell'idoneità al ruolo

Nome	Tipo	Descrizione
ticketNumber	string	Numero di ticket per l'idoneità al ruolo
ticketSystem	string	Nome del sistema di ticket per l'idoneità al ruolo

Type

Tipo della scadenza della pianificazione dell'idoneità del ruolo

Nome	Tipo	Descrizione
AfterDateTime	string
AfterDuration	string
NoExpiration	string