你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az datafactory integration-runtime
注意
此参考是 Azure CLI(版本 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
必需参数
工厂名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
必需参数
工厂名称。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
要重新生成的身份验证密钥的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
必需参数
链接集成运行时的数据工厂名称。
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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。
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
当天的时间偏移量(以小时为单位),例如 PT03H 为 3 小时。 集成运行时自动更新将在该时间发生。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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"
可选参数
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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']。
等到删除为止。
等待资源存在。
工厂名称。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
集成运行时实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
集成运行时名称。
轮询间隔(以秒为单位)。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。