你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Integration Runtimes - Update
汇报集成运行时。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}?api-version=2018-06-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
factory
|
path | True |
string |
工厂名称。 正则表达式模式: |
integration
|
path | True |
string |
集成运行时名称。 正则表达式模式: |
resource
|
path | True |
string |
资源组名称。 正则表达式模式: |
subscription
|
path | True |
string |
订阅标识符。 |
api-version
|
query | True |
string |
API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
autoUpdate |
启用或禁用自承载集成运行时的自动更新功能。 请参阅 https://go.microsoft.com/fwlink/?linkid=854189。 |
|
updateDelayOffset |
string |
时间偏移量 (小时) 一天中,例如 PT03H 为 3 小时。 集成运行时自动更新将在该时间发生。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 |
|
Other Status Codes |
从Azure 数据工厂服务收到的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
IntegrationRuntimes_Update
示例请求
PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime?api-version=2018-06-01
{
"autoUpdate": "Off",
"updateDelayOffset": "\"PT3H\""
}
示例响应
Date: Wed, 13 Jun 2018 21:33:04 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
x-ms-correlation-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime",
"name": "exampleIntegrationRuntime",
"type": "Microsoft.DataFactory/factories/integrationruntimes",
"properties": {
"type": "SelfHosted",
"description": "A selfhosted integration runtime"
},
"etag": "0400f1a1-0000-0000-0000-5b2188640000"
}
定义
CloudError
定义Azure 数据工厂错误响应结构的对象。
名称 | 类型 | 说明 |
---|---|---|
error.code |
string |
错误代码。 |
error.details |
包含其他错误详细信息的数组。 |
|
error.message |
string |
错误消息。 |
error.target |
string |
与错误关联的请求中的属性名称/路径。 |
CopyComputeScaleProperties
托管集成运行时的 CopyComputeScale 属性。
名称 | 类型 | 说明 |
---|---|---|
dataIntegrationUnit |
integer |
为复制活动执行保留的 DIU 编号设置。 支持的值是 4-256 范围内的 4 的倍数。 |
timeToLive |
integer |
生存时间 (分钟,) 将执行复制活动的集成运行时设置。 |
CredentialReference
凭据引用类型。
名称 | 类型 | 说明 |
---|---|---|
referenceName |
string |
引用凭据名称。 |
type |
凭据引用类型。 |
CredentialReferenceType
凭据引用类型。
名称 | 类型 | 说明 |
---|---|---|
CredentialReference |
string |
CustomProperties
自定义属性用于优化数据流运行时性能。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
自定义属性的名称。 |
value |
string |
自定义属性的值。 |
DataFlowComputeType
将执行数据流作业的群集的计算类型。
名称 | 类型 | 说明 |
---|---|---|
ComputeOptimized |
string |
|
General |
string |
|
MemoryOptimized |
string |
EntityReference
实体引用。
名称 | 类型 | 说明 |
---|---|---|
referenceName |
string |
此引用实体的名称。 |
type |
此引用实体的类型。 |
IntegrationRuntimeAutoUpdate
集成运行时自动更新的状态。
名称 | 类型 | 说明 |
---|---|---|
Off |
string |
|
On |
string |
IntegrationRuntimeComputeProperties
托管集成运行时的计算资源属性。
名称 | 类型 | 说明 |
---|---|---|
copyComputeScaleProperties |
托管集成运行时的 CopyComputeScale 属性。 |
|
dataFlowProperties |
托管集成运行时的数据流属性。 |
|
location |
string |
托管集成运行时的位置。 可以在 上找到受支持的区域 https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities |
maxParallelExecutionsPerNode |
integer |
托管集成运行时的每个节点的最大并行执行计数。 |
nodeSize |
string |
托管集成运行时的节点大小要求。 |
numberOfNodes |
integer |
托管集成运行时所需的节点数。 |
pipelineExternalComputeScaleProperties |
托管集成运行时的 PipelineExternalComputeScale 属性。 |
|
vNetProperties |
托管集成运行时的 VNet 属性。 |
IntegrationRuntimeCustomerVirtualNetwork
Azure-SSIS 集成运行时将加入的虚拟网络的定义和属性。
名称 | 类型 | 说明 |
---|---|---|
subnetId |
string |
Azure-SSIS 集成运行时将加入的子网的 ID。 |
IntegrationRuntimeCustomSetupScriptProperties
托管专用集成运行时的自定义安装脚本属性。
名称 | 类型 | 说明 |
---|---|---|
blobContainerUri |
string |
包含自定义安装脚本的 Azure Blob 容器的 URI。 |
sasToken |
Azure Blob 容器的 SAS 令牌。 |
IntegrationRuntimeDataFlowProperties
托管集成运行时的数据流属性。
名称 | 类型 | 说明 |
---|---|---|
cleanup |
boolean |
群集不会回收,并且会在下一个数据流活动运行中使用,直到 TTL (生存时间达到) (如果设置为 false)。 默认为 true。 |
computeType |
将执行数据流作业的群集的计算类型。 |
|
coreCount |
integer |
将执行数据流作业的群集的核心计数。 支持的值为:8、16、32、48、80、144 和 272。 |
customProperties |
自定义属性用于优化数据流运行时性能。 |
|
timeToLive |
integer |
生存时间 (以分钟为单位,) 将执行数据流作业的群集设置。 |
IntegrationRuntimeDataProxyProperties
托管专用集成运行时的数据代理属性。
名称 | 类型 | 说明 |
---|---|---|
connectVia |
自承载集成运行时引用。 |
|
path |
string |
用于包含 Blob 存储中暂存数据的路径。 |
stagingLinkedService |
暂存链接服务引用。 |
IntegrationRuntimeEdition
SSIS Integration Runtime的版本
名称 | 类型 | 说明 |
---|---|---|
Enterprise |
string |
|
Standard |
string |
IntegrationRuntimeEntityReferenceType
此引用实体的类型。
名称 | 类型 | 说明 |
---|---|---|
IntegrationRuntimeReference |
string |
|
LinkedServiceReference |
string |
IntegrationRuntimeLicenseType
用于自带许可证方案的许可证类型。
名称 | 类型 | 说明 |
---|---|---|
BasePrice |
string |
|
LicenseIncluded |
string |
IntegrationRuntimeResource
集成运行时资源类型。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
Etag 标识资源中的更改。 |
id |
string |
资源标识符。 |
name |
string |
资源名称。 |
properties | IntegrationRuntime: |
集成运行时属性。 |
type |
string |
资源类型。 |
IntegrationRuntimeSsisCatalogInfo
托管专用集成运行时的目录信息。
名称 | 类型 | 说明 |
---|---|---|
catalogAdminPassword |
目录数据库的管理员用户帐户的密码。 |
|
catalogAdminUserName |
string |
目录数据库的管理员用户名。 |
catalogPricingTier |
目录数据库的定价层。 可以在 中找到有效值 https://azure.microsoft.com/en-us/pricing/details/sql-database/ |
|
catalogServerEndpoint |
string |
目录数据库服务器 URL。 |
dualStandbyPairName |
string |
Azure-SSIS Integration Runtimes 的双备用对名称,用于支持 SSISDB 故障转移。 |
IntegrationRuntimeSsisCatalogPricingTier
目录数据库的定价层。 可以在 中找到有效值 https://azure.microsoft.com/en-us/pricing/details/sql-database/
名称 | 类型 | 说明 |
---|---|---|
Basic |
string |
|
Premium |
string |
|
PremiumRS |
string |
|
Standard |
string |
IntegrationRuntimeSsisProperties
托管集成运行时的 SSIS 属性。
名称 | 类型 | 说明 |
---|---|---|
catalogInfo |
托管专用集成运行时的目录信息。 |
|
credential |
包含身份验证信息的凭据引用。 |
|
customSetupScriptProperties |
托管专用集成运行时的自定义安装脚本属性。 |
|
dataProxyProperties |
托管专用集成运行时的数据代理属性。 |
|
edition |
SSIS Integration Runtime的版本 |
|
expressCustomSetupProperties |
Custom |
不带脚本属性的 SSIS 集成运行时的自定义安装。 |
licenseType |
用于自带许可证方案的许可证类型。 |
|
packageStores |
SSIS Integration Runtime的包存储。 |
IntegrationRuntimeState
集成运行时的状态。
名称 | 类型 | 说明 |
---|---|---|
AccessDenied |
string |
|
Initial |
string |
|
Limited |
string |
|
NeedRegistration |
string |
|
Offline |
string |
|
Online |
string |
|
Started |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
IntegrationRuntimeType
集成运行时的类型。
名称 | 类型 | 说明 |
---|---|---|
Managed |
string |
|
SelfHosted |
string |
IntegrationRuntimeVNetProperties
托管集成运行时的 VNet 属性。
名称 | 类型 | 说明 |
---|---|---|
publicIPs |
string[] |
此集成运行时将使用的公共 IP 地址的资源 ID。 |
subnet |
string |
此集成运行时将加入的子网的名称。 |
subnetId |
string |
此 Azure-SSIS 集成运行时将联接到的子网的 ID。 |
vNetId |
string |
此集成运行时将加入的 VNet 的 ID。 |
LinkedIntegrationRuntimeKeyAuthorization
密钥授权类型集成运行时。
名称 | 类型 | 说明 |
---|---|---|
authorizationType |
string:
Key |
集成运行时共享的授权类型。 |
key |
用于授权的密钥。 |
LinkedIntegrationRuntimeRbacAuthorization
基于角色的访问控制 (RBAC) 授权类型集成运行时。
名称 | 类型 | 说明 |
---|---|---|
authorizationType |
string:
RBAC |
集成运行时共享的授权类型。 |
credential |
包含身份验证信息的凭据引用。 |
|
resourceId |
string |
要共享的集成运行时的资源标识符。 |
ManagedIntegrationRuntime
托管集成运行时,包括托管弹性和托管专用集成运行时。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
集成运行时说明。 |
managedVirtualNetwork |
托管虚拟网络引用。 |
|
state |
集成运行时状态,仅适用于托管的专用集成运行时。 |
|
type |
string:
Managed |
集成运行时的类型。 |
typeProperties.computeProperties |
托管集成运行时的计算资源。 |
|
typeProperties.customerVirtualNetwork |
Azure-SSIS 集成运行时将加入的虚拟网络的名称 |
|
typeProperties.ssisProperties |
托管集成运行时的 SSIS 属性。 |
ManagedVirtualNetworkReference
托管虚拟网络引用类型。
名称 | 类型 | 说明 |
---|---|---|
referenceName |
string |
引用 ManagedVirtualNetwork 名称。 |
type |
托管虚拟网络引用类型。 |
ManagedVirtualNetworkReferenceType
托管虚拟网络引用类型。
名称 | 类型 | 说明 |
---|---|---|
ManagedVirtualNetworkReference |
string |
PackageStore
SSIS 集成运行时的包存储。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
包存储区的名称 |
packageStoreLinkedService |
包存储链接服务引用。 |
PipelineExternalComputeScaleProperties
托管集成运行时的 PipelineExternalComputeScale 属性。
名称 | 类型 | 说明 |
---|---|---|
numberOfExternalNodes |
integer |
外部节点的数目,应大于 0 且小于 11。 |
numberOfPipelineNodes |
integer |
管道节点数,应大于 0 且小于 11。 |
timeToLive |
integer |
生存时间 (以分钟为单位,) 将执行管道和外部活动的集成运行时设置。 |
SecureString
Azure 数据工厂安全字符串定义。 在 Get 或 List API 调用期间,字符串值将屏蔽星号“*”。
名称 | 类型 | 说明 |
---|---|---|
type | string: |
机密的类型。 |
value |
string |
安全字符串的值。 |
SelfHostedIntegrationRuntime
自承载集成运行时。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
集成运行时说明。 |
type |
string:
Self |
集成运行时的类型。 |
typeProperties.linkedInfo | LinkedIntegrationRuntimeType: |
链接集成运行时的基本定义。 |
typeProperties.selfContainedInteractiveAuthoringEnabled |
boolean |
当自承载集成运行时无法与 Azure 中继建立连接时,确保交互式创作功能的另一个选项。 |
UpdateIntegrationRuntimeRequest
更新集成运行时请求。
名称 | 类型 | 说明 |
---|---|---|
autoUpdate |
启用或禁用自承载集成运行时的自动更新功能。 请参阅 https://go.microsoft.com/fwlink/?linkid=854189。 |
|
updateDelayOffset |
string |
时间偏移量 (小时) 一天中,例如 PT03H 为 3 小时。 集成运行时自动更新将在该时间发生。 |