Availability Element

  • Article

 

Important

This topic and its sub-topics provides the JSON format that is supported by the older versions of Azure PowerShell. If you are using the July 2015 Release version of Azure PowerShell or later, see Availability Element for the latest JSON format. You can convert the JSON from old format to new format by using the tool: JSON Upgrade Tool 

The Availability section in a JSON file that defines an Azure Data Factory table defines the cadence in which a slice of the table is produced. The following properties are supported for Availability

Available Property

Description

frequency

Specifies the time unit for data slice production.Supported frequency:Minute, Hour, Day, Week, Month

If you need the data slices to be produced on an hourly basis, you set Frequency to Hour, and interval to 1.

If you specify Frequency as Minute, we recommend that you set the interval to at least 15.

interval

Specifies how often the slice is produced.

waitOnExternal

Specifies the waiting time for external data to be available. This property is used only with external tables (tables not produced by Azure Data Factory).

Example:

availability: {
    frequency: "Hour",
    interval: 1,
    waitOnExternal:
    {
        retryInterval: "00:01:00",
        retryTimeout: "00:10:00",
        maximumRetry: 3
    }
}

See External Tables for details including descriptions of properties in the availability section.

style

Specifies whether the slice should be produced at the start/end of the interval.

  • StartOfInterval

  • EndOfInterval

If Frequency is set to Month and style is set to EndOfInterval, the slice is produced on the last day of month. If the style is set to StartOfInterval, the slice is produced on the first day of moth.

If Frequency is set to Day and style is set to EndOfInterval, the slice is produced in the last hour of the day.

If Frequency is set to Hour and style is set to EndOfInterval, the slice is produced at the end of the interval. For example, for a slice for 1 PM – 2 PM period, the slice is produced at 2 PM.

anchorDateTime

Specifies when the slice would be produced with in the time frame. For example, if the slice is produced daily, you can specify what time of the day the time of the day the slice is produced (for example: 8 AM or 8 PM).

Example:

"anchorDateTime": "2014-10-18T00:01:00Z"

Example: for a weekly schedule, You can specify anchor time of Tuesday Nov. 4, 2014, 3 AM. This means that the scheduling will happen every Tuesday at 3 AM.

Example 2: For a daily schedule, if you set anchorDateTime = 10/20/2014 6 AM means that the scheduling will happen every day at 6 AM.

Example 3: For a monthly schedule and interval = 12, (every 12 months) AnchorDateTime = 03/02/2014 means every year on March 2nd.

Note

If the AnchorDateTime has date parts that are more granular than the interval, then the more granular parts will be ignored. For example, if the interval is hourly (frequency: hour and interval: 1) and the AnchorDateTime contains minutes and seconds, then the minutes and seconds parts of the AnchorDateTime will be ignored.

Offset

Specifies the relative shift of scheduling time.

For example, if you set the Offset to 2.03:00:00 (2 days and 3 hrs: relative to Sunday), the slice is produced on Tuesday at 3 AM.

<days>.<hours>:<minutes>:<seconds>

<hours>:<minutes>:<seconds>

Example: on a daily schedule, Offset = 06:00:00 means every day at 6 AM.

Example: For a 12 month (frequency = month; interval = 12) schedule, offset: 60.00:00:00 means every year on March 2nd or 3rd (60 days from the beginning of the year if style = StartOfInterval), depending on the year being leap year or not.

The two parameters anchorDateTime and Offset determine the start of each scheduled execution period/data slice.

Style (StartOfInterval or EndOfInteval) determines whether the execution can begin at the start or end of the slice.

Example:

Offset: 15 min
Schedule: Hourly

For the hour 10-11, it is shifted by 15 minutes. So the data slice is from: 10:15 to 11:15.

Example 2:

Style: StartOfIntervalThe execution for the data starts at 10:15.

Style:EndOfIntervalThe execution for the data starts at 11:15

Note

If both anchorDateTime and offset are specified, the result is the combined shift.

See Also

Datasets
Structure Element
Location Element
Policy Element
External Tables
Creating Tables with Different Schedules