swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Recurrence API
schemes:
- https
tags:
- name: Recurrence
paths:
  /recurrences:
    get:
      tags:
      - Recurrence
      operationId: microsoftAzureRecurrenceList
      description: Lists all recurrences.
      parameters:
      - name: startDateTime
        in: query
        required: false
        type: string
        format: date-time
        description: The start date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.
      - name: endDateTime
        in: query
        required: false
        type: string
        format: date-time
        description: The end date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of recurrences.
          schema:
            $ref: '#/definitions/JobRecurrenceInformationListResult'
      x-ms-examples:
        Lists all recurrences:
          $ref: ./examples/Recurrence_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Recurrences
  /recurrences/{recurrenceIdentity}:
    get:
      tags:
      - Recurrence
      operationId: microsoftAzureRecurrenceGet
      description: Gets the recurrence information for the specified recurrence ID.
      parameters:
      - name: recurrenceIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Recurrence ID.
      - name: startDateTime
        in: query
        required: false
        type: string
        format: date-time
        description: The start date for when to get the recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
      - name: endDateTime
        in: query
        required: false
        type: string
        format: date-time
        description: The end date for when to get recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved details of the specified pipeline.
          schema:
            $ref: '#/definitions/JobRecurrenceInformation'
      x-ms-examples:
        Gets the recurrence information for the specified recurrence ID:
          $ref: ./examples/Recurrence_Get.json
      summary: Microsoft Azure Get Recurrences Recurrenceidentity
definitions:
  JobRecurrenceInformation:
    properties:
      recurrenceId:
        readOnly: true
        type: string
        format: uuid
        description: The recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together.
      recurrenceName:
        readOnly: true
        type: string
        description: The recurrence name, user friendly name for the correlation between jobs.
      numJobsFailed:
        readOnly: true
        type: integer
        format: int32
        description: The number of jobs in this recurrence that have failed.
      numJobsCanceled:
        readOnly: true
        type: integer
        format: int32
        description: The number of jobs in this recurrence that have been canceled.
      numJobsSucceeded:
        readOnly: true
        type: integer
        format: int32
        description: The number of jobs in this recurrence that have succeeded.
      auHoursFailed:
        readOnly: true
        type: number
        format: double
        description: The number of job execution hours that resulted in failed jobs.
      auHoursCanceled:
        readOnly: true
        type: number
        format: double
        description: The number of job execution hours that resulted in canceled jobs.
      auHoursSucceeded:
        readOnly: true
        type: number
        format: double
        description: The number of job execution hours that resulted in successful jobs.
      lastSubmitTime:
        readOnly: true
        type: string
        format: date-time
        description: The last time a job in this recurrence was submitted.
    description: Recurrence job information for a specific recurrence.
  JobRecurrenceInformationListResult:
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/JobRecurrenceInformation'
        description: The list of job recurrence information items.
      nextLink:
        readOnly: true
        type: string
        description: The link (url) to the next page of results.
    description: List of job recurrence information items.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'