az datafactory integration-runtime
注意
此參考是 Azure CLI 的 datafactory 延伸模組的一部分 (2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az datafactory integration-runtime 命令時自動安裝。 深入了解擴充功能。
使用 datafactory 管理整合執行時間。
命令
az datafactory integration-runtime delete
刪除整合執行時間。
az datafactory integration-runtime delete [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
[--yes]
範例
IntegrationRuntimes_Delete
az datafactory integration-runtime delete --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime get-connection-info
取得內部部署整合執行時間連接資訊,以加密內部部署資料來源認證。
az datafactory integration-runtime get-connection-info [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Get連線ionInfo
az datafactory integration-runtime get-connection-info --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime get-monitoring-data
取得整合執行時間監視資料,其中包括此整合執行時間下所有節點的監視資料。
az datafactory integration-runtime get-monitoring-data [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_GetMonitoringData
az datafactory integration-runtime get-monitoring-data --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime get-status
取得整合執行時間的詳細狀態資訊。
az datafactory integration-runtime get-status [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_GetStatus
az datafactory integration-runtime get-status --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime list
列出整合執行時間。
az datafactory integration-runtime list --factory-name
--resource-group
範例
IntegrationRuntimes_ListByFactory
az datafactory integration-runtime list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
必要參數
Factory 名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory integration-runtime list-auth-key
擷取整合執行時間的驗證金鑰。
az datafactory integration-runtime list-auth-key --factory-name
--integration-runtime-name
--resource-group
範例
IntegrationRuntimes_ListAuthKeys
az datafactory integration-runtime list-auth-key --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"
必要參數
Factory 名稱。
整合執行時間名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory integration-runtime regenerate-auth-key
重新產生整合執行時間的驗證金鑰。
az datafactory integration-runtime regenerate-auth-key [--factory-name]
[--ids]
[--integration-runtime-name]
[--key-name {authKey1, authKey2}]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_RegenerateAuthKey
az datafactory integration-runtime regenerate-auth-key --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --key-name "authKey2" --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 integration-runtime remove-link
在自我裝載整合執行時間中,移除特定資料處理站底下的所有連結整合執行時間。
az datafactory integration-runtime remove-link --linked-factory-name
[--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Upgrade
az datafactory integration-runtime remove-link --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --linked-factory-name "exampleFactoryName-linked" --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 integration-runtime show
取得整合執行時間。
az datafactory integration-runtime show [--factory-name]
[--ids]
[--if-none-match]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Get
az datafactory integration-runtime show --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"
選擇性參數
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
整合執行時間實體的 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 integration-runtime start
啟動 ManagedReserved 類型整合執行時間。
az datafactory integration-runtime start [--factory-name]
[--ids]
[--integration-runtime-name]
[--no-wait]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Start
az datafactory integration-runtime start --factory-name "exampleFactoryName" --name "exampleManagedIntegrationRuntime" --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 integration-runtime stop
停止 ManagedReserved 類型整合執行時間。
az datafactory integration-runtime stop [--factory-name]
[--ids]
[--integration-runtime-name]
[--no-wait]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Stop
az datafactory integration-runtime stop --factory-name "exampleFactoryName" --name "exampleManagedIntegrationRuntime" --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 integration-runtime sync-credentials
強制整合執行時間跨整合執行時間節點同步處理認證,這會將認證覆寫到所有背景工作節點與發送器節點上可用的認證。 如果您已經有最新的認證備份檔案,您應該在任何自我裝載整合執行時間節點上手動匯入它(慣用),而不是直接使用此 API。
az datafactory integration-runtime sync-credentials [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_SyncCredentials
az datafactory integration-runtime sync-credentials --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime update
更新整合執行時間。
az datafactory integration-runtime update [--auto-update {Off, On}]
[--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
[--update-delay-offset]
範例
IntegrationRuntimes_Update
az datafactory integration-runtime update --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup" --auto-update "Off" --update-delay-offset "\"PT3H\""
選擇性參數
啟用或停用自我裝載整合執行時間的自動更新功能。 請參閱 https://go.microsoft.com/fwlink/?linkid=854189。
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
整合執行時間名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
當天的時間位移(以小時為單位),例如 PT03H 為 3 小時。 整合執行時間自動更新將會在該時間發生。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az datafactory integration-runtime upgrade
如果可用性,請將自我裝載整合執行時間升級至最新版本。
az datafactory integration-runtime upgrade [--factory-name]
[--ids]
[--integration-runtime-name]
[--resource-group]
[--subscription]
範例
IntegrationRuntimes_Upgrade
az datafactory integration-runtime upgrade --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --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 integration-runtime wait
將 CLI 置於等候狀態,直到符合 datafactory integration-runtime 的條件為止。
az datafactory integration-runtime wait [--created]
[--custom]
[--deleted]
[--exists]
[--factory-name]
[--ids]
[--if-none-match]
[--integration-runtime-name]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
範例
暫停執行下一行 CLI 腳本,直到成功建立 datafactory integration-runtime 為止。
az datafactory integration-runtime wait --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup" --created
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到刪除為止。
等候資源存在。
Factory 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
整合執行時間實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記,或提供 *,則不會傳回任何內容。
整合執行時間名稱。
輪詢間隔以秒為單位。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。