AutomationModels.ScheduleProperties.yml

### YamlMime:TSType
name: ScheduleProperties
uid: '@azure/arm-automation.AutomationModels.ScheduleProperties'
package: '@azure/arm-automation'
summary: Definition of schedule parameters.
fullName: ScheduleProperties
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: advancedSchedule
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.advancedSchedule'
    package: '@azure/arm-automation'
    summary: Gets or sets the advanced schedule.
    fullName: advancedSchedule
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'advancedSchedule?: AdvancedSchedule'
      return:
        description: ''
        type: <xref uid="@azure/arm-automation.AutomationModels.AdvancedSchedule" />
  - name: creationTime
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.creationTime'
    package: '@azure/arm-automation'
    summary: Gets or sets the creation time.
    fullName: creationTime
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'creationTime?: Date'
      return:
        description: ''
        type: Date
  - name: description
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.description'
    package: '@azure/arm-automation'
    summary: Gets or sets the description.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
  - name: expiryTime
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.expiryTime'
    package: '@azure/arm-automation'
    summary: Gets or sets the end time of the schedule.
    fullName: expiryTime
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'expiryTime?: Date'
      return:
        description: ''
        type: Date
  - name: expiryTimeOffsetMinutes
    uid: >-
      @azure/arm-automation.AutomationModels.ScheduleProperties.expiryTimeOffsetMinutes
    package: '@azure/arm-automation'
    summary: Gets or sets the expiry time's offset in minutes.
    fullName: expiryTimeOffsetMinutes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'expiryTimeOffsetMinutes?: number'
      return:
        description: ''
        type: number
  - name: frequency
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.frequency'
    package: '@azure/arm-automation'
    summary: >-
      Gets or sets the frequency of the schedule. Possible values include:
      'OneTime', 'Day', 'Hour',

      'Week', 'Month'
    fullName: frequency
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'frequency?: ScheduleFrequency'
      return:
        description: ''
        type: >-
          <xref uid="@azure/arm-automation.AutomationModels.ScheduleFrequency"
          />
  - name: interval
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.interval'
    package: '@azure/arm-automation'
    summary: Gets or sets the interval of the schedule.
    fullName: interval
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'interval?: number'
      return:
        description: ''
        type: number
  - name: isEnabled
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.isEnabled'
    package: '@azure/arm-automation'
    summary: >-
      Gets or sets a value indicating whether this schedule is enabled. Default
      value: false.
    fullName: isEnabled
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isEnabled?: boolean'
      return:
        description: ''
        type: boolean
  - name: lastModifiedTime
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.lastModifiedTime'
    package: '@azure/arm-automation'
    summary: Gets or sets the last modified time.
    fullName: lastModifiedTime
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastModifiedTime?: Date'
      return:
        description: ''
        type: Date
  - name: nextRun
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.nextRun'
    package: '@azure/arm-automation'
    summary: Gets or sets the next run time of the schedule.
    fullName: nextRun
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'nextRun?: Date'
      return:
        description: ''
        type: Date
  - name: nextRunOffsetMinutes
    uid: >-
      @azure/arm-automation.AutomationModels.ScheduleProperties.nextRunOffsetMinutes
    package: '@azure/arm-automation'
    summary: Gets or sets the next run time's offset in minutes.
    fullName: nextRunOffsetMinutes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'nextRunOffsetMinutes?: number'
      return:
        description: ''
        type: number
  - name: startTime
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.startTime'
    package: '@azure/arm-automation'
    summary: Gets or sets the start time of the schedule.
    fullName: startTime
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'startTime?: Date'
      return:
        description: ''
        type: Date
  - name: startTimeOffsetMinutes
    uid: >-
      @azure/arm-automation.AutomationModels.ScheduleProperties.startTimeOffsetMinutes
    package: '@azure/arm-automation'
    summary: >-
      Gets the start time's offset in minutes.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: startTimeOffsetMinutes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'startTimeOffsetMinutes?: number'
      return:
        description: ''
        type: number
  - name: timeZone
    uid: '@azure/arm-automation.AutomationModels.ScheduleProperties.timeZone'
    package: '@azure/arm-automation'
    summary: Gets or sets the time zone of the schedule.
    fullName: timeZone
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'timeZone?: string'
      return:
        description: ''
        type: string