az datafactory linked-service

注意

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

使用 datafactory 管理連結服務。

命令

名稱	Description	類型	狀態
az datafactory linked-service create	建立連結的服務。	副檔名	GA
az datafactory linked-service delete	刪除連結的服務。	副檔名	GA
az datafactory linked-service list	列出連結的服務。	副檔名	GA
az datafactory linked-service show	取得連結服務。	副檔名	GA
az datafactory linked-service update	更新連結的服務。	副檔名	GA

az datafactory linked-service create

建立連結的服務。

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

範例

LinkedServices_Create

az datafactory linked-service create --factory-name "exampleFactoryName" --properties "{\"type\":\"AzureStorage\",\"typeProperties\":{\"connectionString\":{\"type\":\"SecureString\",\"value\":\"DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>\"}}}" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

必要參數

--factory-name

Factory 名稱。

--linked-service-name --name -n

連結的服務名稱。

--properties

連結服務的屬性。 預期值：json-string/json-file/@json-file。

--resource-group -g

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

選擇性參數

--if-match

linkedService 實體的 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 linked-service delete

刪除連結的服務。

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

範例

LinkedServices_Delete

az datafactory linked-service delete --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

選擇性參數

--factory-name

Factory 名稱。

--ids

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

--linked-service-name --name -n

連結的服務名稱。

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

預設值: False

全域參數

--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 linked-service list

列出連結的服務。

az datafactory linked-service list --factory-name
                                   --resource-group

範例

LinkedServices_ListByFactory

az datafactory linked-service list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

必要參數

--factory-name

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 linked-service show

取得連結服務。

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

範例

LinkedServices_Get

az datafactory linked-service show --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

選擇性參數

--factory-name

Factory 名稱。

--ids

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

--if-none-match

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

--linked-service-name --name -n

連結的服務名稱。

--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 linked-service update

更新連結的服務。

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

選擇性參數

--add

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

預設值: []

--annotations

可用於描述連結服務的標籤清單。 預期值：json-string/json-file/@json-file。

--connect-via

整合運行時間參考。 預期值：json-string/json-file/@json-file。

--description

鏈接的服務描述。

--factory-name

Factory 名稱。

--force-string

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

預設值: False

--ids

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

--if-match

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

--if-none-match

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

--linked-service-name --name -n

連結的服務名稱。

--parameters

連結服務的參數。 預期值：json-string/json-file/@json-file。

--remove

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

預設值: []

--resource-group -g

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

--set

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

預設值: []

--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 來取得完整偵錯記錄。