az datafactory data-flow

注意

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

在 Azure Data Factory 中管理和設定資料流程。

命令

名稱 Description 類型 狀態
az datafactory data-flow create

在處理站內建立資料流程。

擴充 GA
az datafactory data-flow delete

刪除指定處理站中的特定資料流程。

擴充 GA
az datafactory data-flow list

列出所提供處理站內的資料流程。

擴充 GA
az datafactory data-flow show

顯示指定資料流程的相關資訊。

擴充 GA
az datafactory data-flow update

更新處理站內的指定資料流程。

擴充 GA

az datafactory data-flow create

在處理站內建立資料流程。

az datafactory data-flow create --data-flow-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

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az datafactory data-flow delete

刪除指定處理站中的特定資料流程。

az datafactory data-flow delete [--data-flow-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

資料流程名稱。

--factory-name -f

Factory 名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az datafactory data-flow show

顯示指定資料流程的相關資訊。

az datafactory data-flow show [--data-flow-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

資料流程名稱。

--factory-name -f

Factory 名稱。

--ids

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

--if-none-match

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

--resource-group -g

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

--subscription

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az datafactory data-flow update

更新處理站內的指定資料流程。

az datafactory data-flow update --properties
                                [--data-flow-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

資料流程名稱。

--factory-name -f

Factory 名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。