az datafactory
注意
此參考是 Azure CLI 的 datafactory 延伸模組的一部分 (2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az datafactory 命令時自動安裝。 深入了解擴充功能。
管理 Data Factory。
命令
az datafactory configure-factory-repo
更新處理站的存放庫資訊。
az datafactory configure-factory-repo [--factory-git-hub-configuration]
[--factory-resource-id]
[--factory-vsts-configuration]
[--ids]
[--location]
[--subscription]
範例
Factories_ConfigureFactoryRepo
az datafactory configure-factory-repo --factory-resource-id "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName" --factory-vsts-configuration account-name="ADF" collaboration-branch="master" last-commit-id="" project-name="project" repository-name="repo" root-folder="/" tenant-id="" --location "East US"
選擇性參數
Factory 的 GitHub 存放庫資訊。
使用方式:--factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
主機名稱:GitHub Enterprise 主機名稱。 例如: https://github.mydomain.com 類型:必要。 存放庫組態的類型。 account-name:必要。 帳戶名稱。 repository-name:必要專案。 存放庫名稱。 collaboration-branch:必要專案。 共同作業分支。 root-folder:必要。 根資料夾。 last-commit-id:上次認可識別碼。
Factory 資源識別碼。
Factory 的 VSTS 存放庫資訊。
使用方式:--factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
project-name:必要專案。 VSTS 專案名稱。 tenant-id:VSTS 租使用者識別碼。類型:必要。 存放庫組態的類型。 account-name:必要。 帳戶名稱。 repository-name:必要專案。 存放庫名稱。 collaboration-branch:必要專案。 共同作業分支。 root-folder:必要。 根資料夾。 last-commit-id:上次認可識別碼。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
位置。 來自的值: az account list-locations
。 您可以使用 az configure --defaults location=<location>
設定預設位置。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory create
建立處理站。
az datafactory create --factory-name
--resource-group
[--factory-git-hub-configuration]
[--factory-vsts-configuration]
[--global-parameters]
[--if-match]
[--location]
[--public-network-access]
[--tags]
範例
Factories_CreateOrUpdate
az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"
必要參數
Factory 名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
Factory 的 GitHub 存放庫資訊。
使用方式:--factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
主機名稱:GitHub Enterprise 主機名稱。 例如: https://github.mydomain.com 類型:必要。 存放庫組態的類型。 account-name:必要。 帳戶名稱。 repository-name:必要專案。 存放庫名稱。 collaboration-branch:必要專案。 共同作業分支。 root-folder:必要。 根資料夾。 last-commit-id:上次認可識別碼。
Factory 的 VSTS 存放庫資訊。
使用方式:--factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
project-name:必要專案。 VSTS 專案名稱。 tenant-id:VSTS 租使用者識別碼。類型:必要。 存放庫組態的類型。 account-name:必要。 帳戶名稱。 repository-name:必要專案。 存放庫名稱。 collaboration-branch:必要專案。 共同作業分支。 root-folder:必要。 根資料夾。 last-commit-id:上次認可識別碼。
Factory 的參數清單。 預期值:json-string/json-file/@json-file。
Factory 實體的 ETag。 應該只針對更新指定,而更新應該符合現有的實體,也可以為 * 進行無條件更新。
位置。 來自的值: az account list-locations
。 您可以使用 az configure --defaults location=<location>
設定預設位置。
是否允許資料處理站存取公用網路。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory delete
刪除處理站。
az datafactory delete [--factory-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
範例
Factories_Delete
az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"
選擇性參數
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory get-data-plane-access
取得資料平面存取權。
az datafactory get-data-plane-access [--access-resource-path]
[--expire-time]
[--factory-name]
[--ids]
[--permissions]
[--profile-name]
[--resource-group]
[--start-time]
[--subscription]
範例
Factories_GetDataPlaneAccess
az datafactory get-data-plane-access --name "exampleFactoryName" --access-resource-path "" --expire-time "2018-11-10T09:46:20.2659347Z" --permissions "r" --profile-name "DefaultProfile" --start-time "2018-11-10T02:46:20.2659347Z" --resource-group "exampleResourceGroup"
選擇性參數
相對於處理站取得存取權的資源路徑。 目前僅支援對應至處理站資源的空字串。
權杖的到期時間。 權杖的最大持續時間為八小時,根據預設,權杖將在八小時內到期。
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
具有資料平面存取許可權的字串。 目前僅支援 'r' ,以授與唯讀存取權。
設定檔的名稱。 目前僅支援預設值。 預設值為 DefaultProfile。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
權杖的開始時間。 如果未指定,則會使用目前的時間。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory get-git-hub-access-token
取得 GitHub 存取權杖。
az datafactory get-git-hub-access-token --git-hub-access-code
--git-hub-access-token-base-url
[--factory-name]
[--git-hub-client-id]
[--ids]
[--resource-group]
[--subscription]
範例
Factories_GetGitHubAccessToken
az datafactory get-git-hub-access-token --name "exampleFactoryName" --git-hub-access-code "some" --git-hub-access-token-base-url "some" --git-hub-client-id "some" --resource-group "exampleResourceGroup"
必要參數
GitHub 存取代碼。
GitHub 存取權杖基底 URL。
選擇性參數
Factory 名稱。
GitHub 應用程式用戶端識別碼。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory list
列出工廠。 並列出指定訂用帳戶底下的處理站。
az datafactory list [--resource-group]
範例
Factories_ListByResourceGroup
az datafactory list --resource-group "exampleResourceGroup"
Factories_List
az datafactory list
選擇性參數
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory show
取得處理站。
az datafactory show [--factory-name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]
範例
Factories_Get
az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"
選擇性參數
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
Factory 實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記,或提供 *,則不會傳回任何內容。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory update
更新處理站。
az datafactory update [--factory-name]
[--ids]
[--public-network-access]
[--resource-group]
[--subscription]
[--tags]
範例
Factories_Update
az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"
選擇性參數
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
是否允許資料處理站存取公用網路。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。