Sdílet prostřednictvím

az datafactory pipeline

  • Reference

Poznámka:

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řit kanál.

 Rozšíření GA
az datafactory pipeline create-run

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

 Rozšíření GA
az datafactory pipeline delete

Odstraní kanál.

 Rozšíření GA
az datafactory pipeline list

Zobrazí seznam kanálů.

 Rozšíření GA
az datafactory pipeline show

Získá kanál.

 Rozšíření GA
az datafactory pipeline update

Aktualizace kanálu

 Rozšíření GA

az datafactory pipeline create

Vytvořit kanál.

az datafactory pipeline create --factory-name
                               --name
                               --pipeline
                               --resource-group
                               [--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

--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í.

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datafactory pipeline create-run

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

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}]

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

--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.

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ý.

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

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

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datafactory pipeline delete

Odstraní kanál.

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

Příklady

Pipelines_Delete

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

Volitelné parametry

--factory-name

Název továrny.

--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--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>.

--subscription

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

--yes -y

Nezotvádejte výzvu k potvrzení.

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

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

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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í.

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datafactory pipeline show

Získá kanál.

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

Příklady

Pipelines_Get

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

Volitelné parametry

--factory-name

Název továrny.

--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--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.

--resource-group -g

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

--subscription

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

Globální parametry
--debug

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

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datafactory pipeline update

Aktualizace kanálu

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]

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

--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>.

Default value: []
--annotations

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

--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.

--factory-name

Název továrny.

--folder-name

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

--force-string

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

Default value: False
--ids

Jedno nebo více ID prostředků (oddělených 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 argumenty --ids nebo jiné argumenty ID prostředku.

--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.

--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.

Default value: []
--resource-group -g

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

--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>.

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.

--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í.

--help -h

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

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.