az datafactory pipeline

Referenz

Hinweis

Diese Referenz ist Teil der Datafactory-Erweiterung für die Azure CLI (Version 2.15.0 oder höher). Die Erweiterung installiert automatisch beim ersten Ausführen eines Az Datafactory-Pipelinebefehls . Weitere Informationen zu Erweiterungen

Verwalten der Pipeline mit Datafactory.

Befehle

az datafactory pipeline create	Erstellen einer Pipeline.
az datafactory pipeline create-run	Erstellt eine Ausführung einer Pipeline.
az datafactory pipeline delete	Löscht eine Pipeline.
az datafactory pipeline list	Listet Pipelines auf.
az datafactory pipeline show	Ruft eine Pipeline ab.
az datafactory pipeline update	Aktualisieren einer Pipeline.

az datafactory pipeline create

Erstellen einer Pipeline.

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

Beispiele

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"

Erforderliche Parameter

--factory-name

Der Werksname.

--name --pipeline-name -n

Der Pipelinename.

--pipeline

Pipelineressourcendefinition. Erwarteter Wert: json-string/json-file/@json-file.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--if-match

ETag der Pipelineentität. Sollte nur für updates angegeben werden, für die es mit der vorhandenen Entität übereinstimmen soll oder * für bedingungslose Aktualisierung sein kann.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline create-run

Erstellt eine Ausführung einer 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}]

Beispiele

Pipelines_CreateRun

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

Erforderliche Parameter

--factory-name

Der Werksname.

--name --pipeline-name -n

Der Pipelinename.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--is-recovery

Wiederherstellungsmodus-Flag. Wenn der Wiederherstellungsmodus auf "true" festgelegt ist, wird die angegebene referenzierte Pipeline ausgeführt, und die neue Ausführung wird unter derselben groupId gruppiert.

Zulässige Werte: false, true

--parameters

Parameter der Pipelineausführung. Diese Parameter werden nur verwendet, wenn die RunId nicht angegeben wird. Erwarteter Wert: json-string/json-file/@json-file.

--reference-pipeline-run-id

Der Pipelineausführungsbezeichner. Wenn die Ausführungs-ID angegeben wird, werden die Parameter der angegebenen Ausführung verwendet, um eine neue Ausführung zu erstellen.

--start-activity-name

Im Wiederherstellungsmodus beginnt die Erneute Ausführung von dieser Aktivität. Wenn nicht angegeben, werden alle Aktivitäten ausgeführt.

--start-from-failure

Wenn der Wiederherstellungsmodus auf "true" festgelegt ist, beginnt die Erneutes Ausführen von fehlgeschlagenen Aktivitäten. Die Eigenschaft wird nur verwendet, wenn startActivityName nicht angegeben ist.

Zulässige Werte: false, true

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline delete

Löscht eine Pipeline.

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

Beispiele

Pipelines_Delete

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

Erforderliche Parameter

--factory-name

Der Werksname.

--name --pipeline-name -n

Der Pipelinename.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline list

Listet Pipelines auf.

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

Beispiele

Pipelines_ListByFactory

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

Erforderliche Parameter

--factory-name

Der Werksname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline show

Ruft eine Pipeline ab.

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

Beispiele

Pipelines_Get

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

Erforderliche Parameter

--factory-name

Der Werksname.

--name --pipeline-name -n

Der Pipelinename.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--if-none-match

ETag der Pipelineentität. Sollte nur für get angegeben werden. Wenn das ETag mit dem vorhandenen Entitätstag übereinstimmt oder wenn * angegeben wurde, wird kein Inhalt zurückgegeben.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline update

Aktualisieren einer Pipeline.

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

Beispiele

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"

Erforderliche Parameter

--factory-name

Der Werksname.

--name --pipeline-name -n

Der Pipelinename.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--activities

Liste der Aktivitäten in der Pipeline. Erwarteter Wert: json-string/json-file/@json-file.

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--annotations

Liste der Tags, die zum Beschreiben der Pipeline verwendet werden können. Erwarteter Wert: json-string/json-file/@json-file.

--concurrency

Die maximale Anzahl gleichzeitiger Ausführung für die Pipeline.

--description

Die Beschreibung der Pipeline.

--duration

TimeSpan-Wert, nach dem eine Azure Monitoring Metric ausgelöst wird. Erwarteter Wert: json-string/json-file/@json-file.

--folder-name

Der Name des Ordners, in dem sich diese Pipeline befindet.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

--if-match

ETag der Pipelineentität. Sollte nur für updates angegeben werden, für die es mit der vorhandenen Entität übereinstimmen soll oder * für bedingungslose Aktualisierung sein kann.

--if-none-match

ETag der Pipelineentität. Sollte nur für get angegeben werden. Wenn das ETag mit dem vorhandenen Entitätstag übereinstimmt oder wenn * angegeben wurde, wird kein Inhalt zurückgegeben.

--parameters

Liste der Parameter für die Pipeline. Erwarteter Wert: json-string/json-file/@json-file.

--remove

Entfernen einer Eigenschaft oder eines Elements aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--run-dimensions

Dimensionen, die von Pipeline ausgegeben werden. Erwarteter Wert: json-string/json-file/@json-file.

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftspfad und einen festzulegenden Wert angeben. Beispiel: --set property1.property2=.

--variables

Liste der Variablen für pipeline. Erwarteter Wert: json-string/json-file/@json-file.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az datafactory pipeline

Befehle

az datafactory pipeline create

Beispiele

Erforderliche Parameter

Optionale Parameter

az datafactory pipeline create-run

Beispiele

Erforderliche Parameter

Optionale Parameter

az datafactory pipeline delete

Beispiele

Erforderliche Parameter

Optionale Parameter

az datafactory pipeline list

Beispiele

Erforderliche Parameter

az datafactory pipeline show

Beispiele

Erforderliche Parameter

Optionale Parameter

az datafactory pipeline update

Beispiele

Erforderliche Parameter

Optionale Parameter

Feedback