Invoke-AzSynapsePipeline

Invoca um pipeline para iniciar uma execução para ele.

Sintaxe

NewByName (Default)

Invoke-AzSynapsePipeline
    -WorkspaceName <String>
    -PipelineName <String>
    [-Parameter <Hashtable>]
    [-ParameterFile <String>]
    [-ReferencePipelineRunId <String>]
    [-IsRecovery]
    [-StartActivityName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByInputObject

Invoke-AzSynapsePipeline
    -InputObject <PSPipelineResource>
    [-Parameter <Hashtable>]
    [-ParameterFile <String>]
    [-ReferencePipelineRunId <String>]
    [-IsRecovery]
    [-StartActivityName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByObject

Invoke-AzSynapsePipeline
    -WorkspaceObject <PSSynapseWorkspace>
    -PipelineName <String>
    [-Parameter <Hashtable>]
    [-ParameterFile <String>]
    [-ReferencePipelineRunId <String>]
    [-IsRecovery]
    [-StartActivityName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O comando Invoke-AzSynapsePipeline inicia uma execução no pipeline especificado e retorna uma ID para essa execução. Esse GUID pode ser passado para Get-AzSynapsePipelineRun ou Get-AzSynapseActivityRun para obter mais detalhes sobre essa execução.

Exemplos

Exemplo 1

Invoke-AzSynapsePipeline -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline

Esse comando inicia uma execução para pipeline chamada ContosoPipeline no workspace ContosoWorkspace.

Exemplo 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Invoke-AzSynapsePipeline -PipelineName ContosoPipeline

Esse comando inicia uma execução para pipeline chamada ContosoPipeline no workspace ContosoWorkspace por meio de pipeline.

Exemplo 3

$pipeline = Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline
$pipeline | Invoke-AzSynapsePipeline

Esse comando inicia uma execução para pipeline chamada ContosoPipeline no workspace ContosoWorkspace por meio de pipeline.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

As informações sobre a execução do pipeline.

Propriedades do parâmetro

Tipo:PSPipelineResource
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

NewByInputObject
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IsRecovery

Sinalizador do modo de recuperação. Se o modo de recuperação for definido como true, a execução de pipeline referenciada especificada e a nova execução serão agrupadas sob a mesma groupId.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Parameter

Parâmetros para execução de pipeline.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ParameterFile

O nome do arquivo com parâmetros para execução de pipeline.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PipelineName

O nome do pipeline.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

NewByName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
NewByObject
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ReferencePipelineRunId

A ID de execução do pipeline para execução nova. Se a ID da execução for especificada, os parâmetros da execução especificada serão usados para criar uma nova execução.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-StartActivityName

No modo de recuperação, a nova execução será iniciada a partir dessa atividade. Se não for especificado, todas as atividades serão executadas.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceName

Nome do workspace do Synapse.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

NewByName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceObject

objeto de entrada do workspace, geralmente passado pelo pipeline.

Propriedades do parâmetro

Tipo:PSSynapseWorkspace
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

NewByObject
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSPipelineResource

PSSynapseWorkspace

Saídas

PSCreateRunResponse