你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az datafactory linked-service

参考

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的数据工厂扩展的一部分。该扩展将在首次运行 az datafactory linked-service 命令时自动安装。详细了解扩展。

使用 datafactory 管理链接服务。

命令

名称	说明	类型	Status
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

工厂名称。

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

订阅的名称或 ID。可以使用 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

工厂名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

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

链接服务名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

工厂名称。

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

订阅的名称或 ID。可以使用 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

工厂名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--if-none-match

链接服务实体的 ETag。应仅指定 get。如果 ETag 与现有实体标记匹配，或者如果提供 *，则不会返回任何内容。

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

链接服务名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

工厂名称。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--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> OR --remove propertyToRemove.

默认值: []

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

默认值: []

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az datafactory linked-service

命令

az datafactory linked-service create

示例

必需参数

可选参数

az datafactory linked-service delete

示例

可选参数

az datafactory linked-service list

示例

必需参数

az datafactory linked-service show

示例

可选参数

az datafactory linked-service update

可选参数

其他资源