Partilhar via


JobScheduleOperations Classe

Operações jobScheduleOperations.

Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la e anexá-la como atributo.

Herança
builtins.object
JobScheduleOperations

Construtor

JobScheduleOperations(client, config, serializer, deserializer)

Parâmetros

client
Necessário

Cliente para pedidos de serviço.

config
Necessário

Configuração do cliente de serviço.

serializer
Necessário

Um serializador de modelo de objeto.

deserializer
Necessário

Um desserializador de modelo de objeto.

Variáveis

api_version

A versão da API a utilizar para o pedido. Valor constante: "2023-05-01.17.0".

Métodos

add

Adiciona uma Agenda de Tarefas à Conta especificada.

delete

Elimina uma Agenda de Tarefas da Conta especificada.

Quando elimina uma Agenda de Tarefas, esta ação também elimina todas as Tarefas e Tarefas ao abrigo desse agendamento. Quando as Tarefas são eliminadas, todos os ficheiros nos respetivos diretórios de trabalho nos Nós de Computação também são eliminados (o período de retenção é ignorado). As estatísticas de Agendamento de Tarefas deixarão de estar acessíveis depois de a Agenda de Tarefas ser eliminada, embora ainda sejam contabilizadas para as estatísticas de duração da conta.

disable

Desativa uma Agenda de Tarefas.

Não serão criadas novas Tarefas até que a Agenda de Tarefas seja ativada novamente.

enable

Ativa uma Agenda de Tarefas.

exists

Verifica se a Agenda de Tarefas especificada existe.

get

Obtém informações sobre a Agenda de Tarefas especificada.

list

Lista todas as Agendas de Tarefas na Conta especificada.

patch

Atualizações as propriedades da Agenda de Tarefas especificada.

Esta ação substitui apenas as propriedades de Agendamento de Tarefas especificadas no pedido. Por exemplo, se a propriedade schedule não for especificada com este pedido, o serviço Batch manterá a agenda existente. As alterações a uma Agenda de Tarefas só afetam as Tarefas criadas pela agenda após a atualização ter ocorrido; Atualmente, as tarefas em execução não são afetadas.

terminate

Termina uma Agenda de Tarefas.

update

Atualizações as propriedades da Agenda de Tarefas especificada.

Esta ação substitui totalmente todas as propriedades atualizáveis da Agenda de Tarefas. Por exemplo, se a propriedade schedule não for especificada com este pedido, o serviço Batch removerá a agenda existente. As alterações a uma Agenda de Tarefas só afetam as Tarefas criadas pela agenda após a atualização ter ocorrido; Atualmente, as tarefas em execução não são afetadas.

add

Adiciona uma Agenda de Tarefas à Conta especificada.

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

cloud_job_schedule
JobScheduleAddParameter
Necessário

A Agenda de Tarefas a adicionar.

job_schedule_add_options
JobScheduleAddOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

delete

Elimina uma Agenda de Tarefas da Conta especificada.

Quando elimina uma Agenda de Tarefas, esta ação também elimina todas as Tarefas e Tarefas ao abrigo desse agendamento. Quando as Tarefas são eliminadas, todos os ficheiros nos respetivos diretórios de trabalho nos Nós de Computação também são eliminados (o período de retenção é ignorado). As estatísticas de Agendamento de Tarefas deixarão de estar acessíveis depois de a Agenda de Tarefas ser eliminada, embora ainda sejam contabilizadas para as estatísticas de duração da conta.

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a eliminar.

job_schedule_delete_options
JobScheduleDeleteOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

disable

Desativa uma Agenda de Tarefas.

Não serão criadas novas Tarefas até que a Agenda de Tarefas seja ativada novamente.

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a desativar.

job_schedule_disable_options
JobScheduleDisableOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

enable

Ativa uma Agenda de Tarefas.

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a ativar.

job_schedule_enable_options
JobScheduleEnableOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

exists

Verifica se a Agenda de Tarefas especificada existe.

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas que pretende verificar.

job_schedule_exists_options
JobScheduleExistsOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

bool ou ClientRawResponse se raw=true

Tipo de retorno

bool,

Exceções

get

Obtém informações sobre a Agenda de Tarefas especificada.

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a obter.

job_schedule_get_options
JobScheduleGetOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

CloudJobSchedule ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

list

Lista todas as Agendas de Tarefas na Conta especificada.

list(job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_list_options
JobScheduleListOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Um iterador como a instância do CloudJobSchedule

Tipo de retorno

Exceções

patch

Atualizações as propriedades da Agenda de Tarefas especificada.

Esta ação substitui apenas as propriedades de Agendamento de Tarefas especificadas no pedido. Por exemplo, se a propriedade schedule não for especificada com este pedido, o serviço Batch manterá a agenda existente. As alterações a uma Agenda de Tarefas só afetam as Tarefas criadas pela agenda após a atualização ter ocorrido; Atualmente, as tarefas em execução não são afetadas.

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a atualizar.

job_schedule_patch_parameter
JobSchedulePatchParameter
Necessário

Os parâmetros do pedido.

job_schedule_patch_options
JobSchedulePatchOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

terminate

Termina uma Agenda de Tarefas.

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a terminar.

job_schedule_terminate_options
JobScheduleTerminateOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

update

Atualizações as propriedades da Agenda de Tarefas especificada.

Esta ação substitui totalmente todas as propriedades atualizáveis da Agenda de Tarefas. Por exemplo, se a propriedade schedule não for especificada com este pedido, o serviço Batch removerá a agenda existente. As alterações a uma Agenda de Tarefas só afetam as Tarefas criadas pela agenda após a atualização ter ocorrido; Atualmente, as tarefas em execução não são afetadas.

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_schedule_id
str
Necessário

O ID da Agenda de Tarefas a atualizar.

job_schedule_update_parameter
JobScheduleUpdateParameter
Necessário

Os parâmetros do pedido.

job_schedule_update_options
JobScheduleUpdateOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

Substituições da configuração da operação.

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

Atributos

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>