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

Iot Hub Resource - List By Subscription

服务:

IoT Hub

API 版本:

2023-06-30

获取订阅中的所有 IoT 中心。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

响应

名称	类型	说明
200 OK	IotHubDescriptionListResult	这是一个同步操作。 正文包含来自订阅中所有 IoT 中心的元数据的 JSON 序列化数组。
Other Status Codes	ErrorDetails	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

IotHubResource_ListBySubscription

示例请求

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30

Java

/** Samples for IotHubResource List. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
     */
    /**
     * Sample code: IotHubResource_ListBySubscription.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceListBySubscription(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.iothub import IotHubClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_listbysubscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotHubClient(
        credential=DefaultAzureCredential(),
        subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
    )

    response = client.iot_hub_resource.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
func ExampleResourceClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DescriptionListResult = armiothub.DescriptionListResult{
		// 	Value: []*armiothub.Description{
		// 		{
		// 			Name: to.Ptr("testHub"),
		// 			Type: to.Ptr("Microsoft.Devices/IotHubs"),
		// 			ID: to.Ptr("/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub"),
		// 			Location: to.Ptr("centraluseuap"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Etag: to.Ptr("AAAAAAFD6M4="),
		// 			Properties: &armiothub.Properties{
		// 				CloudToDevice: &armiothub.CloudToDeviceProperties{
		// 					DefaultTTLAsIso8601: to.Ptr("PT1H"),
		// 					Feedback: &armiothub.FeedbackProperties{
		// 						LockDurationAsIso8601: to.Ptr("PT1M"),
		// 						MaxDeliveryCount: to.Ptr[int32](10),
		// 						TTLAsIso8601: to.Ptr("PT1H"),
		// 					},
		// 					MaxDeliveryCount: to.Ptr[int32](10),
		// 				},
		// 				EnableFileUploadNotifications: to.Ptr(false),
		// 				EventHubEndpoints: map[string]*armiothub.EventHubProperties{
		// 					"events": &armiothub.EventHubProperties{
		// 						Path: to.Ptr("iot-dps-cit-hub-1"),
		// 						Endpoint: to.Ptr("sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"),
		// 						PartitionCount: to.Ptr[int32](2),
		// 						PartitionIDs: []*string{
		// 							to.Ptr("0"),
		// 							to.Ptr("1")},
		// 							RetentionTimeInDays: to.Ptr[int64](1),
		// 						},
		// 					},
		// 					Features: to.Ptr(armiothub.CapabilitiesNone),
		// 					HostName: to.Ptr("iot-dps-cit-hub-1.azure-devices.net"),
		// 					IPFilterRules: []*armiothub.IPFilterRule{
		// 						{
		// 							Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
		// 							FilterName: to.Ptr("rule1"),
		// 							IPMask: to.Ptr("131.117.159.53"),
		// 						},
		// 						{
		// 							Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
		// 							FilterName: to.Ptr("rule2"),
		// 							IPMask: to.Ptr("157.55.59.128/25"),
		// 					}},
		// 					MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
		// 						"fileNotifications": &armiothub.MessagingEndpointProperties{
		// 							LockDurationAsIso8601: to.Ptr("PT1M"),
		// 							MaxDeliveryCount: to.Ptr[int32](10),
		// 							TTLAsIso8601: to.Ptr("PT1H"),
		// 						},
		// 					},
		// 					NetworkRuleSets: &armiothub.NetworkRuleSetProperties{
		// 						ApplyToBuiltInEventHubEndpoint: to.Ptr(true),
		// 						DefaultAction: to.Ptr(armiothub.DefaultActionDeny),
		// 						IPRules: []*armiothub.NetworkRuleSetIPRule{
		// 							{
		// 								Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
		// 								FilterName: to.Ptr("rule1"),
		// 								IPMask: to.Ptr("131.117.159.53"),
		// 							},
		// 							{
		// 								Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
		// 								FilterName: to.Ptr("rule2"),
		// 								IPMask: to.Ptr("157.55.59.128/25"),
		// 						}},
		// 					},
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					Routing: &armiothub.RoutingProperties{
		// 						Endpoints: &armiothub.RoutingEndpoints{
		// 							EventHubs: []*armiothub.RoutingEventHubProperties{
		// 							},
		// 							ServiceBusQueues: []*armiothub.RoutingServiceBusQueueEndpointProperties{
		// 							},
		// 							ServiceBusTopics: []*armiothub.RoutingServiceBusTopicEndpointProperties{
		// 							},
		// 							StorageContainers: []*armiothub.RoutingStorageContainerProperties{
		// 							},
		// 						},
		// 						FallbackRoute: &armiothub.FallbackRouteProperties{
		// 							Name: to.Ptr("$fallback"),
		// 							Condition: to.Ptr("true"),
		// 							EndpointNames: []*string{
		// 								to.Ptr("events")},
		// 								IsEnabled: to.Ptr(true),
		// 								Source: to.Ptr(armiothub.RoutingSourceDeviceMessages),
		// 							},
		// 							Routes: []*armiothub.RouteProperties{
		// 							},
		// 						},
		// 						State: to.Ptr("Active"),
		// 						StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
		// 							"$default": &armiothub.StorageEndpointProperties{
		// 								ConnectionString: to.Ptr(""),
		// 								ContainerName: to.Ptr(""),
		// 								SasTTLAsIso8601: to.Ptr("PT1H"),
		// 							},
		// 						},
		// 					},
		// 					SKU: &armiothub.SKUInfo{
		// 						Name: to.Ptr(armiothub.IotHubSKUS1),
		// 						Capacity: to.Ptr[int64](1),
		// 						Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
		// 					},
		// 					SystemData: &armiothub.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:28:38.963Z"); return t}()),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get all the IoT hubs in a subscription.
 *
 * @summary Get all the IoT hubs in a subscription.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
 */
async function iotHubResourceListBySubscription() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.iotHubResource.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.IotHub;
using Azure.ResourceManager.IotHub.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
// this example is just showing the usage of "IotHubResource_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (IotHubDescriptionResource item in subscriptionResource.GetIotHubDescriptionsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    IotHubDescriptionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
      "name": "testHub",
      "type": "Microsoft.Devices/IotHubs",
      "location": "centraluseuap",
      "tags": {},
      "etag": "AAAAAAFD6M4=",
      "properties": {
        "state": "Active",
        "provisioningState": "Succeeded",
        "ipFilterRules": [
          {
            "filterName": "rule1",
            "action": "Accept",
            "ipMask": "131.117.159.53"
          },
          {
            "filterName": "rule2",
            "action": "Accept",
            "ipMask": "157.55.59.128/25"
          }
        ],
        "networkRuleSets": {
          "defaultAction": "Deny",
          "applyToBuiltInEventHubEndpoint": true,
          "ipRules": [
            {
              "filterName": "rule1",
              "action": "Allow",
              "ipMask": "131.117.159.53"
            },
            {
              "filterName": "rule2",
              "action": "Allow",
              "ipMask": "157.55.59.128/25"
            }
          ]
        },
        "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/"
          }
        },
        "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
      },
      "systemData": {
        "createdAt": "2021-01-30T00:28:38.963Z"
      }
    }
  ]
}

定义

名称	说明
AccessRights	分配给共享访问策略的权限。
ArmIdentity
ArmUserIdentity
AuthenticationType	指定用于连接到存储帐户的身份验证类型。
authenticationType	用于针对服务总线队列终结点进行身份验证的方法
Capabilities	为 IoT 中心启用的功能和特性。
CloudToDeviceProperties	IoT 中心云到设备的消息传送属性。
createdByType	创建资源的标识类型。
DefaultAction	网络规则集的默认操作
EnrichmentProperties	IoT 中心应用于传递到终结点的消息的扩充属性。
ErrorDetails	错误详细信息。
EventHubProperties	IoT 中心使用的预配事件中心兼容终结点的属性。
FallbackRouteProperties	回退路由的属性。 IoT 中心在将消息路由到回退终结点时使用这些属性。
FeedbackProperties	云到设备消息的反馈队列的属性。
IotHubDescription	IoT 中心的说明。
IotHubDescriptionListResult	包含下一个链接的 IotHubDescription 对象的 JSON 序列化数组。
IotHubLocationDescription	预配资源的位置之一的公共表示形式。
IotHubProperties	IoT 中心的属性。
IotHubReplicaRoleType	区域的角色可以是主要角色，也可以是辅助角色。 主要区域是 IoT 中心当前预配的区域。 次要区域是 Azure 灾难恢复 (DR) 配对区域，也是 IoT 中心可以故障转移到的区域。
IotHubSku	SKU 的名称。
IotHubSkuInfo	有关 IoT 中心的 SKU 的信息。
IotHubSkuTier	IoT 中心的计费层。
IpFilterActionType	此规则捕获的请求的所需操作。
IpFilterRule	IoT 中心的 IP 筛选器规则。
ManagedIdentity	托管标识的属性。
MessagingEndpointProperties	此 IoT 中心使用的消息传送终结点的属性。
NetworkRuleIPAction	IP 筛选器操作
NetworkRuleSetIpRule	要作为网络规则集的一部分应用的 IP 规则
NetworkRuleSetProperties	IotHub 的网络规则集属性
PrivateEndpoint	专用终结点连接的专用终结点属性
PrivateEndpointConnection	IotHub 的专用终结点连接
PrivateEndpointConnectionProperties	专用终结点连接的属性
PrivateLinkServiceConnectionState	专用终结点连接的当前状态
PrivateLinkServiceConnectionStatus	专用终结点连接的状态
PublicNetworkAccess	是否允许来自公用网络的请求
ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
RouteProperties	IoT 中心用于将消息路由到终结点的路由规则的属性。
RoutingCosmosDBSqlApiProperties	与 cosmos DB sql 容器终结点相关的属性。
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 存储终结点的属性。
systemData	与资源的创建和上次修改相关的元数据。

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

ArmIdentity

名称	类型	说明
principalId	string	主体 ID
tenantId	string	租户 ID
type	ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
userAssignedIdentities	<string,  ArmUserIdentity>

ArmUserIdentity

名称	类型	说明
clientId	string
principalId	string

AuthenticationType

指定用于连接到存储帐户的身份验证类型。

名称	类型	说明
identityBased	string
keyBased	string

authenticationType

用于针对服务总线队列终结点进行身份验证的方法

名称	类型	说明
identityBased	string
keyBased	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。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

网络规则集的默认操作

名称	类型	说明
Allow	string
Deny	string

EnrichmentProperties

IoT 中心应用于传递到终结点的消息的扩充属性。

名称	类型	说明
endpointNames	string[]	将扩充应用于消息的终结点列表。
key	string	扩充属性的键或名称。
value	string	扩充属性的值。

ErrorDetails

错误详细信息。

名称	类型	说明
code	string	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。

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	资源标识符。
identity	ArmIdentity	IotHub 的托管标识。
location	string	资源位置。
name	string	资源名称。
properties	IotHubProperties	IotHub 属性
sku	IotHubSkuInfo	IotHub SKU 信息
systemData	systemData	与此资源相关的系统元数据。
tags	object	资源标记。
type	string	资源类型。

IotHubDescriptionListResult

包含下一个链接的 IotHubDescription 对象的 JSON 序列化数组。

名称	类型	说明
nextLink	string	下一个链接。
value	IotHubDescription[]	IotHubDescription 对象的数组。

IotHubLocationDescription

预配资源的位置之一的公共表示形式。

名称	类型	说明
location	string	Azure 区域的名称
role	IotHubReplicaRoleType	区域的角色可以是主要角色，也可以是辅助角色。 主要区域是 IoT 中心当前预配的区域。 次要区域是 Azure 灾难恢复 (DR) 配对区域，也是 IoT 中心可以故障转移到的区域。

IotHubProperties

IoT 中心的属性。

名称	类型	说明
allowedFqdnList	string[]	允许的 FQDN 列表 (来自 Iot 中心的出口的完全限定域名) 。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	可用于保护与 IoT 中心的连接的共享访问策略。
cloudToDevice	CloudToDeviceProperties	IoT 中心云到设备的消息传送属性。
comments	string	IoT 中心注释。
disableDeviceSAS	boolean	如果为 true，则所有设备 (包括 Edge 设备，但不包括) 作用域 SAS 密钥的模块，都不能用于身份验证。
disableLocalAuth	boolean	如果为 true，则无法使用具有 Iot 中心范围的 SAS 密钥的 SAS 令牌进行身份验证。
disableModuleSAS	boolean	如果为 true，则不能使用所有模块范围的 SAS 密钥进行身份验证。
enableDataResidency	boolean	当设置为 true 时，此属性将启用数据驻留，从而禁用灾难恢复。
enableFileUploadNotifications	boolean	如果为 True，则启用文件上传通知。
eventHubEndpoints	<string,  EventHubProperties>	与事件中心兼容的终结点属性。 此字典的唯一可能的键是事件。 在对 IoT 中心进行创建或更新调用时，此密钥必须存在于字典中。
features	Capabilities	为 IoT 中心启用的功能和功能。
hostName	string	主机的名称。
ipFilterRules	IpFilterRule[]	IP 筛选器规则。
locations	IotHubLocationDescription[]	iot 中心的主位置和辅助位置
messagingEndpoints	<string,  MessagingEndpointProperties>	文件上传通知队列的消息传送终结点属性。
minTlsVersion	string	指定要对此中心支持的最低 TLS 版本。 可以设置为“1.2”，以拒绝使用低于 1.2 的 TLS 版本的客户端。
networkRuleSets	NetworkRuleSetProperties	IotHub 的网络规则集属性
privateEndpointConnections	PrivateEndpointConnection[]	在此 IotHub 上创建的专用终结点连接
provisioningState	string	预配状态。
publicNetworkAccess	PublicNetworkAccess	是否允许来自公用网络的请求
restrictOutboundNetworkAccess	boolean	如果为 true，则来自 IotHub 的出口将限制为仅允许通过 allowedFqdnList 配置的 FQDN。
routing	RoutingProperties	IoT 中心的路由相关属性。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	中心状态。
storageEndpoints	<string,  StorageEndpointProperties>	可在其中上传文件的 Azure 存储终结点列表。 目前只能配置一个 Azure 存储帐户，并且该帐户必须将其密钥作为$default。 指定多个存储帐户会导致引发错误。 当 enableFileUploadNotifications 属性设置为 True 时，不指定此属性的值会导致引发错误。

IotHubReplicaRoleType

区域的角色可以是主要角色，也可以是辅助角色。 主要区域是 IoT 中心当前预配的区域。 次要区域是 Azure 灾难恢复 (DR) 配对区域，也是 IoT 中心可以故障转移到的区域。

名称	类型	说明
primary	string
secondary	string

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 地址范围的字符串。

ManagedIdentity

托管标识的属性。

名称	类型	说明
userAssignedIdentity	string	用户分配的标识。

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。

NetworkRuleIPAction

IP 筛选器操作

名称	类型	说明
Allow	string

NetworkRuleSetIpRule

要作为网络规则集的一部分应用的 IP 规则

名称	类型	默认值	说明
action	NetworkRuleIPAction	Allow	IP 筛选器操作
filterName	string		IP 筛选器规则的名称。
ipMask	string		一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。

NetworkRuleSetProperties

IotHub 的网络规则集属性

名称	类型	默认值	说明
applyToBuiltInEventHubEndpoint	boolean		如果为 True，则网络规则集也应用于 IotHub 的 BuiltIn EventHub EndPoint
defaultAction	DefaultAction	Deny	网络规则集的默认操作
ipRules	NetworkRuleSetIpRule[]		IP 规则列表

PrivateEndpoint

专用终结点连接的专用终结点属性

名称	类型	说明
id	string	资源标识符。

PrivateEndpointConnection

IotHub 的专用终结点连接

名称	类型	说明
id	string	资源标识符。
name	string	资源名称。
properties	PrivateEndpointConnectionProperties	专用终结点连接的属性
type	string	资源类型。

PrivateEndpointConnectionProperties

专用终结点连接的属性

名称	类型	说明
privateEndpoint	PrivateEndpoint	专用终结点连接的专用终结点属性
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用终结点连接的当前状态

PrivateLinkServiceConnectionState

专用终结点连接的当前状态

名称	类型	说明
actionsRequired	string	专用终结点连接所需的操作
description	string	专用终结点连接的当前状态的说明
status	PrivateLinkServiceConnectionStatus	专用终结点连接的状态

PrivateLinkServiceConnectionStatus

专用终结点连接的状态

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

是否允许来自公用网络的请求

名称	类型	说明
Disabled	string
Enabled	string

ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

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。

RoutingCosmosDBSqlApiProperties

与 cosmos DB sql 容器终结点相关的属性。

名称	类型	说明
authenticationType	authenticationType	用于对 cosmos DB sql 容器终结点进行身份验证的方法
containerName	string	cosmos DB 数据库中 cosmos DB sql 容器的名称。
databaseName	string	cosmos DB 帐户中 cosmos DB 数据库的名称。
endpointUri	string	cosmos DB 帐户的 URL。 它必须包含协议 https://
id	string	cosmos DB sql 容器终结点的 ID
identity	ManagedIdentity	路由 cosmos DB 容器终结点的托管标识属性。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。
partitionKeyName	string	与此 cosmos DB sql 容器关联的分区键的名称（如果存在）。 这是一个可选参数。
partitionKeyTemplate	string	用于生成用于此 cosmos DB sql 容器的合成分区键值的模板。 该模板必须至少包含以下占位符之一：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 最多可以指定一个占位符一次，但顺序和非占位符组件是任意的。 仅当指定 PartitionKeyName 时，此参数才是必需的。
primaryKey	string	cosmos DB 帐户的主键。
resourceGroup	string	cosmos DB 帐户的资源组的名称。
secondaryKey	string	cosmos DB 帐户的辅助密钥。
subscriptionId	string	cosmos DB 帐户的订阅标识符。

RoutingEndpoints

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

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

RoutingEventHubProperties

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

名称	类型	说明
authenticationType	authenticationType	用于针对事件中心终结点进行身份验证的方法
connectionString	string	事件中心终结点的连接字符串。
endpointUri	string	事件中心终结点的 URL。 它必须包含协议 sb://
entityPath	string	事件中心命名空间上的事件中心名称
id	string	事件中心终结点的 ID
identity	ManagedIdentity	路由事件中心终结点的托管标识属性。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。
resourceGroup	string	事件中心终结点的资源组的名称。
subscriptionId	string	事件中心终结点的订阅标识符。

RoutingProperties

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

名称	类型	说明
endpoints	RoutingEndpoints	与 IoT 中心根据路由规则将消息路由到的自定义终结点相关的属性。 付费中心的所有终结点类型中最多允许 10 个自定义终结点，免费中心的所有终结点类型中只允许 1 个自定义终结点。
enrichments	EnrichmentProperties[]	IoT 中心应用于要传递到内置终结点和自定义终结点的消息的用户提供的扩充列表。 请参阅：https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	当未满足“routes”节中指定的任何条件时，用作回退路由的路由的属性。 这是一个可选参数。 如果模板中不存在此属性，则默认禁用回退路由。
routes	RouteProperties[]	IoT 中心用于将消息路由到内置终结点和自定义终结点的用户提供的路由规则列表。 付费中心最多允许 100 个路由规则，免费中心最多允许 5 个路由规则。

RoutingServiceBusQueueEndpointProperties

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

名称	类型	说明
authenticationType	authenticationType	用于针对服务总线队列终结点进行身份验证的方法
connectionString	string	服务总线队列终结点的连接字符串。
endpointUri	string	服务总线队列终结点的 URL。 它必须包含协议 sb://
entityPath	string	服务总线命名空间上的队列名称
id	string	服务总线队列终结点的 ID
identity	ManagedIdentity	路由服务总线队列终结点的托管标识属性。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。 名称不必与实际队列名称相同。
resourceGroup	string	服务总线队列终结点的资源组的名称。
subscriptionId	string	服务总线队列终结点的订阅标识符。

RoutingServiceBusTopicEndpointProperties

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

名称	类型	说明
authenticationType	authenticationType	用于针对服务总线主题终结点进行身份验证的方法
connectionString	string	服务总线主题终结点的连接字符串。
endpointUri	string	服务总线主题终结点的 URL。 它必须包含协议 sb://
entityPath	string	服务总线主题上的队列名称
id	string	服务总线主题终结点的 ID
identity	ManagedIdentity	路由服务总线主题终结点的托管标识属性。
name	string	标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。 名称不必与实际主题名称相同。
resourceGroup	string	服务总线主题终结点的资源组的名称。
subscriptionId	string	服务总线主题终结点的订阅标识符。

RoutingSource

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

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

RoutingStorageContainerProperties

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

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

SharedAccessSignatureAuthorizationRule

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

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

StorageEndpointProperties

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

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

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。