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

Iot Hub Resource - Update

Service:

IoT Hub

API Version:

2018-04-01

更新现有的 IoT 中心标记。
更新现有IoT 中心标记。 若要更新其他字段，请使用 CreateOrUpdate 方法

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组标识符。
resourceName	path	True	string	要更新的 iot 中心的名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

请求正文

名称	类型	说明
tags	object	资源标记

响应

名称	类型	说明
200 OK	IotHubDescription	Iot 中心已成功更新

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

IotHubResource_Update

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/myHub?api-version=2018-04-01

{
  "tags": {
    "foo": "bar"
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {
    "foo": "bar"
  },
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

定义

名称	说明
AccessRights	分配给共享访问策略的权限。
Capabilities	为 IoT 中心启用的功能和特性。
CloudToDeviceProperties	IoT 中心云到设备的消息传送属性。
EventHubProperties	IoT 中心使用的与预配的事件中心兼容的终结点的属性。
FallbackRouteProperties	回退路由的属性。 IoT 中心在将消息路由到回退终结点时使用这些属性。
FeedbackProperties	云到设备消息的反馈队列的属性。
IotHubDescription	IoT 中心的说明。
IotHubProperties	IoT 中心的属性。
IotHubSku	SKU 的名称。
IotHubSkuInfo	有关 IoT 中心的 SKU 的信息。
IotHubSkuTier	IoT 中心的计费层。
IpFilterActionType	此规则捕获的请求的所需操作。
IpFilterRule	IoT 中心的 IP 筛选器规则。
MessagingEndpointProperties	此 IoT 中心使用的消息传送终结点的属性。
OperationsMonitoringProperties	IoT 中心的操作监视属性。 字典的可能键为 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations、Routes、D2CTwinOperations、C2DTwinOperations、TwinQueries、JobsOperations、DirectMethods。
RouteProperties	IoT 中心用于将消息路由到终结点的路由规则的属性。
RoutingEndpoints	与 IoT 中心基于路由规则将消息路由到的自定义终结点相关的属性。 付费中心的所有终结点类型中最多允许 10 个自定义终结点，免费中心的所有终结点类型中只允许 1 个自定义终结点。
RoutingEventHubProperties	与事件中心终结点相关的属性。
RoutingProperties	IoT 中心的路由相关属性。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	与服务总线队列终结点类型相关的属性。
RoutingServiceBusTopicEndpointProperties	与服务总线主题终结点类型相关的属性。
RoutingSource	要应用路由规则的源，例如 DeviceMessages。
RoutingStorageContainerProperties	与存储容器终结点相关的属性。
SharedAccessSignatureAuthorizationRule	IoT 中心共享访问策略的属性。
StorageEndpointProperties	用于文件上传的 Azure 存储终结点的属性。
TagsResource	仅保存资源的标记的容器，允许用户更新IoT 中心实例上的标记。

AccessRights

分配给共享访问策略的权限。

名称	类型	说明
DeviceConnect	string
RegistryRead	string
RegistryRead, DeviceConnect	string
RegistryRead, RegistryWrite	string
RegistryRead, RegistryWrite, DeviceConnect	string
RegistryRead, RegistryWrite, ServiceConnect	string
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect	string
RegistryRead, ServiceConnect	string
RegistryRead, ServiceConnect, DeviceConnect	string
RegistryWrite	string
RegistryWrite, DeviceConnect	string
RegistryWrite, ServiceConnect	string
RegistryWrite, ServiceConnect, DeviceConnect	string
ServiceConnect	string
ServiceConnect, DeviceConnect	string

Capabilities

为 IoT 中心启用的功能和特性。

名称	类型	说明
DeviceManagement	string
None	string

CloudToDeviceProperties

IoT 中心云到设备的消息传送属性。

名称	类型	说明
defaultTtlAsIso8601	string	设备队列中云到设备消息的默认生存时间。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。
feedback	FeedbackProperties	云到设备消息的反馈队列的属性。
maxDeliveryCount	integer	设备队列中云到设备消息的最大传递计数。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。

EventHubProperties

IoT 中心使用的与预配的事件中心兼容的终结点的属性。

名称	类型	说明
endpoint	string	与事件中心兼容的终结点。
partitionCount	integer	用于在与事件中心兼容的终结点中接收设备到云消息的分区数。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages。
partitionIds	string[]	与事件中心兼容的终结点中的分区 ID。
path	string	与事件中心兼容的名称。
retentionTimeInDays	integer	设备到云消息的保留时间（以天为单位）。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

回退路由的属性。 IoT 中心在将消息路由到回退终结点时使用这些属性。

名称	类型	说明
condition	string	为应用回退路由而计算的条件。 如果未提供条件，则默认情况下其计算结果为 true。 有关语法，请参阅： https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	满足条件的消息将路由到的终结点列表。 目前仅允许 1 个终结点。
isEnabled	boolean	用于指定是否启用回退路由。
name	string	路由的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符，并且必须是唯一的。
source	RoutingSource	要向其应用路由规则的源。 例如，DeviceMessages

FeedbackProperties

云到设备消息的反馈队列的属性。

名称	类型	说明
lockDurationAsIso8601	string	反馈队列的锁定持续时间。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。
maxDeliveryCount	integer	IoT 中心尝试在反馈队列上传递消息的次数。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。
ttlAsIso8601	string	消息在 IoT 中心过期之前可以使用的时间段。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。

IotHubDescription

IoT 中心的说明。

名称	类型	说明
etag	string	Etag 字段 不 是必需的。 如果响应正文中提供了它，则还必须根据常规 ETag 约定将其作为标头提供。
id	string	资源标识符。
location	string	资源位置。
name	string	资源名称。
properties	IotHubProperties	IotHub 属性
sku	IotHubSkuInfo	IotHub SKU 信息
tags	object	资源标记。
type	string	资源类型。

IotHubProperties

IoT 中心的属性。

名称	类型	说明
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	可用于保护与 IoT 中心的连接的共享访问策略。
cloudToDevice	CloudToDeviceProperties	IoT 中心云到设备的消息传送属性。
comments	string	IoT 中心注释。
enableFileUploadNotifications	boolean	如果为 True，则启用文件上传通知。
eventHubEndpoints	<string,  EventHubProperties>	与事件中心兼容的终结点属性。 此字典的可能键是事件和 operationsMonitoringEvents。 在对 IoT 中心进行创建或更新调用时，这两个键都必须存在于字典中。
features	Capabilities	为 IoT 中心启用的功能和特性。
hostName	string	主机的名称。
ipFilterRules	IpFilterRule[]	IP 筛选器规则。
messagingEndpoints	<string,  MessagingEndpointProperties>	文件上传通知队列的消息传送终结点属性。
operationsMonitoringProperties	OperationsMonitoringProperties	IoT 中心的操作监视属性。 字典的可能键为 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations、Routes、D2CTwinOperations、C2DTwinOperations、TwinQueries、JobsOperations、DirectMethods。
provisioningState	string	预配状态。
routing	RoutingProperties	IoT 中心的路由相关属性。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	中心状态。
storageEndpoints	<string,  StorageEndpointProperties>	可在其中上传文件的 Azure 存储终结点列表。 目前只能配置一个 Azure 存储帐户，并且该帐户必须将其密钥作为$default。 指定多个存储帐户会导致引发错误。 当 enableFileUploadNotifications 属性设置为 True 时，不指定此属性的值会导致引发错误。

IotHubSku

SKU 的名称。

名称	类型	说明
B1	string
B2	string
B3	string
F1	string
S1	string
S2	string
S3	string

IotHubSkuInfo

有关 IoT 中心的 SKU 的信息。

名称	类型	说明
capacity	integer	预配的IoT 中心单位数。 请参阅 https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits。
name	IotHubSku	SKU 的名称。
tier	IotHubSkuTier	IoT 中心的计费层。

IotHubSkuTier

IoT 中心的计费层。

名称	类型	说明
Basic	string
Free	string
Standard	string

IpFilterActionType

此规则捕获的请求的所需操作。

名称	类型	说明
Accept	string
Reject	string

IpFilterRule

IoT 中心的 IP 筛选器规则。

名称	类型	说明
action	IpFilterActionType	此规则捕获的请求的所需操作。
filterName	string	IP 筛选器规则的名称。
ipMask	string	一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。

MessagingEndpointProperties

此 IoT 中心使用的消息传送终结点的属性。

名称	类型	说明
lockDurationAsIso8601	string	锁定持续时间。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload。
maxDeliveryCount	integer	IoT 中心尝试传递消息的次数。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload。
ttlAsIso8601	string	消息在 IoT 中心过期之前可以使用的时间段。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload。

OperationsMonitoringProperties

IoT 中心的操作监视属性。 字典的可能键为 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations、Routes、D2CTwinOperations、C2DTwinOperations、TwinQueries、JobsOperations、DirectMethods。

名称	类型	说明
events	object

RouteProperties

IoT 中心用于将消息路由到终结点的路由规则的属性。

名称	类型	说明
condition	string	评估以应用路由规则的条件。 如果未提供任何条件，则默认情况下其计算结果为 true。 有关语法，请参阅： https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	满足条件的消息将路由到的终结点列表。 目前只允许使用一个终结点。
isEnabled	boolean	用于指定是否启用路由。
name	string	路由的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符，并且必须是唯一的。
source	RoutingSource	要应用路由规则的源，例如 DeviceMessages。

RoutingEndpoints

与 IoT 中心基于路由规则将消息路由到的自定义终结点相关的属性。 付费中心的所有终结点类型中最多允许 10 个自定义终结点，免费中心的所有终结点类型中只允许 1 个自定义终结点。

名称	类型	说明
eventHubs	RoutingEventHubProperties[]	IoT 中心根据路由规则将消息路由到的事件中心终结点列表。 此列表不包括内置事件中心终结点。
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	IoT 中心根据路由规则将消息路由到的服务总线队列终结点的列表。
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	IoT 中心根据路由规则将消息路由到的服务总线主题终结点的列表。
storageContainers	RoutingStorageContainerProperties[]	IoT 中心根据路由规则将消息路由到的存储容器终结点的列表。

RoutingEventHubProperties

与事件中心终结点相关的属性。

名称	类型	说明
connectionString	string	事件中心终结点的连接字符串。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、operationsMonitoringEvents、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。
resourceGroup	string	事件中心终结点的资源组的名称。
subscriptionId	string	事件中心终结点的订阅标识符。

RoutingProperties

IoT 中心的路由相关属性。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

名称	类型	说明
endpoints	RoutingEndpoints	与 IoT 中心基于路由规则将消息路由到的自定义终结点相关的属性。 付费中心的所有终结点类型中最多允许 10 个自定义终结点，免费中心的所有终结点类型中只允许 1 个自定义终结点。
fallbackRoute	FallbackRouteProperties	当未满足“routes”节中指定的任何条件时，用作回退路由的路由的属性。 这是一个可选参数。 如果未设置此属性，则不符合“routes”部分中指定的任何条件的消息将路由到内置的 eventhub 终结点。
routes	RouteProperties[]	IoT 中心用于将消息路由到内置终结点和自定义终结点的用户提供的路由规则列表。 付费中心最多允许 100 个路由规则，免费中心最多允许 5 个路由规则。

RoutingServiceBusQueueEndpointProperties

与服务总线队列终结点类型相关的属性。

名称	类型	说明
connectionString	string	服务总线队列终结点的连接字符串。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、operationsMonitoringEvents、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。 名称不必与实际队列名称相同。
resourceGroup	string	服务总线队列终结点的资源组的名称。
subscriptionId	string	服务总线队列终结点的订阅标识符。

RoutingServiceBusTopicEndpointProperties

与服务总线主题终结点类型相关的属性。

名称	类型	说明
connectionString	string	服务总线主题终结点的连接字符串。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、operationsMonitoringEvents、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。 名称不必与实际主题名称相同。
resourceGroup	string	服务总线主题终结点的资源组的名称。
subscriptionId	string	服务总线主题终结点的订阅标识符。

RoutingSource

要应用路由规则的源，例如 DeviceMessages。

名称	类型	说明
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingStorageContainerProperties

与存储容器终结点相关的属性。

名称	类型	说明
batchFrequencyInSeconds	integer	Blob 写入存储的时间间隔。 值应介于 60 到 720 秒之间。 默认值为 300 秒。
connectionString	string	存储帐户的连接字符串。
containerName	string	存储帐户中存储容器的名称。
encoding	string	用于将消息序列化为 Blob 的编码。 支持的值为“avro”和“avroDeflate”。 默认值为“avro”。
fileNameFormat	string	Blob 的文件名格式。 默认格式为 {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}。 所有参数都是必需的，但可以重新排序。
maxChunkSizeInBytes	integer	写入存储的每个 Blob 的最大字节数。 值应介于 10485760 (10MB) 到 524288000 (500MB) 之间。 默认值为 314572800 (300MB) 。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、operationsMonitoringEvents、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。
resourceGroup	string	存储帐户的资源组的名称。
subscriptionId	string	存储帐户的订阅标识符。

SharedAccessSignatureAuthorizationRule

IoT 中心共享访问策略的属性。

名称	类型	说明
keyName	string	共享访问策略的名称。
primaryKey	string	主键。
rights	AccessRights	分配给共享访问策略的权限。
secondaryKey	string	辅助密钥。

StorageEndpointProperties

用于文件上传的 Azure 存储终结点的属性。

名称	类型	说明
connectionString	string	文件上传到的 Azure 存储帐户的连接字符串。
containerName	string	在其中上传文件的根容器的名称。 容器不需要存在，但应该可以使用指定的 connectionString 进行创建。
sasTtlAsIso8601	string	IoT 中心生成的用于文件上传的 SAS URI 有效的时间段。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options。

TagsResource

仅保存资源的标记的容器，允许用户更新IoT 中心实例上的标记。

名称	类型	说明
tags	object	资源标记