az datafactory dataset

Note

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

使用 datafactory 管理數據集。

命令

名稱	Description	類型	狀態
az datafactory dataset create	建立數據集。	Extension	GA
az datafactory dataset delete	刪除數據集。	Extension	GA
az datafactory dataset list	列出數據集。	Extension	GA
az datafactory dataset show	取得數據集。	Extension	GA
az datafactory dataset update	更新數據集。	Extension	GA

az datafactory dataset create

建立數據集。

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

範例

Datasets_Create

az datafactory dataset create --properties "{\"type\":\"AzureBlob\",\"linkedServiceName\":{\"type\":\"LinkedServiceReference\",\"referenceName\":\"exampleLinkedService\"},\"parameters\":{\"MyFileName\":{\"type\":\"String\"},\"MyFolderPath\":{\"type\":\"String\"}},\"typeProperties\":{\"format\":{\"type\":\"TextFormat\"},\"fileName\":{\"type\":\"Expression\",\"value\":\"@dataset().MyFileName\"},\"folderPath\":{\"type\":\"Expression\",\"value\":\"@dataset().MyFolderPath\"}}}" --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

必要參數

--dataset-name --name -n

數據集名稱。

--factory-name

Factory 名稱。

--properties

數據集屬性。 預期值：json-string/json-file/@json-file。

--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 dataset delete

刪除數據集。

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

範例

Datasets_Delete

az datafactory dataset delete --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

選擇性參數

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

--dataset-name --name -n

數據集名稱。

屬性	值
參數群組:	Resource Id Arguments

--factory-name

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

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--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 dataset list

列出數據集。

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

範例

Datasets_ListByFactory

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

必要參數

--factory-name

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 dataset show

取得數據集。

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

範例

Datasets_Get

az datafactory dataset show --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

選擇性參數

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

--dataset-name --name -n

數據集名稱。

屬性	值
參數群組:	Resource Id Arguments

--factory-name

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 dataset update

更新數據集。

az datafactory dataset update --linked-service-name
                              [--add]
                              [--annotations]
                              [--dataset-name --name]
                              [--description]
                              [--factory-name]
                              [--folder]
                              [--force-string]
                              [--ids]
                              [--if-match]
                              [--if-none-match]
                              [--parameters]
                              [--remove]
                              [--resource-group]
                              [--schema]
                              [--set]
                              [--structure]
                              [--subscription]

必要參數

--linked-service-name

鏈接的服務參考。 預期值：json-string/json-file/@json-file。

選擇性參數

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

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--annotations

可用於描述數據集的標記清單。 預期值：json-string/json-file/@json-file。

--dataset-name --name -n

數據集名稱。

屬性	值
參數群組:	Resource Id Arguments

--description

數據集描述。

--factory-name

Factory 名稱。

屬性	值
參數群組:	Resource Id Arguments

--folder

此數據集位於的資料夾。 如果未指定，數據集將會出現在根層級。

使用方式：--folder name=XX

name：此資料集位於的資料夾名稱。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--if-match

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

--if-none-match

數據集實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。 預設值為 None。

--parameters

數據集的參數。 預期值：json-string/json-file/@json-file。

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--schema

定義數據集實體類型架構的數據行。 Type： array （或 Expression with resultType array）， itemType： DatasetSchemaDataElement。 預期值：json-string/json-file/@json-file。

--set

指定要設定的屬性路徑和值，以更新物件。 範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--structure

定義數據集結構的數據行。 Type： array （或 Expression with resultType array）， itemType： DatasetDataElement。 預期值：json-string/json-file/@json-file。

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