az datafactory
Note
此參考是 Azure CLI 的 datafactory 延伸模組的一部分(2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az datafactory 命令時自動安裝。 深入了解擴充功能。
管理 Data Factory。
命令
az datafactory configure-factory-repo
更新處理站的存放庫資訊。
az datafactory configure-factory-repo [--factory-git-hub-configuration --github-config]
[--factory-resource-id]
[--factory-vsts-configuration --vsts-config]
[--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:上次認可標識符。
| 屬性 | 值 |
|---|---|
| 參數群組: | RepoConfiguration Arguments |
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:上次認可標識符。
| 屬性 | 值 |
|---|---|
| 參數群組: | RepoConfiguration Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
Location. 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location>來設定預設位置。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az datafactory create
建立處理站。
az datafactory create --factory-name --name
--resource-group
[--factory-git-hub-configuration --github-config]
[--factory-vsts-configuration --vsts-config]
[--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:上次認可標識符。
| 屬性 | 值 |
|---|---|
| 參數群組: | RepoConfiguration Arguments |
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:上次認可標識符。
| 屬性 | 值 |
|---|---|
| 參數群組: | RepoConfiguration Arguments |
Factory 的參數清單。 預期值:json-string/json-file/@json-file。
Factory 實體的 ETag。 應該只針對更新指定,而更新應該符合現有的實體,也可以為 * 進行無條件更新。
Location. 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location>來設定預設位置。
是否允許數據處理站存取公用網路。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az datafactory delete
刪除處理站。
az datafactory delete [--factory-name --name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
範例
Factories_Delete
az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
Factory 名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
請勿提示確認。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az datafactory get-data-plane-access
取得數據平面存取權。
az datafactory get-data-plane-access [--access-resource-path]
[--expire-time]
[--factory-name --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 名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
具有數據平面存取許可權的字串。 目前僅支援 『r』 ,以授與唯讀存取權。
配置檔的名稱。 目前僅支援預設值。 預設值為 DefaultProfile。
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
令牌的開始時間。 如果未指定,則會使用目前的時間。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 --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 名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
GitHub 應用程式用戶端識別碼。
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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>來設定預設群組。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az datafactory show
取得處理站。
az datafactory show [--factory-name --name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]
範例
Factories_Get
az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
Factory 名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
Factory 實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記,或提供 *,則不會傳回任何內容。
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az datafactory update
更新處理站。
az datafactory update [--factory-name --name]
[--ids]
[--public-network-access]
[--resource-group]
[--subscription]
[--tags]
範例
Factories_Update
az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
Factory 名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
是否允許數據處理站存取公用網路。
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |