Start-Job

Referência

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>]
     [-WorkingDirectory <String>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

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

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

Start-Job
     [-Name <String>]
     [-Credential <PSCredential>]
     -LiteralPath <String>
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-WorkingDirectory <String>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<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, um objeto de trabalho retorna imediatamente, mesmo que o trabalho demore muito tempo para ser concluído. Você pode 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 terminar, 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 é possível 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.

A partir do PowerShell 6.0, você pode iniciar trabalhos usando o operador em segundo plano e comercial (&). A funcionalidade do operador em segundo plano é semelhante ao Start-Job. Ambos os métodos para iniciar um trabalho criam um objeto PSRemotingJob . Para obter mais informações sobre como usar o E comercial (&), consulte about_Operators.

O PowerShell 7 introduziu o parâmetro WorkingDirectory que especifica o diretório de trabalho inicial de um trabalho em segundo plano. Se o parâmetro não for especificado, Start-Job o padrão será o diretório de trabalho atual do chamador que iniciou o trabalho.

Nota

A criação de um trabalho em segundo plano fora do processo com Start-Job não é suportada no cenário em que o PowerShell está sendo hospedado em outros aplicativos, como o PowerShell Azure Functions.

Isso ocorre por design porque Start-Job depende do pwsh executável a ser disponibilizado para $PSHOME iniciar um trabalho em segundo plano fora do processo, mas quando um aplicativo está hospedando o PowerShell, ele está usando diretamente os pacotes do SDK NuGet do PowerShell e não será pwsh enviado.

O substituto nesse cenário é Start-ThreadJob do módulo ThreadJob.

Exemplos

Exemplo 1: Iniciar um trabalho em segundo plano

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

Start-Job -ScriptBlock { Get-Process -Name pwsh }

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

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

Para exibir a saída do trabalho, use o Receive-Job cmdlet. Por exemplo, Receive-Job -Id 1.

Exemplo 2: Usar o operador em segundo plano para iniciar um trabalho em segundo plano

Este exemplo usa o operador em segundo plano e comercial (&) para iniciar um trabalho em segundo plano no computador local. O trabalho obtém o mesmo resultado Start-Job do Exemplo 1.

Get-Process -Name pwsh &

Id    Name   PSJobTypeName   State       HasMoreData     Location      Command
--    ----   -------------   -----       -----------     --------      -------
5     Job5   BackgroundJob   Running     True            localhost     Microsoft.PowerShell.Man...

Get-Process usa o parâmetro Name para especificar processos do PowerShell, pwsh. O E comercial (&) executa o comando 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.

Para exibir a saída do trabalho, use o Receive-Job cmdlet. Por exemplo, Receive-Job -Id 5.

Exemplo 3: 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 onde o trabalho é executado. Get-Content Obtém os nomes dos servidores 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 4: Obter informações sobre o emprego

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 5: 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 6: Obter um processo usando um trabalho em segundo plano

Este exemplo usa um trabalho em segundo plano para obter um processo especificado pelo 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 7: 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 -Name MapFunctions} -ScriptBlock {
   Get-Map -Name * | Set-Content -Path D:\Maps.tif }

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 .

Exemplo 8: 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 visualizar a saída do trabalho.

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

Server01
Server02
Server03
Server04

Start-Job usa o parâmetro ScriptBlock para executar 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 produz 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.

Exemplo 9: Definir o diretório de trabalho para um trabalho em segundo plano

O WorkingDirectory permite que você especifique um diretório alternativo para um trabalho a partir do qual você pode executar scripts ou abrir arquivos. Neste exemplo, o trabalho em segundo plano especifica um diretório de trabalho diferente do local do diretório atual.

PS C:\Test> Start-Job -WorkingDirectory C:\Test\Scripts { $PWD } | Receive-Job -AutoRemoveJob -Wait

Path
----
C:\Test\Scripts

O diretório de trabalho atual deste exemplo é C:\Test. Start-Job usa o parâmetro WorkingDirectory para especificar o diretório de trabalho do trabalho. O parâmetro ScriptBlock é usado $PWD para exibir o diretório de trabalho do trabalho. Receive-Job Exibe a saída do trabalho em segundo plano. AutoRemoveJob exclui o trabalho e Wait suprime o prompt de comando até que todos os resultados sejam recebidos.

Exemplo 10: Use o parâmetro ArgumentList para especificar uma matriz

Este exemplo usa o parâmetro ArgumentList para especificar uma matriz de argumentos. A matriz é uma lista separada por vírgulas de nomes de processos.

Start-Job -ScriptBlock { Get-Process -Name $args } -ArgumentList powershell, pwsh, notepad

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

O Start-Job cmdlet usa o parâmetro ScriptBlock para executar um comando. Get-Process usa o parâmetro Name para especificar a variável $argsautomática . O parâmetro ArgumentList passa a matriz de nomes de processo para $args. Os nomes de processo powershell, pwsh e notepad são processos em execução no computador local.

Para exibir a saída do trabalho, use o Receive-Job cmdlet. Por exemplo, Receive-Job -Id 1.

Exemplo 11: Executar trabalho em um Windows PowerShell 5.1

Este exemplo usa o parâmetro PSVersion com valor 5.1 para executar o trabalho em uma sessão do Windows PowerShell 5.1.

$PSVersionTable.PSVersion

Major  Minor  Patch  PreReleaseLabel BuildLabel
-----  -----  -----  --------------- ----------
7      0      0      rc.1

$job = Start-Job -ScriptBlock { $PSVersionTable.PSVersion } -PSVersion 5.1
Receive-Job -Job $job

Major  Minor  Build  Revision
-----  -----  -----  --------
5      1      14393  3383

Parâmetros

-ArgumentList

Especifica uma matriz de argumentos, ou valores de parâmetro, para o script especificado pelo parâmetro FilePath ou um comando especificado com o parâmetro ScriptBlock .

Os argumentos devem ser passados para ArgumentList como argumento de matriz de dimensão única. Por exemplo, uma lista separada por vírgula. Para obter mais informações sobre o comportamento de ArgumentList, consulte about_Splatting.

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 credenciais de usuário.

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

Predefinido
Básica
Credssp
Resumo
Kerberos
Negociar
NegociarComImplicitCredential

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.

Atenção

A autenticação CredSSP (Credential Security Support Provider), na qual as credenciais do usuário são passadas para um computador remoto para ser autenticado, foi projetada para comandos que exigem autenticação em mais de um recurso, como acessar um compartilhamento de rede remoto. Este mecanismo aumenta o risco de segurança da operação remota. Se o computador remoto estiver comprometido, as credenciais que são passadas para 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 essa 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 gerado pelo Get-Credential cmdlet. Se escrever um nome de utilizador, ser-lhe-á pedido que introduza a palavra-passe.

As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.

Nota

Para obter mais informações sobre a proteção de dados do SecureString , consulte Quão seguro é o SecureString?.

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 esse parâmetro para iniciar tipos de trabalho personalizados que tenham 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 ou opções de trabalho. A instância de trabalho resultante é um trabalho agendado, mas não é salva em disco como os trabalhos agendados acionados. Não é possível usar o parâmetro ArgumentList de Start-Job para fornecer valores para parâmetros de scripts executados em um trabalho agendado.

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 que este cmdlet inicia. Insira o caminho da definição. A concatenação dos valores dos parâmetros DefinitionPath e DefinitionName é o caminho totalmente qualificado da definição de trabalho. Use esse parâmetro para iniciar tipos de trabalho personalizados que tenham 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 comandos que são executados antes do início do trabalho. Para criar um bloco de script, coloque os comandos entre chaves ({}).

Use este 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 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 caracteres 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, LP
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#, onde # é um número ordinal que é 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 do PowerShell a ser usada para executar o trabalho. Quando o valor de PSVersion é 5.1, o trabalho é executado em uma sessão do Windows PowerShell 5.1. Para qualquer outro valor, o trabalho é executado usando a versão atual do PowerShell.

Esse parâmetro foi adicionado no PowerShell 7 e só funciona no Windows.

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

-RunAs32

A partir do PowerShell 7, o parâmetro RunAs32 não funciona no PowerShell de 64 bits (pwsh). Se RunAs32 for especificado no PowerShell de 64 bits, Start-Job lançará um erro de exceção de encerramento. Para iniciar um processo do PowerShell (pwsh) de 32 bits com o RunAs32, você precisa ter o PowerShell de 32 bits instalado.

No PowerShell de 32 bits, o RunAs32 força o trabalho a ser executado em um processo de 32 bits, mesmo em um sistema operacional de 64 bits.

Nas versões de 64 bits do Windows 7 e do Windows Server 2008 R2, quando o Start-Job comando inclui o parâmetro RunAs32 , não é possível 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 serem executados no trabalho em segundo plano. Para criar um bloco de script, coloque os comandos entre chaves ({}). Use a $input variável automática para acessar o valor do parâmetro InputObject . Este parâmetro é obrigató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 trabalhos de fluxos de trabalho. Este 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

-WorkingDirectory

Especifica o diretório de trabalho inicial do trabalho em segundo plano. Se o parâmetro não for especificado, o trabalho será executado a partir do local padrão. O local padrão é o diretório de trabalho atual do chamador que iniciou o trabalho.

Esse parâmetro foi introduzido no PowerShell 7.

Type:	String
Position:	Named
Default value:	$HOME on Unix (macOS, Linux) and $HOME\Documents on Windows
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

String

Você pode canalizar um objeto com a propriedade Name para o parâmetro Name para este cmdlet. Por exemplo, você pode canalizar um objeto FileInfo de Get-ChildItem.

Saídas

System.Management.Automation.PSRemotingJob

Este cmdlet retorna um objeto PSRemotingJob que representa o trabalho iniciado.

Notas

O PowerShell inclui os seguintes aliases para Start-Job:

Todas as plataformas:
- sajb

Para executar 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.

Start-Job

Syntax

Description

Exemplos

Exemplo 1: Iniciar um trabalho em segundo plano

Exemplo 2: Usar o operador em segundo plano para iniciar um trabalho em segundo plano

Exemplo 3: Iniciar um trabalho usando Invoke-Command

Exemplo 4: Obter informações sobre o emprego

Exemplo 5: Executar um script como um trabalho em segundo plano

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

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

Exemplo 8: Passar a entrada para um trabalho em segundo plano

Exemplo 9: Definir o diretório de trabalho para um trabalho em segundo plano

Exemplo 10: Use o parâmetro ArgumentList para especificar uma matriz

Exemplo 11: Executar trabalho em um Windows PowerShell 5.1

Parâmetros

-ArgumentList

-Authentication

-Credential

-DefinitionName

-DefinitionPath

-FilePath

-InitializationScript

-InputObject

-LiteralPath

-Name

-PSVersion

-RunAs32

-ScriptBlock

-Type

-WorkingDirectory

Entradas

Saídas

Notas

Comentários

Recursos adicionais

Start-Job

Syntax

Description

Exemplos

Exemplo 1: Iniciar um trabalho em segundo plano

Exemplo 2: Usar o operador em segundo plano para iniciar um trabalho em segundo plano

Exemplo 3: Iniciar um trabalho usando Invoke-Command

Exemplo 4: Obter informações sobre o emprego

Exemplo 5: Executar um script como um trabalho em segundo plano

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

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

Exemplo 8: Passar a entrada para um trabalho em segundo plano

Exemplo 9: Definir o diretório de trabalho para um trabalho em segundo plano

Exemplo 10: Use o parâmetro ArgumentList para especificar uma matriz

Exemplo 11: Executar trabalho em um Windows PowerShell 5.1

Parâmetros

-ArgumentList

-Authentication

-Credential

-DefinitionName

-DefinitionPath

-FilePath

-InitializationScript

-InputObject

-LiteralPath

-Name

-PSVersion

-RunAs32

-ScriptBlock

-Type

-WorkingDirectory

Entradas

Saídas

Notas

Ligações Relacionadas

Comentários

Recursos adicionais