az datafactory data-flow

Note

此參考是 Azure CLI 的 datafactory 延伸模組的一部分（2.15.0 版或更高版本）。 擴充功能會在您第一次執行 az datafactory data-flow 命令時自動安裝。 深入了解擴充功能。

在 Azure Data Factory 中管理和設定數據流。

命令

名稱	Description	類型	狀態
az datafactory data-flow create	在處理站內建立數據流。	Extension	GA
az datafactory data-flow delete	刪除指定處理站中的特定數據流。	Extension	GA
az datafactory data-flow list	列出所提供處理站內的數據流。	Extension	GA
az datafactory data-flow show	顯示指定數據流的相關信息。	Extension	GA
az datafactory data-flow update	更新處理站內的指定數據流。	Extension	GA

az datafactory data-flow create

在處理站內建立數據流。

az datafactory data-flow create --data-flow-name --name
                                --factory-name
                                --flow-type
                                --properties
                                --resource-group
                                [--if-match]

範例

Factories_DataFlowCreate

az datafactory data-flow create -g example-resource-group -f example-data-factory -n example-data-flow -t "Flowlet" --properties example-properties.json

必要參數

--data-flow-name --name -n

數據流名稱。

--factory-name -f

Factory 名稱。

--flow-type -t

數據流類型。 有效選項：MappingDataFlow、Flowlet。

--properties

數據流的指定屬性。 預期值：json-string/json-file/@json-file。

使用方式：（如果內嵌 JSON） --properties “{”name“： ”hello“， ”description“： ”Example description“， ”folder“： ”sub-folder“， ”annotations“： ” ， typeProperties：{...} }”

• name：數據流的名稱。 （避免連字元。）
• description：（選擇性） 數據流的描述。
• folder：（選擇性） 數據流將組織在 下的資料夾。
• 註釋：（選擇性）數據流的註釋。
• typeProperties：（選擇性） 如果未提供，則會建立泛型和空白定義。 從 Azure 入口網站中的 Data Factory Studio 內複製 JSON，以完成包括定義。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--if-match

數據流實體的 ETag。 應該只針對更新指定，而更新應該符合現有的實體，也可以為 * 進行無條件更新。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az datafactory data-flow delete

刪除指定處理站中的特定數據流。

az datafactory data-flow delete [--data-flow-name --name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

範例

Factories_DataFlowDelete

az datafactory data-flow delete -g example-resource-group -f example-data-factory -n example-data-flow

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--data-flow-name --name -n

數據流名稱。

屬性	值
參數群組:	Resource Id Arguments

--factory-name -f

Factory 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az datafactory data-flow list

列出所提供處理站內的數據流。

az datafactory data-flow list --factory-name
                              --resource-group

範例

Factories_DataFlowList

az datafactory data-flow list -g example-resource-group -f example-data-factory

必要參數

--factory-name -f

Factory 名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az datafactory data-flow show

顯示指定數據流的相關信息。

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

範例

Factories_DataFlowShow

az datafactory data-flow show -g example-resource-group -f example-data-factory -n example-data-flow

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--data-flow-name --name -n

數據流名稱。

屬性	值
參數群組:	Resource Id Arguments

--factory-name -f

Factory 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--if-none-match

管線實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az datafactory data-flow update

更新處理站內的指定數據流。

az datafactory data-flow update --properties
                                [--data-flow-name --name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

範例

Factories_DataFlowUpdate

az datafactory data-flow update -g example-resource-group -f example-data-factory -n example-data-flow --properties example-properties.json

必要參數

--properties

數據流的指定屬性。 預期值：json-string/json-file/@json-file。

使用方式：（如果內嵌 JSON） --properties “{ ”description“： ”Example description“， ”folder“： ”sub-folder“， ”annotations“： ” ， typeProperties：{...} }”

• description：（選擇性） 數據流的描述。
• folder：（選擇性） 數據流將組織在 下的資料夾。
• 註釋：（選擇性）數據流的註釋。
• typeProperties：（選擇性） 如果未提供，則會建立泛型和空白定義。 從 Azure 入口網站中的 Data Factory Studio 內複製 JSON，以完成包括定義。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--data-flow-name --name -n

數據流名稱。

屬性	值
參數群組:	Resource Id Arguments

--factory-name -f

Factory 名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False