Start-Job

Módulo:

Microsoft.PowerShell.Core

Inicia um trabalho em segundo plano do PowerShell.

Syntax

Start-Job
     [-Name <String>]
     [-ScriptBlock] <ScriptBlock>
     [-Credential <PSCredential>]
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

Start-Job
     [-DefinitionName] <String>
     [[-DefinitionPath] <String>]
     [[-Type] <String>]
     [<CommonParameters>]

Start-Job
     [-Name <String>]
     [-Credential <PSCredential>]
     [-FilePath] <String>
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

Start-Job
     [-Name <String>]
     [-Credential <PSCredential>]
     -LiteralPath <String>
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

Start-Job
     [-VMGuid] <Guid[]>
     [<CommonParameters>]

Start-Job
     [-VMGuid] <Guid[]>
     [<CommonParameters>]

Start-Job
     -VMName <String[]>
     [<CommonParameters>]

Start-Job
     -VMName <String[]>
     [<CommonParameters>]

Description

O Start-Job cmdlet inicia um trabalho em segundo plano do PowerShell no computador local.

Um trabalho em segundo plano do PowerShell executa um comando sem interagir com a sessão atual. Quando você inicia um trabalho em segundo plano, obtém imediatamente como retorno um objeto de trabalho, mesmo que o trabalho demore muito tempo para ser finalizado. É possível continuar a trabalhar na sessão sem interrupção enquanto o trabalho é executado.

O objeto de trabalho contém informações úteis sobre o trabalho, mas não contém os resultados do trabalho. Quando o trabalho for concluído, use o Receive-Job cmdlet para obter os resultados do trabalho. Para obter mais informações sobre trabalhos em segundo plano, consulte about_Jobs.

Para executar um trabalho em segundo plano em um computador remoto, use o parâmetro AsJob que está disponível em muitos cmdlets ou use o Invoke-Command cmdlet para executar um Start-Job comando no computador remoto. Para obter mais informações, consulte about_Remote_Jobs.

A partir do PowerShell 3.0, Start-Job pode iniciar instâncias de tipos de trabalho personalizados, como trabalhos agendados. Para obter informações sobre como usar Start-Job para iniciar trabalhos com tipos personalizados, consulte os documentos de ajuda para o recurso de tipo de trabalho.

Exemplos

Exemplo 1: Iniciar um trabalho em segundo plano

Este exemplo inicia um trabalho executado em segundo plano no computador local.

Start-Job -ScriptBlock {Get-Process}

Id  Name   PSJobTypeName   State     HasMoreData   Location    Command
--  ----   -------------   -----     -----------   --------    -------
1   Job1   BackgroundJob   Running   True          localhost   Get-Process

Start-Job usa o parâmetro ScriptBlock para ser executado Get-Process como um trabalho em segundo plano. As informações do trabalho são exibidas e o PowerShell retorna a um prompt enquanto o trabalho é executado em segundo plano.

Exemplo 2: Iniciar um trabalho usando Invoke-Command

Este exemplo executa um trabalho em vários computadores. O trabalho é armazenado em uma variável e é executado usando o nome da variável na linha de comando do PowerShell.

$jobWRM = Invoke-Command -ComputerName (Get-Content -Path C:\Servers.txt) -ScriptBlock {
   Get-Service -Name WinRM } -JobName WinRM -ThrottleLimit 16 -AsJob

Um trabalho que usa Invoke-Command é criado e armazenado na $jobWRM variável . Invoke-Command usa o parâmetro ComputerName para especificar os computadores em que o trabalho é executado. Get-Content obtém os nomes de servidor do C:\Servers.txt arquivo.

O parâmetro ScriptBlock especifica um comando que Get-Service obtém o serviço WinRM . O parâmetro JobName especifica um nome amigável para o trabalho, WinRM. O parâmetro ThrottleLimit limita o número de comandos simultâneos a 16. O parâmetro AsJob inicia um trabalho em segundo plano que executa o comando nos servidores.

Exemplo 3: Obter informações de trabalho

Este exemplo obtém informações sobre um trabalho e exibe os resultados de um trabalho concluído que foi executado no computador local.

$j = Start-Job -ScriptBlock { Get-WinEvent -Log System } -Credential Domain01\User01
$j | Select-Object -Property *

State         : Completed
HasMoreData   : True
StatusMessage :
Location      : localhost
Command       : Get-WinEvent -Log System
JobStateInfo  : Completed
Finished      : System.Threading.ManualResetEvent
InstanceId    : 27ce3fd9-40ed-488a-99e5-679cd91b9dd3
Id            : 18
Name          : Job18
ChildJobs     : {Job19}
PSBeginTime   : 8/8/2019 14:41:57
PSEndTime     : 8/8/2019 14:42:07
PSJobTypeName : BackgroundJob
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}

Start-Job usa o parâmetro ScriptBlock para executar um comando que especifica Get-WinEvent para obter o log do sistema . O parâmetro Credential especifica uma conta de usuário de domínio com permissão para executar o trabalho no computador. O objeto de trabalho é armazenado na $j variável .

O objeto na $j variável é enviado pelo pipeline para Select-Object. O parâmetro Property especifica um asterisco (*) para exibir todas as propriedades do objeto de trabalho.

Exemplo 4: executar um script como um trabalho em segundo plano

Neste exemplo, um script no computador local é executado como um trabalho em segundo plano.

Start-Job -FilePath C:\Scripts\Sample.ps1

Start-Job usa o parâmetro FilePath para especificar um arquivo de script armazenado no computador local.

Exemplo 5: Obter um processo usando um trabalho em segundo plano

Este exemplo usa um trabalho em segundo plano para obter um processo especificado por nome.

Start-Job -Name PShellJob -ScriptBlock { Get-Process -Name PowerShell }

Start-Job usa o parâmetro Name para especificar um nome de trabalho amigável, PShellJob. O parâmetro ScriptBlock especifica Get-Process para obter processos com o nome PowerShell.

Exemplo 6: Coletar e salvar dados usando um trabalho em segundo plano

Este exemplo inicia um trabalho que coleta uma grande quantidade de dados de mapa e os salva em um .tif arquivo.

Start-Job -Name GetMappingFiles -InitializationScript {Import-Module MapFunctions} -ScriptBlock {
   Get-Map -Name * | Set-Content -Path D:\Maps.tif } -RunAs32

Start-Job usa o parâmetro Name para especificar um nome de trabalho amigável, GetMappingFiles. O parâmetro InitializationScript executa um bloco de script que importa o módulo MapFunctions . O parâmetro ScriptBlock é executado Get-Map e Set-Content salva os dados no local especificado pelo parâmetro Path . O parâmetro RunAs32 executa o processo como de 32 bits, mesmo em um sistema operacional de 64 bits.

Exemplo 7: passar a entrada para um trabalho em segundo plano

Este exemplo usa a $input variável automática para processar um objeto de entrada. Use Receive-Job para exibir a saída do trabalho.

Start-Job -ScriptBlock { Get-Content $input } -InputObject "C:\Servers.txt"
Receive-Job -Name Job45 -Keep

Server01
Server02
Server03
Server04

Start-Job usa o parâmetro ScriptBlock para ser executado Get-Content com a $input variável automática. A $input variável obtém objetos do parâmetro InputObject . Receive-Job usa o parâmetro Name para especificar o trabalho e gera os resultados. O parâmetro Keep salva a saída do trabalho para que ele possa ser exibido novamente durante a sessão do PowerShell.

Parâmetros

-ArgumentList

Especifica uma matriz de argumentos ou valores de parâmetro para o script especificado pelo parâmetro FilePath .

Como todos os valores que seguem o nome do parâmetro ArgumentList são interpretados como sendo valores de ArgumentList, especifique esse parâmetro como o último parâmetro no comando.

Type:	Object[]
Aliases:	Args
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Authentication

Especifica o mecanismo usado para autenticar as credenciais do usuário.

Os valores aceitáveis para esse parâmetro são os seguintes:

• Default
• Basic
• Credssp
• Digest
• Kerberos
• Negotiate
• NegotiateWithImplicitCredential

O valor padrão é Default.

A autenticação credSSP está disponível apenas no Windows Vista, windows server 2008 e versões posteriores do sistema operacional Windows.

Para obter mais informações sobre os valores desse parâmetro, consulte AuthenticationMechanism.

Cuidado

A autenticação CredSSP (Credencial Security Support Provider), na qual as credenciais do usuário são passadas a um computador remoto para autenticação, foi projetada para comandos que exijam autenticação em mais de um recurso, como acessar um compartilhamento de rede remota. Esse mecanismo aumenta o risco de segurança da operação remota. Se o computador remoto estiver comprometido, as credenciais que são passadas a ele podem ser usadas para controlar a sessão de rede.

Type:	AuthenticationMechanism
Accepted values:	Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
Position:	Named
Default value:	Default
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Especifica uma conta de usuário que tem permissão para executar esta ação. Se o parâmetro Credential não for especificado, o comando usará as credenciais do usuário atual.

Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential , como um do Get-Credential cmdlet .

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefinitionName

Especifica o nome da definição do trabalho que este cmdlet inicia. Use este parâmetro para iniciar tipos de trabalho personalizados que têm um nome de definição, como trabalhos agendados.

Quando você usa Start-Job para iniciar uma instância de um trabalho agendado, o trabalho é iniciado imediatamente, independentemente dos gatilhos de trabalho ou das opções de trabalho. A instância de trabalho resultante é um trabalho agendado, mas não é salva no disco, como trabalhos agendados disparados. Você não pode usar o parâmetro ArgumentList de Start-Job para fornecer valores para parâmetros de scripts executados em um trabalho agendado. Para obter mais informações, consulte about_Scheduled_Jobs.

Esse parâmetro foi introduzido no PowerShell 3.0.

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

-DefinitionPath

Especifica o caminho da definição para o trabalho iniciado por esse cmdlet. Insira o caminho de definição. A concatenação dos valores dos parâmetros DefinitionPath e DefinitionName é o caminho totalmente qualificado da definição do trabalho. Use este parâmetro para iniciar tipos de trabalho personalizados que têm um caminho de definição, como trabalhos agendados.

Para trabalhos agendados, o valor do parâmetro DefinitionPath é $home\AppData\Local\Windows\PowerShell\ScheduledJob.

Esse parâmetro foi introduzido no PowerShell 3.0.

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

Especifica um script local que Start-Job é executado como um trabalho em segundo plano. Insira o caminho e o nome do arquivo do script ou use o pipeline para enviar um caminho de script para Start-Job. O script deve estar no computador local ou em uma pasta que o computador local possa acessar.

Quando você usa esse parâmetro, o PowerShell converte o conteúdo do arquivo de script especificado em um bloco de script e executa o bloco de script como um trabalho em segundo plano.

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

-InitializationScript

Especifica os comandos que são executados antes do trabalho ser iniciado. Para criar um bloco de script, coloque os comandos em chaves ({}).

Use esse parâmetro para preparar a sessão na qual o trabalho é executado. Por exemplo, você pode usá-lo para adicionar funções, snap-ins e módulos à sessão.

Type:	ScriptBlock
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Especifica a entrada para o comando. Insira uma variável que contenha os objetos ou digite um comando ou uma expressão que gere os objetos.

No valor do parâmetro ScriptBlock , use a $input variável automática para representar os objetos de entrada.

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

-LiteralPath

Especifica um script local que esse cmdlet executa como um trabalho em segundo plano. Insira o caminho de um script no computador local.

Start-Job usa o valor do parâmetro LiteralPath exatamente como ele é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Type:	String
Aliases:	PSPath
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Especifica um nome amigável para o novo trabalho. Você pode usar o nome para identificar o trabalho para outros cmdlets de trabalho, como o Stop-Job cmdlet .

O nome amigável padrão é Job#, em # que é um número ordinal incrementado para cada trabalho.

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

-PSVersion

Especifica uma versão. Start-Job executa o trabalho com a versão do PowerShell. Os valores aceitáveis para esse parâmetro são: 2.0 e 3.0.

Esse parâmetro foi introduzido no PowerShell 3.0.

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

-RunAs32

Indica que Start-Job executa o trabalho em um processo de 32 bits. RunAs32 força o trabalho a ser executado em um processo de 32 bits, mesmo em um sistema operacional de 64 bits.

Em versões de 64 bits do Windows 7 e do Windows Server 2008 R2, quando o Start-Job comando inclui o parâmetro RunAs32 , você não pode usar o parâmetro Credential para especificar as credenciais de outro usuário.

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

-ScriptBlock

Especifica os comandos a executar no trabalho em segundo plano. Para criar um bloco de script, coloque os comandos em chaves ({}). Use a $input variável automática para acessar o valor do parâmetro InputObject . Este parâmetro é necessário.

Type:	ScriptBlock
Aliases:	Command
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Type

Especifica o tipo personalizado para trabalhos iniciados por Start-Job. Insira um nome de tipo de trabalho personalizado como PSScheduledJob para trabalhos agendados, ou PSWorkflowJob para tarefas de fluxo de trabalho. Esse parâmetro não é válido para trabalhos em segundo plano padrão.

Esse parâmetro foi introduzido no PowerShell 3.0.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

String

Você pode usar o pipeline para enviar um objeto com a propriedade Name para o parâmetro Name . Por exemplo, você pode fazer pipeline de um objeto FileInfo de Get-ChildItem para Start-Job.

Saídas

System.Management.Automation.PSRemotingJob

Start-Job retorna um objeto PSRemotingJob que representa o trabalho que ele iniciou.

Observações

Para ser executado em segundo plano, Start-Job é executado em sua própria sessão na sessão atual. Quando você usa o Invoke-Command cmdlet para executar um Start-Job comando em uma sessão em um computador remoto, Start-Job é executado em uma sessão na sessão remota.

Links Relacionados

• about_Jobs
• about_Job_Details
• about_Remote_Jobs
• Get-Job
• Invoke-Command
• Receive-Job
• Remove-Job
• Resume-Job
• Stop-Job
• Suspend-Job
• Wait-Job