Microsoft Azure GetAccessReviewHistoryDefinition API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GetAccessReviewHistoryDefinition API
schemes:
- https
tags:
- name: GetAccessReviewHistoryDefinition
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}:
    get:
      tags:
      - GetAccessReviewHistoryDefinition
      operationId: microsoftAzureAccessreviewhistorydefinitionsGetbyid
      x-ms-examples:
        GetAccessReviewHistoryDefinition:
          $ref: ./examples/GetAccessReviewHistoryDefinition.json
      description: Get access review history definition by definition Id
      parameters:
      - name: historyDefinitionId
        in: path
        required: true
        type: string
        description: The id of the access review history definition.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: AccessReviewHistoryDefinition
          schema:
            $ref: '#/definitions/AccessReviewHistoryDefinition'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/ErrorDefinition'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Authorization Accessreviewhistorydefinitions Historydefinitionid
definitions:
  ErrorDefinition:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinitionProperties'
        description: Error of the list gateway status.
  AccessReviewHistoryInstance:
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        type: string
        readOnly: true
        description: The access review history definition instance id.
      name:
        type: string
        readOnly: true
        description: The access review history definition instance unique id.
      type:
        type: string
        readOnly: true
        description: The resource type.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewHistoryInstanceProperties'
        description: Access Review History Definition Instance properties.
    description: Access Review History Definition Instance.
  AccessReviewHistoryDefinitionProperties:
    type: object
    properties:
      displayName:
        type: string
        description: The display name for the history definition.
      reviewHistoryPeriodStartDateTime:
        type: string
        format: date-time
        description: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
        x-nullable: true
        readOnly: true
      reviewHistoryPeriodEndDateTime:
        type: string
        format: date-time
        description: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
        x-nullable: true
        readOnly: true
      decisions:
        type: array
        items:
          type: string
          description: Represents a reviewer's decision for a given review
          enum:
          - Approve
          - Deny
          - NotReviewed
          - DontKnow
          - NotNotified
          x-ms-enum:
            name: AccessReviewResult
            modelAsString: true
        description: Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
        x-nullable: true
      status:
        type: string
        readOnly: true
        description: This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
        enum:
        - Requested
        - InProgress
        - Done
        - Error
        x-ms-enum:
          name: AccessReviewHistoryDefinitionStatus
          modelAsString: true
      createdDateTime:
        type: string
        format: date-time
        description: Date time when history definition was created
        x-nullable: true
        readOnly: true
      createdBy:
        x-nullable: true
        readOnly: true
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewActorIdentity'
        description: The user or other identity who created this history definition.
      scopes:
        x-nullable: false
        type: array
        items:
          $ref: '#/definitions/AccessReviewScope'
        description: A collection of scopes used when selecting review history data
        x-ms-identifiers: []
      settings:
        x-ms-client-flatten: true
        x-nullable: true
        $ref: '#/definitions/AccessReviewHistoryScheduleSettings'
        description: Recurrence settings for recurring history reports, skip for one-time reports.
      instances:
        type: array
        items:
          $ref: '#/definitions/AccessReviewHistoryInstance'
        description: Set of access review history instances for this history definition.
    description: Access Review History Instances.
  AccessReviewHistoryDefinition:
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        type: string
        readOnly: true
        description: The access review history definition id.
      name:
        type: string
        readOnly: true
        description: The access review history definition unique id.
      type:
        type: string
        readOnly: true
        description: The resource type.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewHistoryDefinitionProperties'
        description: Access Review History Definition properties.
    description: Access Review History Definition.
  AccessReviewActorIdentity:
    type: object
    properties:
      principalId:
        type: string
        readOnly: true
        description: The identity id
      principalType:
        type: string
        readOnly: true
        description: 'The identity type : user/servicePrincipal'
        enum:
        - user
        - servicePrincipal
        x-ms-enum:
          name: AccessReviewActorIdentityType
          modelAsString: true
      principalName:
        type: string
        readOnly: true
        description: The identity display name
      userPrincipalName:
        type: string
        readOnly: true
        description: The user principal name(if valid)
    description: Details of the actor identity
  AccessReviewRecurrencePattern:
    type: object
    properties:
      type:
        type: string
        description: 'The recurrence type : weekly, monthly, etc.'
        enum:
        - weekly
        - absoluteMonthly
        x-ms-enum:
          name: AccessReviewRecurrencePatternType
          modelAsString: true
      interval:
        type: integer
        format: int32
        description: 'The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.'
    description: Recurrence Pattern of an Access Review Schedule Definition.
  AccessReviewRecurrenceRange:
    type: object
    properties:
      type:
        type: string
        description: 'The recurrence range type. The possible values are: endDate, noEnd, numbered.'
        enum:
        - endDate
        - noEnd
        - numbered
        x-ms-enum:
          name: AccessReviewRecurrenceRangeType
          modelAsString: true
      numberOfOccurrences:
        type: integer
        format: int32
        description: The number of times to repeat the access review. Required and must be positive if type is numbered.
      startDate:
        type: string
        format: date-time
        description: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
        x-nullable: true
      endDate:
        type: string
        format: date-time
        description: The DateTime when the review is scheduled to end. Required if type is endDate
        x-nullable: true
    description: Recurrence Range of an Access Review Schedule Definition.
  AccessReviewScope:
    type: object
    properties:
      resourceId:
        type: string
        readOnly: true
        description: ResourceId in which this review is getting created
      roleDefinitionId:
        type: string
        readOnly: true
        description: This is used to indicate the role being reviewed
      principalType:
        type: string
        readOnly: true
        description: The identity type user/servicePrincipal to review
        enum:
        - user
        - guestUser
        - servicePrincipal
        - user,group
        - redeemedGuestUser
        x-ms-enum:
          name: AccessReviewScopePrincipalType
          modelAsString: true
      assignmentState:
        type: string
        readOnly: true
        description: The role assignment state eligible/active to review
        enum:
        - eligible
        - active
        x-ms-enum:
          name: AccessReviewScopeAssignmentState
          modelAsString: true
      inactiveDuration:
        type: string
        format: duration
        description: 'Duration users are inactive for. The value should be in ISO  8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))'
      expandNestedMemberships:
        type: boolean
        description: Flag to indicate whether to expand nested memberships or not.
    description: Descriptor for what needs to be reviewed
  AccessReviewHistoryInstanceProperties:
    type: object
    properties:
      reviewHistoryPeriodStartDateTime:
        type: string
        format: date-time
        readOnly: false
        description: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
      reviewHistoryPeriodEndDateTime:
        type: string
        format: date-time
        readOnly: false
        description: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
      displayName:
        type: string
        description: The display name for the parent history definition.
      status:
        type: string
        readOnly: true
        description: Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
        enum:
        - Requested
        - InProgress
        - Done
        - Error
        x-ms-enum:
          name: AccessReviewHistoryDefinitionStatus
          modelAsString: true
      runDateTime:
        type: string
        format: date-time
        description: Date time when the history data report is scheduled to be generated.
        x-nullable: true
      fulfilledDateTime:
        type: string
        format: date-time
        description: Date time when the history data report is scheduled to be generated.
        x-nullable: true
      downloadUri:
        readOnly: true
        type: string
        description: Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
      expiration:
        type: string
        format: date-time
        description: Date time when history data report expires and the associated data is deleted.
        x-nullable: true
    description: Access Review History Definition Instance properties.
  ErrorDefinitionProperties:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      message:
        type: string
        readOnly: true
        description: Description of the error.
      code:
        type: string
        description: Error code of list gateway.
  AccessReviewHistoryScheduleSettings:
    type: object
    properties:
      pattern:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewRecurrencePattern'
        description: Access Review History Definition recurrence settings.
      range:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewRecurrenceRange'
        description: Access Review History Definition recurrence settings.
    description: Recurrence settings of an Access Review History Definition.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'