Unregister-ScheduledJob

  • Referência
Módulo:
PSScheduledJob

Exclui trabalhos agendados no computador local.

Syntax

Unregister-ScheduledJob
          [-InputObject] <ScheduledJobDefinition[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-ScheduledJob
          [-Id] <Int32[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-ScheduledJob
          [-Name] <String[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

O Unregister-ScheduledJob cmdlet exclui trabalhos agendados do computador local.

Quando ele exclui ou cancela o registro de um trabalho agendado, Unregister-ScheduledJob exclui o diretório do trabalho agendado (no $HOME\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs directory), que contém o arquivo XML que define o trabalho agendado, o histórico de execução do trabalho e todos os resultados do trabalho. Essa ação também exclui o trabalho do Agendador de Tarefas.

Unregister-ScheduledJob Exclui somente os trabalhos agendados criados usando o Register-ScheduledJob cmdlet. Ele não exclui trabalhos agendados que são criados no Agendador de Tarefas.

Você pode usar os parâmetros de para excluir trabalhos agendados Unregister-ScheduledJob por ID ou nome, ou canalizar trabalhos agendados de Get-ScheduledJob para Unregister-ScheduledJob.

Unregister-ScheduledJob é um de uma coleção de cmdlets de agendamento de trabalho no módulo PSScheduledJob incluído no Windows PowerShell.

Para obter mais informações sobre trabalhos agendados, consulte os tópicos Sobre no módulo PSScheduledJob. Importe o módulo PSScheduledJob e digite: Get-Help about_Scheduled* ou consulte about_Scheduled_Jobs.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Excluir um trabalho agendado

Unregister-ScheduledJob TestJob

Este comando exclui o trabalho agendado TestJob no computador local.

Exemplo 2: Excluir todos os trabalhos agendados

Get-ScheduledJob | Unregister-ScheduledJob -Force
Unregister-ScheduledJob -Name "*" -Force

Este exemplo mostra dois comandos diferentes que excluem todos os trabalhos agendados no computador local.

O primeiro comando usa o Get-ScheduledJob cmdlet para obter todos os trabalhos agendados no computador local. Um operador de pipeline (|) envia os trabalhos agendados para Unregister-ScheduleJobo , que os exclui.

O segundo comando usa o parâmetro Name de Unregister-ScheduledJob com um valor de todos (*) para excluir todos os trabalhos agendados.

Ambos os comandos usam o parâmetro Force , que exclui um trabalho agendado mesmo que uma instância do trabalho esteja em execução.

Exemplo 3: Excluir um trabalho agendado em um computador remoto

Invoke-Command -ComputerName "Server01" { Unregister-ScheduledJob -Name "Test*"}

Este comando exclui trabalhos agendados com nomes que começam com Test no computador remoto Server01. O comando usa o Invoke-Command cmdlet para executá-lo Unregister-ScheduledJob no computador Server02.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Exclui o trabalho agendado mesmo se uma instância do trabalho estiver em execução. Por padrão, Unregister-ScheduledJob não interrompe trabalhos em execução.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Exclui os trabalhos agendados com os números de identificação (ID) especificados. Insira as IDs dos trabalhos agendados no computador.

Type:Int32[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Especifica um trabalho agendado. Insira uma variável que contenha objetos ScheduledJob ou digite um comando ou expressão que obtenha objetos ScheduledJob , como um Get-ScheduledJob comando. Você também pode canalizar objetos ScheduledJob para Unregister-JobTrigger.

Type:Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Exclui os trabalhos agendados com os nomes especificados. Insira os nomes de um ou mais trabalhos agendados no computador. Curingas são suportados.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Você pode canalizar um trabalho agendado para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída.