Dela via


Invoke-AzSynapsePipeline

Anropar en pipeline för att starta en körning för den.

Syntax

NewByName (Standard)

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

Kommandot Invoke-AzSynapsePipeline startar en körning på den angivna pipelinen och returnerar ett ID för den körningen. Detta GUID kan skickas till Get-AzSynapsePipelineRun eller Get-AzSynapseActivityRun för att få ytterligare information om den här körningen.

Exempel

Exempel 1

Invoke-AzSynapsePipeline -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline

Det här kommandot startar en körning för pipelinen ContosoPipeline på arbetsytan ContosoWorkspace.

Exempel 2

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

Det här kommandot startar en körning för pipelinen ContosoPipeline på arbetsytan ContosoWorkspace via pipeline.

Exempel 3

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

Det här kommandot startar en körning för pipelinen ContosoPipeline på arbetsytan ContosoWorkspace via pipeline.

Parametrar

-AsJob

Kör cmdlet i bakgrunden

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Informationen om pipelinekörningen.

Parameteregenskaper

Typ:PSPipelineResource
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

NewByInputObject
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-IsRecovery

Flagga för återställningsläge. Om återställningsläget är inställt på true grupperas den angivna refererade pipelinekörningen och den nya körningen under samma groupId.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Parameter

Parametrar för pipelinekörning.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ParameterFile

Namnet på filen med parametrar för pipelinekörning.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-PipelineName

Pipelinenamnet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

NewByName
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
NewByObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ReferencePipelineRunId

Pipelinekörnings-ID:t för omkörning. Om körnings-ID anges används parametrarna för den angivna körningen för att skapa en ny körning.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-StartActivityName

I återställningsläge startar omkörningen från den här aktiviteten. Om det inte anges körs alla aktiviteter.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WorkspaceName

Namnet på Synapse-arbetsytan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

NewByName
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WorkspaceObject

indataobjekt för arbetsytan, som vanligtvis skickas via pipelinen.

Parameteregenskaper

Typ:PSSynapseWorkspace
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

NewByObject
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSPipelineResource

PSSynapseWorkspace

Utdata

PSCreateRunResponse