Role Assignment Schedule Requests - Get

Service:

Authorization

API Version:

2020-10-01

Get the specified role assignment schedule request.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}?api-version=2020-10-01

URI Parameters

Name	In	Required	Type	Description
roleAssignmentScheduleRequestName	path	True	string	The name (guid) of the role assignment schedule request to get.
scope	path	True	string	The scope of the role assignment schedule request.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RoleAssignmentScheduleRequest	OK - Returns information about the role assignment schedule request.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

GetRoleAssignmentScheduleRequestByName

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045?api-version=2020-10-01

Java

/**
 * Samples for RoleAssignmentScheduleRequests Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleAssignmentScheduleRequestByName.json
     */
    /**
     * Sample code: GetRoleAssignmentScheduleRequestByName.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleAssignmentScheduleRequestByName(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignmentScheduleRequests()
            .getWithResponse("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "fea7a502-9a96-4806-a26f-eee560e52045", 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"

	"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/GetRoleAssignmentScheduleRequestByName.json
func ExampleRoleAssignmentScheduleRequestsClient_Get() {
	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)
	}
	res, err := clientFactory.NewRoleAssignmentScheduleRequestsClient().Get(ctx, "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", "fea7a502-9a96-4806-a26f-eee560e52045", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleAssignmentScheduleRequest = armauthorization.RoleAssignmentScheduleRequest{
	// 	Name: to.Ptr("fea7a502-9a96-4806-a26f-eee560e52045"),
	// 	Type: to.Ptr("Microsoft.Authorization/RoleAssignmentScheduleRequests"),
	// 	ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045"),
	// 	Properties: &armauthorization.RoleAssignmentScheduleRequestProperties{
	// 		Condition: to.Ptr("@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'"),
	// 		ConditionVersion: to.Ptr("1.0"),
	// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
	// 		ExpandedProperties: &armauthorization.ExpandedProperties{
	// 			Principal: &armauthorization.ExpandedPropertiesPrincipal{
	// 				Type: to.Ptr("User"),
	// 				DisplayName: to.Ptr("User Account"),
	// 				Email: to.Ptr("user@my-tenant.com"),
	// 				ID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
	// 			},
	// 			RoleDefinition: &armauthorization.ExpandedPropertiesRoleDefinition{
	// 				Type: to.Ptr("BuiltInRole"),
	// 				DisplayName: to.Ptr("Contributor"),
	// 				ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
	// 			},
	// 			Scope: &armauthorization.ExpandedPropertiesScope{
	// 				Type: to.Ptr("subscription"),
	// 				DisplayName: to.Ptr("Pay-As-You-Go"),
	// 				ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
	// 			},
	// 		},
	// 		PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
	// 		PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
	// 		RequestType: to.Ptr(armauthorization.RequestTypeSelfActivate),
	// 		RequestorID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
	// 		RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
	// 		ScheduleInfo: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfo{
	// 			Expiration: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration{
	// 				Type: to.Ptr(armauthorization.TypeAfterDuration),
	// 				Duration: to.Ptr("PT8H"),
	// 			},
	// 			StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
	// 		},
	// 		Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
	// 		Status: to.Ptr(armauthorization.StatusProvisioned),
	// 		TargetRoleAssignmentScheduleID: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
	// 		TicketInfo: &armauthorization.RoleAssignmentScheduleRequestPropertiesTicketInfo{
	// 		},
	// 	},
	// }
}

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 Get the specified role assignment schedule request.
 *
 * @summary Get the specified role assignment schedule request.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleRequestByName.json
 */
async function getRoleAssignmentScheduleRequestByName() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const roleAssignmentScheduleRequestName = "fea7a502-9a96-4806-a26f-eee560e52045";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleAssignmentScheduleRequests.get(
    scope,
    roleAssignmentScheduleRequestName
  );
  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/GetRoleAssignmentScheduleRequestByName.json
// this example is just showing the usage of "RoleAssignmentScheduleRequests_Get" 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 RoleAssignmentScheduleRequestResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleAssignmentScheduleRequestCollection collection = client.GetRoleAssignmentScheduleRequests(scopeId);

// invoke the operation
string roleAssignmentScheduleRequestName = "fea7a502-9a96-4806-a26f-eee560e52045";
NullableResponse<RoleAssignmentScheduleRequestResource> response = await collection.GetIfExistsAsync(roleAssignmentScheduleRequestName);
RoleAssignmentScheduleRequestResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    RoleAssignmentScheduleRequestData 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:

200

{
  "properties": {
    "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
    "targetRoleAssignmentScheduleInstanceId": 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": "SelfActivate",
    "status": "Provisioned",
    "approvalId": null,
    "scheduleInfo": {
      "startDateTime": "2020-09-09T21:35:27.91Z",
      "expiration": {
        "type": "AfterDuration",
        "endDateTime": null,
        "duration": "PT8H"
      }
    },
    "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
    },
    "justification": null,
    "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "createdOn": "2020-09-09T21:35: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": "fea7a502-9a96-4806-a26f-eee560e52045",
  "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045",
  "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests"
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpandedProperties
Expiration	Expiration of the role assignment schedule
Principal	Details of the principal
principalType	The principal type of the assigned principal ID.
RequestType	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc
RoleAssignmentScheduleRequest	Role Assignment schedule request
RoleDefinition	Details of role definition
ScheduleInfo	Schedule info of the role assignment schedule
Scope	Details of the resource scope
Status	The status of the role assignment schedule request.
TicketInfo	Ticket Info of the role assignment
Type	Type of the role assignment schedule expiration

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	An error response from the service.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	string	A message describing the error, intended to be suitable for display in a user interface.

ExpandedProperties

Object

Name	Type	Description
principal	Principal	Details of the principal
roleDefinition	RoleDefinition	Details of role definition
scope	Scope	Details of the resource scope

Expiration

Object

Expiration of the role assignment schedule

Name	Type	Description
duration	string	Duration of the role assignment schedule in TimeSpan.
endDateTime	string	End DateTime of the role assignment schedule.
type	Type	Type of the role assignment schedule expiration

Principal

Object

Details of the principal

Name	Type	Description
displayName	string	Display name of the principal
email	string	Email id of the principal
id	string	Id of the principal
type	string	Type of the principal

principalType

Enumeration

The principal type of the assigned principal ID.

Value	Description
Device
ForeignGroup
Group
ServicePrincipal
User

RequestType

Enumeration

The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc

Value	Description
AdminAssign
AdminExtend
AdminRemove
AdminRenew
AdminUpdate
SelfActivate
SelfDeactivate
SelfExtend
SelfRenew

RoleAssignmentScheduleRequest

Object

Role Assignment schedule request

Name	Type	Description
id	string	The role assignment schedule request ID.
name	string	The role assignment schedule request name.
properties.approvalId	string	The approvalId of the role assignment schedule request.
properties.condition	string	The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Version of the condition. Currently accepted value is '2.0'
properties.createdOn	string	DateTime when role assignment schedule request was created
properties.expandedProperties	ExpandedProperties	Additional properties of principal, scope and role definition
properties.justification	string	Justification for the role assignment
properties.linkedRoleEligibilityScheduleId	string	The linked role eligibility schedule id - to activate an eligibility.
properties.principalId	string	The principal ID.
properties.principalType	principalType	The principal type of the assigned principal ID.
properties.requestType	RequestType	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc
properties.requestorId	string	Id of the user who created this request
properties.roleDefinitionId	string	The role definition ID.
properties.scheduleInfo	ScheduleInfo	Schedule info of the role assignment schedule
properties.scope	string	The role assignment schedule request scope.
properties.status	Status	The status of the role assignment schedule request.
properties.targetRoleAssignmentScheduleId	string	The resultant role assignment schedule id or the role assignment schedule id being updated
properties.targetRoleAssignmentScheduleInstanceId	string	The role assignment schedule instance id being updated
properties.ticketInfo	TicketInfo	Ticket Info of the role assignment
type	string	The role assignment schedule request type.

RoleDefinition

Object

Details of role definition

Name	Type	Description
displayName	string	Display name of the role definition
id	string	Id of the role definition
type	string	Type of the role definition

ScheduleInfo

Object

Schedule info of the role assignment schedule

Name	Type	Description
expiration	Expiration	Expiration of the role assignment schedule
startDateTime	string	Start DateTime of the role assignment schedule.

Scope

Object

Details of the resource scope

Name	Type	Description
displayName	string	Display name of the resource
id	string	Scope id of the resource
type	string	Type of the resource

Status

Enumeration

The status of the role assignment schedule request.

Value	Description
Accepted
AdminApproved
AdminDenied
Canceled
Denied
Failed
FailedAsResourceIsLocked
Granted
Invalid
PendingAdminDecision
PendingApproval
PendingApprovalProvisioning
PendingEvaluation
PendingExternalProvisioning
PendingProvisioning
PendingRevocation
PendingScheduleCreation
Provisioned
ProvisioningStarted
Revoked
ScheduleCreated
TimedOut

TicketInfo

Object

Ticket Info of the role assignment

Name	Type	Description
ticketNumber	string	Ticket number for the role assignment
ticketSystem	string	Ticket system name for the role assignment

Type

Enumeration

Type of the role assignment schedule expiration

Value	Description
AfterDateTime
AfterDuration
NoExpiration