Role Eligibility Schedule Instances - List For Scope

Gets role eligibility schedule instances of a role eligibility schedule.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances?api-version=2020-10-01
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances?$filter={$filter}&api-version=2020-10-01

URI Parameters

Name In Required Type Description
scope
path True

string

The scope of the role eligibility schedule.

api-version
query True

string

The API version to use for this operation.

$filter
query

string

The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user.

Responses

Name Type Description
200 OK

RoleEligibilityScheduleInstanceListResult

OK - Returns array of role eligibility schedule instances.

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

GetRoleEligibilityScheduleInstancesByScope

Sample request

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleEligibilityScheduleInstances?$filter=assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')&api-version=2020-10-01

Sample response

{
  "value": [
    {
      "properties": {
        "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
        "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c",
        "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
        "principalType": "User",
        "status": "Provisioned",
        "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413",
        "startDateTime": "2020-09-10T00:32:36.86Z",
        "endDateTime": "2021-09-10T00:31:41.477Z",
        "memberType": "Direct",
        "createdOn": "2020-09-10T00:32:36.86Z",
        "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": "21e4b59a-0499-4fe0-a3c3-43a3055b773a",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a",
      "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances"
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ExpandedProperties
MemberType

Membership type of the role eligibility schedule

Principal

Details of the principal

principalType

The principal type of the assigned principal ID.

RoleDefinition

Details of role definition

RoleEligibilityScheduleInstance

Information about current or upcoming role eligibility schedule instance

RoleEligibilityScheduleInstanceListResult

Role eligibility schedule instance list operation result.

Scope

Details of the resource scope

Status

The status of the role eligibility schedule instance

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

An error response from the service.

CloudErrorBody

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

Name Type Description
principal

Principal

Details of the principal

roleDefinition

RoleDefinition

Details of role definition

scope

Scope

Details of the resource scope

MemberType

Membership type of the role eligibility schedule

Name Type Description
Direct

string

Group

string

Inherited

string

Principal

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

The principal type of the assigned principal ID.

Name Type Description
Device

string

ForeignGroup

string

Group

string

ServicePrincipal

string

User

string

RoleDefinition

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

RoleEligibilityScheduleInstance

Information about current or upcoming role eligibility schedule instance

Name Type Description
id

string

The role eligibility schedule instance ID.

name

string

The role eligibility schedule instance name.

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 eligibility schedule was created

properties.endDateTime

string

The endDateTime of the role eligibility schedule instance

properties.expandedProperties

ExpandedProperties

Additional properties of principal, scope and role definition

properties.memberType

MemberType

Membership type of the role eligibility schedule

properties.principalId

string

The principal ID.

properties.principalType

principalType

The principal type of the assigned principal ID.

properties.roleDefinitionId

string

The role definition ID.

properties.roleEligibilityScheduleId

string

Id of the master role eligibility schedule

properties.scope

string

The role eligibility schedule scope.

properties.startDateTime

string

The startDateTime of the role eligibility schedule instance

properties.status

Status

The status of the role eligibility schedule instance

type

string

The role eligibility schedule instance type.

RoleEligibilityScheduleInstanceListResult

Role eligibility schedule instance list operation result.

Name Type Description
nextLink

string

The URL to use for getting the next set of results.

value

RoleEligibilityScheduleInstance[]

Role eligibility schedule instance list.

Scope

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

The status of the role eligibility schedule instance

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