Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Microsoft.Authorization roleAssignmentScheduleRequests
Bicep resource definition
The roleAssignmentScheduleRequests resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleAssignmentScheduleRequests resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Authorization/roleAssignmentScheduleRequests@2024-09-01-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
condition: 'string'
conditionVersion: 'string'
justification: 'string'
linkedRoleEligibilityScheduleId: 'string'
principalId: 'string'
requestType: 'string'
roleDefinitionId: 'string'
scheduleInfo: {
expiration: {
duration: 'string'
endDateTime: 'string'
type: 'string'
}
startDateTime: 'string'
}
targetRoleAssignmentScheduleId: 'string'
targetRoleAssignmentScheduleInstanceId: 'string'
ticketInfo: {
ticketNumber: 'string'
ticketSystem: 'string'
}
}
}
Property Values
Microsoft.Authorization/roleAssignmentScheduleRequests
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Role assignment schedule request properties. | RoleAssignmentScheduleRequestProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
RoleAssignmentScheduleRequestProperties
| Name | Description | Value |
|---|---|---|
| condition | 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' | string |
| conditionVersion | Version of the condition. Currently accepted value is '2.0' | string |
| justification | Justification for the role assignment | string |
| linkedRoleEligibilityScheduleId | The linked role eligibility schedule id - to activate an eligibility. | string |
| principalId | The principal ID. | string (required) |
| requestType | The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc | 'AdminAssign' 'AdminExtend' 'AdminRemove' 'AdminRenew' 'AdminUpdate' 'SelfActivate' 'SelfDeactivate' 'SelfExtend' 'SelfRenew' (required) |
| roleDefinitionId | The role definition ID. | string (required) |
| scheduleInfo | Schedule info of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfo |
| targetRoleAssignmentScheduleId | The resultant role assignment schedule id or the role assignment schedule id being updated | string |
| targetRoleAssignmentScheduleInstanceId | The role assignment schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role assignment | RoleAssignmentScheduleRequestPropertiesTicketInfo |
RoleAssignmentScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration |
| startDateTime | Start DateTime of the role assignment schedule. | string |
RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role assignment schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role assignment schedule. | string |
| type | Type of the role assignment schedule expiration | 'AfterDateTime' 'AfterDuration' 'NoExpiration' |
RoleAssignmentScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role assignment | string |
| ticketSystem | Ticket system name for the role assignment | string |
ARM template resource definition
The roleAssignmentScheduleRequests resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleAssignmentScheduleRequests resource, add the following JSON to your template.
{
"type": "Microsoft.Authorization/roleAssignmentScheduleRequests",
"apiVersion": "2024-09-01-preview",
"name": "string",
"properties": {
"condition": "string",
"conditionVersion": "string",
"justification": "string",
"linkedRoleEligibilityScheduleId": "string",
"principalId": "string",
"requestType": "string",
"roleDefinitionId": "string",
"scheduleInfo": {
"expiration": {
"duration": "string",
"endDateTime": "string",
"type": "string"
},
"startDateTime": "string"
},
"targetRoleAssignmentScheduleId": "string",
"targetRoleAssignmentScheduleInstanceId": "string",
"ticketInfo": {
"ticketNumber": "string",
"ticketSystem": "string"
}
}
}
Property Values
Microsoft.Authorization/roleAssignmentScheduleRequests
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| name | The resource name | string (required) |
| properties | Role assignment schedule request properties. | RoleAssignmentScheduleRequestProperties |
| type | The resource type | 'Microsoft.Authorization/roleAssignmentScheduleRequests' |
RoleAssignmentScheduleRequestProperties
| Name | Description | Value |
|---|---|---|
| condition | 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' | string |
| conditionVersion | Version of the condition. Currently accepted value is '2.0' | string |
| justification | Justification for the role assignment | string |
| linkedRoleEligibilityScheduleId | The linked role eligibility schedule id - to activate an eligibility. | string |
| principalId | The principal ID. | string (required) |
| requestType | The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc | 'AdminAssign' 'AdminExtend' 'AdminRemove' 'AdminRenew' 'AdminUpdate' 'SelfActivate' 'SelfDeactivate' 'SelfExtend' 'SelfRenew' (required) |
| roleDefinitionId | The role definition ID. | string (required) |
| scheduleInfo | Schedule info of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfo |
| targetRoleAssignmentScheduleId | The resultant role assignment schedule id or the role assignment schedule id being updated | string |
| targetRoleAssignmentScheduleInstanceId | The role assignment schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role assignment | RoleAssignmentScheduleRequestPropertiesTicketInfo |
RoleAssignmentScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration |
| startDateTime | Start DateTime of the role assignment schedule. | string |
RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role assignment schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role assignment schedule. | string |
| type | Type of the role assignment schedule expiration | 'AfterDateTime' 'AfterDuration' 'NoExpiration' |
RoleAssignmentScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role assignment | string |
| ticketSystem | Ticket system name for the role assignment | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The roleAssignmentScheduleRequests resource type can be deployed with operations that target:
- Tenant* Management groups* Subscription* Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleAssignmentScheduleRequests resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/roleAssignmentScheduleRequests@2024-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
condition = "string"
conditionVersion = "string"
justification = "string"
linkedRoleEligibilityScheduleId = "string"
principalId = "string"
requestType = "string"
roleDefinitionId = "string"
scheduleInfo = {
expiration = {
duration = "string"
endDateTime = "string"
type = "string"
}
startDateTime = "string"
}
targetRoleAssignmentScheduleId = "string"
targetRoleAssignmentScheduleInstanceId = "string"
ticketInfo = {
ticketNumber = "string"
ticketSystem = "string"
}
}
}
}
Property Values
Microsoft.Authorization/roleAssignmentScheduleRequests
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Role assignment schedule request properties. | RoleAssignmentScheduleRequestProperties |
| type | The resource type | "Microsoft.Authorization/roleAssignmentScheduleRequests@2024-09-01-preview" |
RoleAssignmentScheduleRequestProperties
| Name | Description | Value |
|---|---|---|
| condition | 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' | string |
| conditionVersion | Version of the condition. Currently accepted value is '2.0' | string |
| justification | Justification for the role assignment | string |
| linkedRoleEligibilityScheduleId | The linked role eligibility schedule id - to activate an eligibility. | string |
| principalId | The principal ID. | string (required) |
| requestType | The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc | 'AdminAssign' 'AdminExtend' 'AdminRemove' 'AdminRenew' 'AdminUpdate' 'SelfActivate' 'SelfDeactivate' 'SelfExtend' 'SelfRenew' (required) |
| roleDefinitionId | The role definition ID. | string (required) |
| scheduleInfo | Schedule info of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfo |
| targetRoleAssignmentScheduleId | The resultant role assignment schedule id or the role assignment schedule id being updated | string |
| targetRoleAssignmentScheduleInstanceId | The role assignment schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role assignment | RoleAssignmentScheduleRequestPropertiesTicketInfo |
RoleAssignmentScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role assignment schedule | RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration |
| startDateTime | Start DateTime of the role assignment schedule. | string |
RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role assignment schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role assignment schedule. | string |
| type | Type of the role assignment schedule expiration | 'AfterDateTime' 'AfterDuration' 'NoExpiration' |
RoleAssignmentScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role assignment | string |
| ticketSystem | Ticket system name for the role assignment | string |
Feedback
Was this page helpful?