az datafactory pipeline

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi datafactory untuk Azure CLI (versi 2.15.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah alur az datafactory. Pelajari lebih lanjut tentang ekstensi.

Mengelola alur dengan datafactory.

Perintah

Nama Deskripsi Jenis Status
az datafactory pipeline create

Buat alur.

 Ekstensi GA
az datafactory pipeline create-run

Membuat eksekusi alur.

 Ekstensi GA
az datafactory pipeline delete

Menghapus alur.

 Ekstensi GA
az datafactory pipeline list

Mencantumkan alur.

 Ekstensi GA
az datafactory pipeline show

Mendapatkan alur.

 Ekstensi GA
az datafactory pipeline update

Memperbarui alur.

 Ekstensi GA

az datafactory pipeline create

Buat alur.

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

Contoh

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"

Parameter yang Diperlukan

--factory-name

Nama pabrik.

--name --pipeline-name -n

Nama alur.

--pipeline

Definisi sumber daya alur. Nilai yang diharapkan: json-string/json-file/@json-file.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Opsional

--if-match

ETag entitas alur. Hanya boleh ditentukan untuk pembaruan, yang seharusnya cocok dengan entitas yang ada atau dapat * untuk pembaruan tanpa syarat.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az datafactory pipeline create-run

Membuat eksekusi alur.

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

Contoh

Pipelines_CreateRun

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

Parameter yang Diperlukan

--factory-name

Nama pabrik.

--name --pipeline-name -n

Nama alur.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Opsional

--is-recovery

Bendera mode pemulihan. Jika mode pemulihan diatur ke true, eksekusi alur yang direferensikan yang ditentukan dan eksekusi baru akan dikelompokkan di bawah groupId yang sama.

nilai yang diterima: false, true
--parameters

Parameter eksekusi alur. Parameter ini akan digunakan hanya jika runId tidak ditentukan. Nilai yang diharapkan: json-string/json-file/@json-file.

--reference-pipeline-run-id

Pengidentifikasi eksekusi alur. Jika ID eksekusi ditentukan, parameter eksekusi yang ditentukan akan digunakan untuk membuat eksekusi baru.

--start-activity-name

Dalam mode pemulihan, eksekusi ulang akan dimulai dari aktivitas ini. Jika tidak ditentukan, semua aktivitas akan berjalan.

--start-from-failure

Dalam mode pemulihan, jika diatur ke true, eksekusi ulang akan dimulai dari aktivitas yang gagal. Properti akan digunakan hanya jika startActivityName tidak ditentukan.

nilai yang diterima: false, true
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az datafactory pipeline delete

Menghapus alur.

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

Contoh

Pipelines_Delete

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

Parameter Opsional

--factory-name

Nama pabrik.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --pipeline-name -n

Nama alur.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--yes -y

Jangan meminta konfirmasi.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az datafactory pipeline list

Mencantumkan alur.

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

Contoh

Pipelines_ListByFactory

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

Parameter yang Diperlukan

--factory-name

Nama pabrik.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az datafactory pipeline show

Mendapatkan alur.

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

Contoh

Pipelines_Get

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

Parameter Opsional

--factory-name

Nama pabrik.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--if-none-match

ETag entitas alur. Hanya boleh ditentukan untuk mendapatkan. Jika ETag cocok dengan tag entitas yang ada, atau jika * disediakan, maka tidak ada konten yang akan dikembalikan.

--name --pipeline-name -n

Nama alur.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az datafactory pipeline update

Memperbarui alur.

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]

Contoh

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"

Parameter Opsional

--activities

Daftar aktivitas dalam alur. Nilai yang diharapkan: json-string/json-file/@json-file.

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>.

nilai default: []
--annotations

Daftar tag yang dapat digunakan untuk menjelaskan Alur. Nilai yang diharapkan: json-string/json-file/@json-file.

--concurrency

Jumlah maksimum eksekusi bersamaan untuk alur.

--description

Deskripsi dari alur.

--duration

Nilai TimeSpan, setelah itu Metrik Pemantauan Azure diaktifkan. Nilai yang diharapkan: json-string/json-file/@json-file.

--factory-name

Nama pabrik.

--folder-name

Nama folder tempat Alur ini berada.

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

nilai default: False
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--if-match

ETag entitas alur. Hanya boleh ditentukan untuk pembaruan, yang seharusnya cocok dengan entitas yang ada atau dapat * untuk pembaruan tanpa syarat.

--if-none-match

ETag entitas alur. Hanya boleh ditentukan untuk mendapatkan. Jika ETag cocok dengan tag entitas yang ada, atau jika * disediakan, maka tidak ada konten yang akan dikembalikan. Nilai defaultnya adalah Tidak Ada.

--name --pipeline-name -n

Nama alur.

--parameters

Daftar parameter untuk alur. Nilai yang diharapkan: json-string/json-file/@json-file.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

nilai default: []
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--run-dimensions

Dimensi yang dipancarkan oleh Alur. Nilai yang diharapkan: json-string/json-file/@json-file.

--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>.

nilai default: []
--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--variables

Daftar variabel untuk alur. Nilai yang diharapkan: json-string/json-file/@json-file.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.