az datafactory pipeline

Note

Tento odkaz je součástí rozšíření datafactory pro Azure CLI (verze 2.15.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az datafactory pipeline. Přečtěte si další informace o rozšířeních.

Správa kanálu pomocí datovéhofactory

Příkazy

Name Description Typ Stav
az datafactory pipeline create

Vytvořte kanál.

Extension GA
az datafactory pipeline create-run

Vytvoří spuštění kanálu.

Extension GA
az datafactory pipeline delete

Odstraní kanál.

Extension GA
az datafactory pipeline list

Zobrazí seznam kanálů.

Extension GA
az datafactory pipeline show

Získá kanál.

Extension GA
az datafactory pipeline update

Aktualizace kanálu

Extension GA

az datafactory pipeline create

Vytvořte kanál.

az datafactory pipeline create --factory-name
                               --name --pipeline-name
                               --pipeline
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--if-match]

Příklady

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"

Povinné parametry

--factory-name

Název továrny.

--name --pipeline-name -n

Název kanálu.

--pipeline

Definice prostředku kanálu Očekávaná hodnota: json-string/json-file/@json-file.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--if-match

ETag entity kanálu Měla by být zadána pouze pro aktualizaci, pro kterou by měla odpovídat stávající entitě, nebo může být * pro nepodmíněnou aktualizaci.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az datafactory pipeline create-run

Vytvoří spuštění kanálu.

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

Příklady

Pipelines_CreateRun

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

Povinné parametry

--factory-name

Název továrny.

--name --pipeline-name -n

Název kanálu.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--is-recovery

Příznak režimu obnovení Pokud je režim obnovení nastavený na hodnotu true, zadané odkazované spuštění kanálu a nové spuštění se seskupí pod stejným id skupiny.

Vlastnost Hodnota
Přípustné hodnoty: false, true
--parameters

Parametry spuštění kanálu Tyto parametry se použijí pouze v případě, že parametr runId není zadaný. Očekávaná hodnota: json-string/json-file/@json-file.

--reference-pipeline-run-id

Identifikátor spuštění kanálu. Pokud je ID spuštění zadaného spuštění zadáno, použijí se k vytvoření nového spuštění.

--start-activity-name

V režimu obnovení se opětovné spuštění spustí z této aktivity. Pokud není zadáno, spustí se všechny aktivity.

--start-from-failure

Pokud je v režimu obnovení nastavená hodnota true, opětovné spuštění se spustí z neúspěšných aktivit. Vlastnost se použije pouze v případě, že parametr startActivityName není zadaný.

Vlastnost Hodnota
Přípustné hodnoty: false, true
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az datafactory pipeline delete

Odstraní kanál.

az datafactory pipeline delete [--acquire-policy-token]
                               [--change-reference]
                               [--factory-name]
                               [--ids]
                               [--name --pipeline-name]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Příklady

Pipelines_Delete

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--factory-name

Název továrny.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--name --pipeline-name -n

Název kanálu.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--yes -y

Nevyzývejte k potvrzení.

Vlastnost Hodnota
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az datafactory pipeline list

Zobrazí seznam kanálů.

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

Příklady

Pipelines_ListByFactory

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

Povinné parametry

--factory-name

Název továrny.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az datafactory pipeline show

Získá kanál.

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

Příklady

Pipelines_Get

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--factory-name

Název továrny.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--if-none-match

ETag entity kanálu Měla by být zadána pouze pro získání. Pokud značka ETag odpovídá existující značce entity nebo pokud byla zadaná *, nebude vrácen žádný obsah.

--name --pipeline-name -n

Název kanálu.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az datafactory pipeline update

Aktualizace kanálu

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

Příklady

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"

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--activities

Seznam aktivit v kanálu Očekávaná hodnota: json-string/json-file/@json-file.

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--annotations

Seznam značek, které lze použít k popisu kanálu Očekávaná hodnota: json-string/json-file/@json-file.

--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--concurrency

Maximální počet souběžných spuštění kanálu.

--description

Popis kanálu.

--duration

Hodnota TimeSpan, po které se aktivuje metrika monitorování Azure. Očekávaná hodnota: json-string/json-file/@json-file.

Vlastnost Hodnota
Skupina parametrů: Policy Elapsed Time Metric Arguments
--factory-name

Název továrny.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--folder-name

Název složky, ve které je tento kanál.

Vlastnost Hodnota
Skupina parametrů: Folder Arguments
--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: False
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--if-match

ETag entity kanálu Měla by být zadána pouze pro aktualizaci, pro kterou by měla odpovídat stávající entitě, nebo může být * pro nepodmíněnou aktualizaci.

--if-none-match

ETag entity kanálu Měla by být zadána pouze pro získání. Pokud značka ETag odpovídá existující značce entity nebo pokud byla zadaná *, nebude vrácen žádný obsah. Výchozí hodnota je None.

--name --pipeline-name -n

Název kanálu.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--parameters

Seznam parametrů pro kanál Očekávaná hodnota: json-string/json-file/@json-file.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--run-dimensions

Dimenze generované kanálem. Očekávaná hodnota: json-string/json-file/@json-file.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--variables

Seznam proměnných pro kanál Očekávaná hodnota: json-string/json-file/@json-file.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False