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
Název továrny.
Název kanálu.
Definice prostředku kanálu Očekávaná hodnota: json-string/json-file/@json-file.
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.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
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
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
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
Název továrny.
Název kanálu.
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.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
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 |
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.
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í.
V režimu obnovení se opětovné spuštění spustí z této aktivity. Pokud není zadáno, spustí se všechny aktivity.
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
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
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.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Název továrny.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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 |
Název kanálu.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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 |
Nevyzývejte k potvrzení.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
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
Název továrny.
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
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.
Název továrny.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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 |
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.
Název kanálu.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
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.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Seznam aktivit v kanálu Očekávaná hodnota: json-string/json-file/@json-file.
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: | [] |
Seznam značek, které lze použít k popisu kanálu Očekávaná hodnota: json-string/json-file/@json-file.
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Maximální počet souběžných spuštění kanálu.
Popis kanálu.
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 |
Název továrny.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název složky, ve které je tento kanál.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Folder Arguments |
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 |
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 |
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.
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.
Název kanálu.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Seznam parametrů pro kanál Očekávaná hodnota: json-string/json-file/@json-file.
Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Default value: | [] |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Dimenze generované kanálem. Očekávaná hodnota: json-string/json-file/@json-file.
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: | [] |
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 |
Seznam proměnných pro kanál Očekávaná hodnota: json-string/json-file/@json-file.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |