Role Eligibility Schedule Requests - Create

Serviço:

Authorization

Versão da API:

2020-10-01

Cria um pedido de agendamento de elegibilidade de função.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
roleEligibilityScheduleRequestName	path	True	string	O nome da elegibilidade da função a criar. Pode ser qualquer GUID válido.
scope	path	True	string	O âmbito do pedido de agendamento de elegibilidade de função a criar. O âmbito pode ser qualquer instância de recurso REST. Por exemplo, utilize "/subscriptions/{subscription-id}/" para uma subscrição, "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}" para um grupo de recursos e "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}" para um recurso.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.principalId	True	string	O ID principal.
properties.requestType	True	RequestType	O tipo do pedido de agendamento de atribuição de funções. Por exemplo: SelfActivate, AdminAssign, etc.
properties.roleDefinitionId	True	string	O ID da definição de função.
properties.condition		string	As condições na atribuição de função. Isto limita os recursos aos quais pode ser atribuído. por exemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion		string	Versão da condição. O valor atualmente aceite é "2.0"
properties.justification		string	Justificação para a elegibilidade da função
properties.scheduleInfo		ScheduleInfo	Agendar informações da agenda de elegibilidade da função
properties.targetRoleEligibilityScheduleId		string	O ID da agenda de elegibilidade da função resultante ou o ID da agenda de elegibilidade da função a ser atualizado
properties.targetRoleEligibilityScheduleInstanceId		string	O ID da instância da agenda de elegibilidade da função a ser atualizado
properties.ticketInfo		TicketInfo	Informações do Pedido de Suporte sobre a elegibilidade da função

Respostas

Name	Tipo	Description
201 Created	RoleEligibilityScheduleRequest	Criado – devolve informações sobre o pedido de agendamento de elegibilidade de função.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

PutRoleEligibilityScheduleRequest

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpandedProperties	Informações expandidas do recurso, função e principal
Expiration	Expiração da agenda de elegibilidade da função
Principal	Detalhes do principal
principalType	O tipo principal do ID principal atribuído.
RequestType	O tipo do pedido de agendamento de atribuição de funções. Por exemplo: SelfActivate, AdminAssign, etc.
RoleDefinition	Detalhes da definição de função
RoleEligibilityScheduleRequest	Pedido de agendamento de Elegibilidade de Função
ScheduleInfo	Agendar informações da agenda de elegibilidade da função
Scope	Detalhes do âmbito do recurso
Status	O estado do pedido de agendamento de elegibilidade de função.
TicketInfo	Informações do Pedido de Suporte sobre a elegibilidade da função
Type	Tipo de expiração da agenda de elegibilidade da função

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.

ExpandedProperties

Informações expandidas do recurso, função e principal

Name	Tipo	Description
principal	Principal	Detalhes do principal
roleDefinition	RoleDefinition	Detalhes da definição de função
scope	Scope	Detalhes do âmbito do recurso

Expiration

Expiração da agenda de elegibilidade da função

Name	Tipo	Description
duration	string	Duração da agenda de elegibilidade da função no TimeSpan.
endDateTime	string	Data de FimTime da agenda de elegibilidade da função.
type	Type	Tipo de expiração da agenda de elegibilidade da função

Principal

Detalhes do principal

Name	Tipo	Description
displayName	string	Nome a apresentar do principal
email	string	Email id do principal
id	string	ID do principal
type	string	Tipo do principal

principalType

O tipo principal do ID principal atribuído.

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

RequestType

O tipo do pedido de agendamento de atribuição de funções. Por exemplo: SelfActivate, AdminAssign, etc.

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

RoleDefinition

Detalhes da definição de função

Name	Tipo	Description
displayName	string	Nome a apresentar da definição de função
id	string	ID da definição de função
type	string	Tipo da definição de função

RoleEligibilityScheduleRequest

Pedido de agendamento de Elegibilidade de Função

Name	Tipo	Description
id	string	O ID do pedido de agendamento de elegibilidade de função.
name	string	O nome do pedido de agendamento de elegibilidade de função.
properties.approvalId	string	O approvalId do pedido de agendamento de elegibilidade de função.
properties.condition	string	As condições na atribuição de função. Isto limita os recursos aos quais pode ser atribuído. por exemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versão da condição. O valor atualmente aceite é "2.0"
properties.createdOn	string	DateTime quando o pedido de agendamento de elegibilidade de função foi criado
properties.expandedProperties	ExpandedProperties	Propriedades adicionais do principal, âmbito e definição de função
properties.justification	string	Justificação para a elegibilidade da função
properties.principalId	string	O ID principal.
properties.principalType	principalType	O tipo principal do ID principal atribuído.
properties.requestType	RequestType	O tipo do pedido de agendamento de atribuição de funções. Por exemplo: SelfActivate, AdminAssign, etc.
properties.requestorId	string	ID do utilizador que criou este pedido
properties.roleDefinitionId	string	O ID da definição de função.
properties.scheduleInfo	ScheduleInfo	Agendar informações da agenda de elegibilidade da função
properties.scope	string	O âmbito do pedido de agendamento de elegibilidade de função.
properties.status	Status	O estado do pedido de agendamento de elegibilidade de função.
properties.targetRoleEligibilityScheduleId	string	O ID da agenda de elegibilidade da função resultante ou o ID da agenda de elegibilidade da função a ser atualizado
properties.targetRoleEligibilityScheduleInstanceId	string	O ID da instância da agenda de elegibilidade da função a ser atualizado
properties.ticketInfo	TicketInfo	Informações do Pedido de Suporte sobre a elegibilidade da função
type	string	O tipo de pedido de agendamento de elegibilidade de função.

ScheduleInfo

Agendar informações da agenda de elegibilidade da função

Name	Tipo	Description
expiration	Expiration	Expiração da agenda de elegibilidade da função
startDateTime	string	Iniciar DateTime da agenda de elegibilidade da função.

Scope

Detalhes do âmbito do recurso

Name	Tipo	Description
displayName	string	Nome a apresentar do recurso
id	string	ID de âmbito do recurso
type	string	Tipo do recurso

Status

O estado do pedido de agendamento de elegibilidade de função.

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

Informações do Pedido de Suporte sobre a elegibilidade da função

Name	Tipo	Description
ticketNumber	string	Número de pedido para a elegibilidade da função
ticketSystem	string	Nome do sistema de pedidos para a elegibilidade da função

Type

Tipo de expiração da agenda de elegibilidade da função

Name	Tipo	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string