Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Schedule

Package version

Represents a Schedule to execute a task.

Hierarchy

Index

Properties

Optional frequency

The frequency of this scheduled task.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

Indicates whether or not this scheduled task is enabled.

Optional systemData

systemData: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional time

time: undefined | string

The target time to trigger the action. The format is HH:MM.

Optional timeZone

timeZone: undefined | string

The IANA timezone id at which the schedule should execute.

Optional type

type: undefined | string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Optional typePropertiesType

typePropertiesType: ScheduledType

Supported type this scheduled task represents.

Generated using TypeDoc