JobSchedule Classe

  • Referência

Classe para gerir agendas de tarefas.

Herança
azure.ai.ml.entities._mixins.RestTranslatableMixin
JobSchedule
azure.ai.ml.entities._schedule.schedule.Schedule
JobSchedule
azure.ai.ml.entities._mixins.TelemetryMixin
JobSchedule

Construtor

JobSchedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger, create_job: Job | str, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs)

Parâmetros

name
str

O nome da agenda.

trigger
Union[CronTrigger, RecurrenceTrigger]

A configuração do acionador para a agenda.

create_job
Union[Job, str]

A definição da tarefa ou um nome de tarefa existente.

display_name
Optional[str]

O nome a apresentar da agenda.

description
Optional[str]

A descrição da agenda.

tags
Optional[dict[str, str]]

Dicionário de etiquetas. As etiquetas podem ser adicionadas, removidas e atualizadas.

properties
Optional[dict[str, str]]

Um dicionário de propriedades a associar à agenda.

Exemplos

Configurar um JobSchedule.


   from azure.ai.ml import load_job
   from azure.ai.ml.entities import JobSchedule, RecurrencePattern, RecurrenceTrigger

   pipeline_job = load_job("./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml")
   trigger = RecurrenceTrigger(
       frequency="week",
       interval=4,
       schedule=RecurrencePattern(hours=10, minutes=15, week_days=["Monday", "Tuesday"]),
       start_time="2023-03-10",
   )
   job_schedule = JobSchedule(name="simple_sdk_create_schedule", trigger=trigger, create_job=pipeline_job)

Métodos

dump

Despeje o conteúdo da agenda num ficheiro no formato YAML.

dump

Despeje o conteúdo da agenda num ficheiro no formato YAML.

dump(dest: str | PathLike | IO, **kwargs) -> None

Parâmetros

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Necessário

O caminho local ou o fluxo de ficheiros no qual escrever o conteúdo YAML. Se dest for um caminho de ficheiro, será criado um novo ficheiro. Se dest for um ficheiro aberto, o ficheiro será escrito diretamente.

kwargs
dict

Argumentos adicionais a transmitir para o serializador YAML.

Exceções

FileExistsError

Gerado se dest for um caminho de ficheiro e o ficheiro já existir.

IOError

Gerado se dest for um ficheiro aberto e o ficheiro não for gravável.

Atributos

base_path

O caminho base do recurso.

Devoluções

O caminho base do recurso.

Tipo de retorno

str

create_job

Devolver a tarefa associada à agenda.

Devoluções

A definição da tarefa ou um nome de tarefa existente.

Tipo de retorno

Union[Job, str]

creation_context

O contexto de criação do recurso.

Devoluções

Os metadados de criação do recurso.

Tipo de retorno

Optional[SystemData]

id

O ID do recurso.

Devoluções

O ID global do recurso, um ID de Resource Manager do Azure (ARM).

Tipo de retorno

Optional[str]

is_enabled

Especifica se a agenda está ativada ou não.

Devoluções

Verdadeiro se a agenda estiver ativada, Caso contrário, falso.

Tipo de retorno

bool

provisioning_state

Devolve o estado de aprovisionamento da agenda. Os valores possíveis incluem "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled".

Devoluções

O estado de aprovisionamento da agenda.

Tipo de retorno

str

type

O tipo de agenda. Os valores aceites são "tarefa" e "monitor".

Devoluções

O tipo de agenda.

Tipo de retorno

str