Dela via

az datafactory pipeline

  • Referens

Kommentar

Den här referensen är en del av datafaktortillägget för Azure CLI (version 2.15.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az datafactory pipeline . Läs mer om tillägg.

Hantera pipeline med datafaktor.

Kommandon

Name Description Typ Status
az datafactory pipeline create

Skapa en pipeline.

 Anknytning Allmän tillgänglighet
az datafactory pipeline create-run

Skapar en körning av en pipeline.

 Anknytning Allmän tillgänglighet
az datafactory pipeline delete

Tar bort en pipeline.

 Anknytning Allmän tillgänglighet
az datafactory pipeline list

Visar en lista över pipelines.

 Anknytning Allmän tillgänglighet
az datafactory pipeline show

Hämtar en pipeline.

 Anknytning Allmän tillgänglighet
az datafactory pipeline update

Uppdatera en pipeline.

 Anknytning Allmän tillgänglighet

az datafactory pipeline create

Skapa en pipeline.

az datafactory pipeline create --factory-name
                               --name
                               --pipeline
                               --resource-group
                               [--if-match]

Exempel

Pipelines_Create

az datafactory pipeline create --factory-name "exampleFactoryName" --pipeline "{\"activities\":[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}],\"parameters\":{\"JobId\":{\"type\":\"String\"},\"OutputBlobNameList\":{\"type\":\"Array\"}},\"variables\":{\"TestVariableArray\":{\"type\":\"Array\"}},\"runDimensions\":{\"JobId\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.JobId\"}},\"duration\":\"0.00:10:00\"}" --name "examplePipeline" --resource-group "exampleResourceGroup"

Obligatoriska parametrar

--factory-name

Fabriksnamnet.

--name --pipeline-name -n

Pipelinenamnet.

--pipeline

Definition av pipelineresurser. Förväntat värde: json-string/json-file/@json-file.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--if-match

ETag för pipelineentiteten. Bör endast anges för uppdatering, för vilken den ska matcha en befintlig entitet eller kan vara * för ovillkorlig uppdatering.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az datafactory pipeline create-run

Skapar en körning av en pipeline.

az datafactory pipeline create-run --factory-name
                                   --name
                                   --resource-group
                                   [--is-recovery {false, true}]
                                   [--parameters]
                                   [--reference-pipeline-run-id]
                                   [--start-activity-name]
                                   [--start-from-failure {false, true}]

Exempel

Pipelines_CreateRun

az datafactory pipeline create-run --factory-name "exampleFactoryName" --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}" --name "examplePipeline" --resource-group "exampleResourceGroup"

Obligatoriska parametrar

--factory-name

Fabriksnamnet.

--name --pipeline-name -n

Pipelinenamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--is-recovery

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.

Godkända värden: false, true
--parameters

Parametrar för pipelinekörningen. Dessa parametrar används endast om runId inte har angetts. Förväntat värde: json-string/json-file/@json-file.

--reference-pipeline-run-id

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

--start-activity-name

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

--start-from-failure

I återställningsläge, om det är inställt på sant, startar omkörningen från misslyckade aktiviteter. Egenskapen används endast om startActivityName inte har angetts.

Godkända värden: false, true
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az datafactory pipeline delete

Tar bort en pipeline.

az datafactory pipeline delete [--factory-name]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Exempel

Pipelines_Delete

az datafactory pipeline delete --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

Valfria parametrar

--factory-name

Fabriksnamnet.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --pipeline-name -n

Pipelinenamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--yes -y

Fråga inte efter bekräftelse.

Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az datafactory pipeline list

Visar en lista över pipelines.

az datafactory pipeline list --factory-name
                             --resource-group

Exempel

Pipelines_ListByFactory

az datafactory pipeline list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

Obligatoriska parametrar

--factory-name

Fabriksnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az datafactory pipeline show

Hämtar en pipeline.

az datafactory pipeline show [--factory-name]
                             [--ids]
                             [--if-none-match]
                             [--name]
                             [--resource-group]
                             [--subscription]

Exempel

Pipelines_Get

az datafactory pipeline show --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

Valfria parametrar

--factory-name

Fabriksnamnet.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--if-none-match

ETag för pipelineentiteten. Bör endast anges för get. Om ETag matchar den befintliga entitetstaggen, eller om * angavs, returneras inget innehåll.

--name --pipeline-name -n

Pipelinenamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az datafactory pipeline update

Uppdatera en pipeline.

az datafactory pipeline update [--activities]
                               [--add]
                               [--annotations]
                               [--concurrency]
                               [--description]
                               [--duration]
                               [--factory-name]
                               [--folder-name]
                               [--force-string]
                               [--ids]
                               [--if-match]
                               [--if-none-match]
                               [--name]
                               [--parameters]
                               [--remove]
                               [--resource-group]
                               [--run-dimensions]
                               [--set]
                               [--subscription]
                               [--variables]

Exempel

Pipelines_Update

az datafactory pipeline update --factory-name "exampleFactoryName" --description "Example description" --activities "[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}]" --parameters "{\"OutputBlobNameList\":{\"type\":\"Array\"}}" --duration "0.00:10:00" --name "examplePipeline" --resource-group "exampleResourceGroup"

Valfria parametrar

--activities

Lista över aktiviteter i pipeline. Förväntat värde: json-string/json-file/@json-file.

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Standardvärde: []
--annotations

Lista över taggar som kan användas för att beskriva pipelinen. Förväntat värde: json-string/json-file/@json-file.

--concurrency

Maximalt antal samtidiga körningar för pipelinen.

--description

Beskrivningen av pipelinen.

--duration

TimeSpan-värde, varefter ett Azure Monitoring Metric utlöses. Förväntat värde: json-string/json-file/@json-file.

--factory-name

Fabriksnamnet.

--folder-name

Namnet på mappen som pipelinen finns i.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--if-match

ETag för pipelineentiteten. Bör endast anges för uppdatering, för vilken den ska matcha en befintlig entitet eller kan vara * för ovillkorlig uppdatering.

--if-none-match

ETag för pipelineentiteten. Bör endast anges för get. Om ETag matchar den befintliga entitetstaggen, eller om * angavs, returneras inget innehåll. Standardvärdet är Ingen.

--name --pipeline-name -n

Pipelinenamnet.

--parameters

Lista över parametrar för pipeline. Förväntat värde: json-string/json-file/@json-file.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Standardvärde: []
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--run-dimensions

Dimensioner som genereras av Pipeline. Förväntat värde: json-string/json-file/@json-file.

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Standardvärde: []
--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--variables

Lista över variabler för pipeline. Förväntat värde: json-string/json-file/@json-file.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.