azure.ai.ml.entities.MonitorSchedule.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.MonitorSchedule
name: MonitorSchedule
fullName: azure.ai.ml.entities.MonitorSchedule
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._schedule.schedule.Schedule
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: Monitor schedule.
constructor:
  syntax: 'MonitorSchedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger
    | None, create_monitor: MonitorDefinition, display_name: str | None = None, description:
    str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - name: name
    description: The schedule name.
    types:
    - <xref:str>
  - name: trigger
    description: The schedule trigger.
    types:
    - <xref:typing.Union>[<xref:azure.ai.ml.entities.CronTrigger>, <xref:azure.ai.ml.entities.RecurrenceTrigger>]
  - name: create_monitor
    description: The schedule action monitor definition.
    types:
    - <xref:azure.ai.ml.entities.MonitorDefinition>
  - name: display_name
    description: The display name of the schedule.
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: description
    description: A description of the schedule.
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: tags
    description: Tag dictionary. Tags can be added, removed, and updated.
    types:
    - <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:str>]]
  - name: properties
    description: The job property dictionary.
    types:
    - <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:str>]]
methods:
- uid: azure.ai.ml.entities.MonitorSchedule.dump
  name: dump
  summary: Dump the asset content into a file in YAML format.
  signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
  parameters:
  - name: dest
    description: 'The local path or file stream to write the YAML content to.

      If dest is a file path, a new file will be created.

      If dest is an open file, the file will be written to directly.'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
  exceptions:
  - type: FileExistsError
    description: Raised if dest is a file path and the file already exists.
  - type: IOError
    description: Raised if dest is an open file and the file is not writable.
attributes:
- uid: azure.ai.ml.entities.MonitorSchedule.base_path
  name: base_path
  summary: The base path of the resource.
  return:
    description: The base path of the resource.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.MonitorSchedule.create_job
  name: create_job
  summary: The create_job entity associated with the schedule if exists.
- uid: azure.ai.ml.entities.MonitorSchedule.creation_context
  name: creation_context
  summary: The creation context of the resource.
  return:
    description: The creation metadata for the resource.
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.entities.MonitorSchedule.id
  name: id
  summary: The resource ID.
  return:
    description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.MonitorSchedule.is_enabled
  name: is_enabled
  summary: Specifies if the schedule is enabled or not.
  return:
    description: True if the schedule is enabled, False otherwise.
    types:
    - <xref:bool>
- uid: azure.ai.ml.entities.MonitorSchedule.provisioning_state
  name: provisioning_state
  summary: 'Returns the schedule''s provisioning state. The possible values include

    "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled".'
  return:
    description: The schedule's provisioning state.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.MonitorSchedule.type
  name: type
  summary: The schedule type. Accepted values are 'job' and 'monitor'.
  return:
    description: The schedule type.
    types:
    - <xref:str>