Microsoft.Authorization roleEligibilityScheduleRequests 2020-10-01-preview
Bicep resource definition
The roleEligibilityScheduleRequests resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
The roleEligibilityScheduleRequests resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
- Subscriptions - See subscription deployment commands
- Management groups - See management group deployment commands
- Tenants - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleEligibilityScheduleRequests resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01-preview' = {
name: 'string'
scope: resourceSymbolicName or tenant()
properties: {
condition: 'string'
conditionVersion: 'string'
justification: 'string'
principalId: 'string'
requestType: 'string'
roleDefinitionId: 'string'
scheduleInfo: {
expiration: {
duration: 'string'
endDateTime: 'string'
type: 'string'
}
startDateTime: 'string'
}
targetRoleEligibilityScheduleId: 'string'
targetRoleEligibilityScheduleInstanceId: 'string'
ticketInfo: {
ticketNumber: 'string'
ticketSystem: 'string'
}
}
}
Property values
roleEligibilityScheduleRequests
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. This resource type can also be applied to a tenant. For Bicep, use tenant(). |
| properties | Role eligibility schedule request properties. | RoleEligibilityScheduleRequestProperties |
RoleEligibilityScheduleRequestProperties
| 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 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 eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo |
| targetRoleEligibilityScheduleId | The resultant role eligibility schedule id or the role eligibility schedule id being updated | string |
| targetRoleEligibilityScheduleInstanceId | The role eligibility schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role eligibility | RoleEligibilityScheduleRequestPropertiesTicketInfo |
RoleEligibilityScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo... |
| startDateTime | Start DateTime of the role eligibility schedule. | string |
RoleEligibilityScheduleRequestPropertiesScheduleInfo...
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role eligibility schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role eligibility schedule. | string |
| type | Type of the role eligibility schedule expiration | 'AfterDateTime' 'AfterDuration' 'NoExpiration' |
RoleEligibilityScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role eligibility | string |
| ticketSystem | Ticket system name for the role eligibility | string |
ARM template resource definition
The roleEligibilityScheduleRequests resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
The roleEligibilityScheduleRequests resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
- Subscriptions - See subscription deployment commands
- Management groups - See management group deployment commands
- Tenants - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleEligibilityScheduleRequests resource, add the following JSON to your template.
{
"type": "Microsoft.Authorization/roleEligibilityScheduleRequests",
"apiVersion": "2020-10-01-preview",
"name": "string",
"scope": "string" or "/",
"properties": {
"condition": "string",
"conditionVersion": "string",
"justification": "string",
"principalId": "string",
"requestType": "string",
"roleDefinitionId": "string",
"scheduleInfo": {
"expiration": {
"duration": "string",
"endDateTime": "string",
"type": "string"
},
"startDateTime": "string"
},
"targetRoleEligibilityScheduleId": "string",
"targetRoleEligibilityScheduleInstanceId": "string",
"ticketInfo": {
"ticketNumber": "string",
"ticketSystem": "string"
}
}
}
Property values
roleEligibilityScheduleRequests
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Authorization/roleEligibilityScheduleRequests' |
| apiVersion | The resource api version | '2020-10-01-preview' |
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. This resource type can also be applied to a tenant. For JSON, use "/". |
| properties | Role eligibility schedule request properties. | RoleEligibilityScheduleRequestProperties |
RoleEligibilityScheduleRequestProperties
| 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 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 eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo |
| targetRoleEligibilityScheduleId | The resultant role eligibility schedule id or the role eligibility schedule id being updated | string |
| targetRoleEligibilityScheduleInstanceId | The role eligibility schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role eligibility | RoleEligibilityScheduleRequestPropertiesTicketInfo |
RoleEligibilityScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo... |
| startDateTime | Start DateTime of the role eligibility schedule. | string |
RoleEligibilityScheduleRequestPropertiesScheduleInfo...
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role eligibility schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role eligibility schedule. | string |
| type | Type of the role eligibility schedule expiration | 'AfterDateTime' 'AfterDuration' 'NoExpiration' |
RoleEligibilityScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role eligibility | string |
| ticketSystem | Ticket system name for the role eligibility | string |
Terraform (AzAPI provider) resource definition
The roleEligibilityScheduleRequests resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
The roleEligibilityScheduleRequests resource type can be deployed with operations that target:
- Resource groups
- Subscriptions
- Management groups
- Tenants
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Authorization/roleEligibilityScheduleRequests resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
condition = "string"
conditionVersion = "string"
justification = "string"
principalId = "string"
requestType = "string"
roleDefinitionId = "string"
scheduleInfo = {
expiration = {
duration = "string"
endDateTime = "string"
type = "string"
}
startDateTime = "string"
}
targetRoleEligibilityScheduleId = "string"
targetRoleEligibilityScheduleInstanceId = "string"
ticketInfo = {
ticketNumber = "string"
ticketSystem = "string"
}
}
})
}
Property values
roleEligibilityScheduleRequests
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Role eligibility schedule request properties. | RoleEligibilityScheduleRequestProperties |
RoleEligibilityScheduleRequestProperties
| 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 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 eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo |
| targetRoleEligibilityScheduleId | The resultant role eligibility schedule id or the role eligibility schedule id being updated | string |
| targetRoleEligibilityScheduleInstanceId | The role eligibility schedule instance id being updated | string |
| ticketInfo | Ticket Info of the role eligibility | RoleEligibilityScheduleRequestPropertiesTicketInfo |
RoleEligibilityScheduleRequestPropertiesScheduleInfo
| Name | Description | Value |
|---|---|---|
| expiration | Expiration of the role eligibility schedule | RoleEligibilityScheduleRequestPropertiesScheduleInfo... |
| startDateTime | Start DateTime of the role eligibility schedule. | string |
RoleEligibilityScheduleRequestPropertiesScheduleInfo...
| Name | Description | Value |
|---|---|---|
| duration | Duration of the role eligibility schedule in TimeSpan. | string |
| endDateTime | End DateTime of the role eligibility schedule. | string |
| type | Type of the role eligibility schedule expiration | "AfterDateTime" "AfterDuration" "NoExpiration" |
RoleEligibilityScheduleRequestPropertiesTicketInfo
| Name | Description | Value |
|---|---|---|
| ticketNumber | Ticket number for the role eligibility | string |
| ticketSystem | Ticket system name for the role eligibility | string |