Role Eligibility Schedule Requests - Create

Služba:

Authorization

Verze rozhraní API:

2020-10-01

Vytvoří žádost o plán způsobilosti role.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
roleEligibilityScheduleRequestName	path	True	string	Název role, která má být oprávněná k vytvoření. Může to být libovolný platný identifikátor GUID.
scope	path	True	string	Rozsah žádosti o plán způsobilosti role, který se má vytvořit. Oborem může být libovolná instance prostředku REST. Například pro předplatné použijte /subscriptions/{id_předplatného}/, /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků} pro skupinu prostředků a /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{poskytovatel-poskytovatele_prostředků}/{typ_prostředku}/{název_prostředku}/{název_prostředku}.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.principalId	True	string	ID objektu zabezpečení.
properties.requestType	True	RequestType	Typ žádosti o plán přiřazení role. Například: SelfActivate, AdminAssign atd.
properties.roleDefinitionId	True	string	ID definice role.
properties.condition		string	Podmínky přiřazení role. Tím se omezí prostředky, ke kterým se dá přiřadit. např.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion		string	Verze podmínky. Aktuálně přijímaná hodnota je 2.0.
properties.justification		string	Odůvodnění způsobilosti k roli
properties.scheduleInfo		ScheduleInfo	Informace o plánu plánu způsobilosti pro roli
properties.targetRoleEligibilityScheduleId		string	ID plánu způsobilosti pro výsledné role nebo ID plánu způsobilosti role, které se aktualizuje
properties.targetRoleEligibilityScheduleInstanceId		string	ID instance plánu způsobilosti role, které se aktualizuje
properties.ticketInfo		TicketInfo	Informace o lístku způsobilosti role

Odpovědi

Name	Typ	Description
201 Created	RoleEligibilityScheduleRequest	Vytvořeno – vrátí informace o žádosti o plán způsobilosti role.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

PutRoleEligibilityScheduleRequest

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
ExpandedProperties	Rozšířené informace o prostředku, roli a objektu zabezpečení
Expiration	Vypršení platnosti plánu způsobilosti pro role
Principal	Podrobnosti o objektu zabezpečení
principalType	Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.
RequestType	Typ žádosti o plán přiřazení role. Například: SelfActivate, AdminAssign atd.
RoleDefinition	Podrobnosti o definici role
RoleEligibilityScheduleRequest	Žádost o plán způsobilosti role
ScheduleInfo	Informace o plánu plánu způsobilosti pro roli
Scope	Podrobnosti o rozsahu prostředků
Status	Stav žádosti o plán způsobilosti role.
TicketInfo	Informace o lístku způsobilosti role
Type	Typ vypršení platnosti plánu způsobilosti pro role

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby.

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	string	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.

ExpandedProperties

Rozšířené informace o prostředku, roli a objektu zabezpečení

Name	Typ	Description
principal	Principal	Podrobnosti o objektu zabezpečení
roleDefinition	RoleDefinition	Podrobnosti o definici role
scope	Scope	Podrobnosti o rozsahu prostředků

Expiration

Vypršení platnosti plánu způsobilosti pro role

Name	Typ	Description
duration	string	Doba trvání plánu způsobilosti role v TimeSpan.
endDateTime	string	Koncové datum a čas plánu způsobilosti role.
type	Type	Typ vypršení platnosti plánu způsobilosti pro role

Principal

Podrobnosti o objektu zabezpečení

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení
email	string	Email ID objektu zabezpečení
id	string	ID objektu zabezpečení
type	string	Typ objektu zabezpečení

principalType

Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.

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

RequestType

Typ žádosti o plán přiřazení role. Například: SelfActivate, AdminAssign atd.

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

RoleDefinition

Podrobnosti o definici role

Name	Typ	Description
displayName	string	Zobrazovaný název definice role
id	string	ID definice role
type	string	Typ definice role

RoleEligibilityScheduleRequest

Žádost o plán způsobilosti role

Name	Typ	Description
id	string	ID žádosti o způsobilost role.
name	string	Název žádosti o způsobilost role v rámci plánu.
properties.approvalId	string	Id schválení žádosti o plán způsobilosti role.
properties.condition	string	Podmínky přiřazení role. Tím se omezí prostředky, ke kterým se dá přiřadit. např.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Verze podmínky. Aktuálně přijímaná hodnota je 2.0.
properties.createdOn	string	Datum a čas vytvoření žádosti o plán způsobilosti role
properties.expandedProperties	ExpandedProperties	Další vlastnosti objektu zabezpečení, oboru a definice role
properties.justification	string	Odůvodnění způsobilosti k roli
properties.principalId	string	ID objektu zabezpečení.
properties.principalType	principalType	Typ objektu zabezpečení přiřazeného ID objektu zabezpečení.
properties.requestType	RequestType	Typ žádosti o plán přiřazení role. Například: SelfActivate, AdminAssign atd.
properties.requestorId	string	ID uživatele, který tuto žádost vytvořil
properties.roleDefinitionId	string	ID definice role.
properties.scheduleInfo	ScheduleInfo	Informace o plánu plánu způsobilosti pro roli
properties.scope	string	Rozsah požadavků plánu způsobilosti pro roli.
properties.status	Status	Stav žádosti o plán způsobilosti role.
properties.targetRoleEligibilityScheduleId	string	ID plánu způsobilosti pro výsledné role nebo ID plánu způsobilosti role, které se aktualizuje
properties.targetRoleEligibilityScheduleInstanceId	string	ID instance plánu způsobilosti role, které se aktualizuje
properties.ticketInfo	TicketInfo	Informace o lístku způsobilosti role
type	string	Typ žádosti o plán způsobilosti role.

ScheduleInfo

Informace o plánu plánu způsobilosti pro roli

Name	Typ	Description
expiration	Expiration	Vypršení platnosti plánu způsobilosti pro role
startDateTime	string	Počáteční datum a čas plánu způsobilosti role.

Scope

Podrobnosti o rozsahu prostředků

Name	Typ	Description
displayName	string	Zobrazovaný název prostředku
id	string	ID oboru prostředku
type	string	Typ prostředku

Status

Stav žádosti o plán způsobilosti role.

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

Informace o lístku způsobilosti role

Name	Typ	Description
ticketNumber	string	Číslo lístku pro způsobilost role
ticketSystem	string	Název systému lístků pro způsobilost role

Type

Typ vypršení platnosti plánu způsobilosti pro role

Name	Typ	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string