Iot Hub Resource - Create Or Update

リファレンス

サービス:: IoT Hub

API バージョン:: 2023-06-30

IoT ハブのメタデータを作成または更新します。プロパティを変更する通常のパターンは、IoT ハブのメタデータとセキュリティメタデータを取得し、それらを新しい本文で変更された値と組み合わせて IoT ハブを更新することです。 JSON に特定のプロパティがない場合、IoT Hub を更新すると、これらの値が既定にフォールバックし、予期しない動作が発生する可能性があります。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	IoT ハブを含むリソースグループの名前。
resourceName	path	True	string	IoT ハブの名前。
subscriptionId	path	True	string	サブスクリプション識別子。
api-version	query	True	string	API のバージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	IoT Hub の ETag。まったく新しい IoT Hub を作成する場合は指定しないでください。既存の IoT Hub を更新するために必要です。

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
sku	True	IotHubSkuInfo	IotHub SKU 情報
etag		string	Etag フィールドは必要ありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
identity		ArmIdentity	IotHub のマネージド ID。
properties		IotHubProperties	IotHub プロパティ
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	IotHubDescription	これは、作成または更新操作の状態ポーリング要求への応答として返されます。本文には、移行プロビジョニング状態を示すリソース表現が含まれています。
201 Created	IotHubDescription	これは実行時間の長い操作です。検証が完了すると、操作は 201 を返します。応答には、状態 URL を含む Azure-AsyncOperation ヘッダーが含まれています。クライアントは、操作の状態の状態 URL をポーリングする必要があります。成功した場合、操作は HTTP 状態コード 201 (OK) を返します。
Other Status Codes	ErrorDetails	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

IotHubResource_AddCosmosDbEndpoint

IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

要求のサンプル

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

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "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"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": [],
        "cosmosDBSqlContainers": [
          {
            "primaryKey": "<primary-key>",
            "secondaryKey": "<secondary-key>",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}


import com.azure.resourcemanager.iothub.models.AuthenticationType;
import com.azure.resourcemanager.iothub.models.Capabilities;
import com.azure.resourcemanager.iothub.models.CloudToDeviceProperties;
import com.azure.resourcemanager.iothub.models.DefaultAction;
import com.azure.resourcemanager.iothub.models.EventHubProperties;
import com.azure.resourcemanager.iothub.models.FallbackRouteProperties;
import com.azure.resourcemanager.iothub.models.FeedbackProperties;
import com.azure.resourcemanager.iothub.models.IotHubProperties;
import com.azure.resourcemanager.iothub.models.IotHubSku;
import com.azure.resourcemanager.iothub.models.IotHubSkuInfo;
import com.azure.resourcemanager.iothub.models.MessagingEndpointProperties;
import com.azure.resourcemanager.iothub.models.NetworkRuleIpAction;
import com.azure.resourcemanager.iothub.models.NetworkRuleSetIpRule;
import com.azure.resourcemanager.iothub.models.NetworkRuleSetProperties;
import com.azure.resourcemanager.iothub.models.RoutingCosmosDBSqlApiProperties;
import com.azure.resourcemanager.iothub.models.RoutingEndpoints;
import com.azure.resourcemanager.iothub.models.RoutingProperties;
import com.azure.resourcemanager.iothub.models.RoutingSource;
import com.azure.resourcemanager.iothub.models.StorageEndpointProperties;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for IotHubResource CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/
     * iothub_addRoutingCosmosDBEndpoint.json
     */
    /**
     * Sample code: IotHubResource_AddCosmosDbEndpoint.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceAddCosmosDbEndpoint(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().define("testHub").withRegion("centraluseuap")
            .withExistingResourceGroup("myResourceGroup")
            .withSku(new IotHubSkuInfo().withName(IotHubSku.S1).withCapacity(1L)).withTags(
                mapOf())
            .withEtag("AAAAAAFD6M4=")
            .withProperties(new IotHubProperties().withIpFilterRules(Arrays.asList())
                .withNetworkRuleSets(new NetworkRuleSetProperties().withDefaultAction(DefaultAction.DENY)
                    .withApplyToBuiltInEventHubEndpoint(true)
                    .withIpRules(Arrays.asList(
                        new NetworkRuleSetIpRule().withFilterName("rule1").withAction(NetworkRuleIpAction.ALLOW)
                            .withIpMask("131.117.159.53"),
                        new NetworkRuleSetIpRule().withFilterName("rule2").withAction(NetworkRuleIpAction.ALLOW)
                            .withIpMask("157.55.59.128/25"))))
                .withMinTlsVersion("1.2")
                .withEventHubEndpoints(
                    mapOf("events", new EventHubProperties().withRetentionTimeInDays(1L).withPartitionCount(2)))
                .withRouting(new RoutingProperties()
                    .withEndpoints(new RoutingEndpoints().withServiceBusQueues(Arrays.asList())
                        .withServiceBusTopics(Arrays.asList()).withEventHubs(Arrays.asList())
                        .withStorageContainers(Arrays.asList())
                        .withCosmosDBSqlContainers(Arrays.asList(new RoutingCosmosDBSqlApiProperties()
                            .withName("endpointcosmos").withSubscriptionId("<subscription-id>")
                            .withResourceGroup("rg-test")
                            .withEndpointUri("https://test-systemstore-test2.documents.azure.com")
                            .withAuthenticationType(AuthenticationType.KEY_BASED).withPrimaryKey("fakeTokenPlaceholder")
                            .withSecondaryKey("fakeTokenPlaceholder").withDatabaseName("systemstore")
                            .withContainerName("test").withPartitionKeyName("fakeTokenPlaceholder")
                            .withPartitionKeyTemplate("fakeTokenPlaceholder"))))
                    .withRoutes(Arrays.asList()).withFallbackRoute(
                        new FallbackRouteProperties().withName("$fallback").withSource(RoutingSource.DEVICE_MESSAGES)
                            .withCondition("true").withEndpointNames(Arrays.asList("events")).withIsEnabled(true)))
                .withStorageEndpoints(mapOf("$default",
                    new StorageEndpointProperties().withSasTtlAsIso8601(Duration.parse("PT1H")).withConnectionString("")
                        .withContainerName("")))
                .withMessagingEndpoints(mapOf("fileNotifications",
                    new MessagingEndpointProperties().withLockDurationAsIso8601(Duration.parse("PT1M"))
                        .withTtlAsIso8601(Duration.parse("PT1H")).withMaxDeliveryCount(10)))
                .withEnableFileUploadNotifications(false)
                .withCloudToDevice(new CloudToDeviceProperties().withMaxDeliveryCount(10)
                    .withDefaultTtlAsIso8601(Duration.parse("PT1H"))
                    .withFeedback(new FeedbackProperties().withLockDurationAsIso8601(Duration.parse("PT1M"))
                        .withTtlAsIso8601(Duration.parse("PT1H")).withMaxDeliveryCount(10)))
                .withFeatures(Capabilities.NONE).withEnableDataResidency(false))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_add_routing_cosmos_db_endpoint.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
        iot_hub_description={
            "etag": "AAAAAAFD6M4=",
            "location": "centraluseuap",
            "properties": {
                "cloudToDevice": {
                    "defaultTtlAsIso8601": "PT1H",
                    "feedback": {"lockDurationAsIso8601": "PT1M", "maxDeliveryCount": 10, "ttlAsIso8601": "PT1H"},
                    "maxDeliveryCount": 10,
                },
                "enableDataResidency": False,
                "enableFileUploadNotifications": False,
                "eventHubEndpoints": {"events": {"partitionCount": 2, "retentionTimeInDays": 1}},
                "features": "None",
                "ipFilterRules": [],
                "messagingEndpoints": {
                    "fileNotifications": {
                        "lockDurationAsIso8601": "PT1M",
                        "maxDeliveryCount": 10,
                        "ttlAsIso8601": "PT1H",
                    }
                },
                "minTlsVersion": "1.2",
                "networkRuleSets": {
                    "applyToBuiltInEventHubEndpoint": True,
                    "defaultAction": "Deny",
                    "ipRules": [
                        {"action": "Allow", "filterName": "rule1", "ipMask": "131.117.159.53"},
                        {"action": "Allow", "filterName": "rule2", "ipMask": "157.55.59.128/25"},
                    ],
                },
                "routing": {
                    "endpoints": {
                        "cosmosDBSqlContainers": [
                            {
                                "authenticationType": "keyBased",
                                "containerName": "test",
                                "databaseName": "systemstore",
                                "endpointUri": "https://test-systemstore-test2.documents.azure.com",
                                "name": "endpointcosmos",
                                "partitionKeyName": "keystamped",
                                "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
                                "primaryKey": "<primary-key>",
                                "resourceGroup": "rg-test",
                                "secondaryKey": "<secondary-key>",
                                "subscriptionId": "<subscription-id>",
                            }
                        ],
                        "eventHubs": [],
                        "serviceBusQueues": [],
                        "serviceBusTopics": [],
                        "storageContainers": [],
                    },
                    "fallbackRoute": {
                        "condition": "true",
                        "endpointNames": ["events"],
                        "isEnabled": True,
                        "name": "$fallback",
                        "source": "DeviceMessages",
                    },
                    "routes": [],
                },
                "storageEndpoints": {
                    "$default": {"connectionString": "", "containerName": "", "sasTtlAsIso8601": "PT1H"}
                },
            },
            "sku": {"capacity": 1, "name": "S1"},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_addRoutingCosmosDBEndpoint.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

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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_addRoutingCosmosDBEndpoint.json
func ExampleResourceClient_BeginCreateOrUpdate_iotHubResourceAddCosmosDbEndpoint() {
	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)
	}
	poller, err := clientFactory.NewResourceClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "testHub", armiothub.Description{
		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),
			},
			EnableDataResidency:           to.Ptr(false),
			EnableFileUploadNotifications: to.Ptr(false),
			EventHubEndpoints: map[string]*armiothub.EventHubProperties{
				"events": {
					PartitionCount:      to.Ptr[int32](2),
					RetentionTimeInDays: to.Ptr[int64](1),
				},
			},
			Features:      to.Ptr(armiothub.CapabilitiesNone),
			IPFilterRules: []*armiothub.IPFilterRule{},
			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
				"fileNotifications": {
					LockDurationAsIso8601: to.Ptr("PT1M"),
					MaxDeliveryCount:      to.Ptr[int32](10),
					TTLAsIso8601:          to.Ptr("PT1H"),
				},
			},
			MinTLSVersion: to.Ptr("1.2"),
			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"),
					}},
			},
			Routing: &armiothub.RoutingProperties{
				Endpoints: &armiothub.RoutingEndpoints{
					CosmosDBSQLContainers: []*armiothub.RoutingCosmosDBSQLAPIProperties{
						{
							Name:                 to.Ptr("endpointcosmos"),
							AuthenticationType:   to.Ptr(armiothub.AuthenticationTypeKeyBased),
							ContainerName:        to.Ptr("test"),
							DatabaseName:         to.Ptr("systemstore"),
							EndpointURI:          to.Ptr("https://test-systemstore-test2.documents.azure.com"),
							PartitionKeyName:     to.Ptr("keystamped"),
							PartitionKeyTemplate: to.Ptr("{deviceid}-{YYYY}-{MM}"),
							PrimaryKey:           to.Ptr("<primary-key>"),
							ResourceGroup:        to.Ptr("rg-test"),
							SecondaryKey:         to.Ptr("<secondary-key>"),
							SubscriptionID:       to.Ptr("<subscription-id>"),
						}},
					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{},
			},
			StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
				"$default": {
					ConnectionString: to.Ptr(""),
					ContainerName:    to.Ptr(""),
					SasTTLAsIso8601:  to.Ptr("PT1H"),
				},
			},
		},
		SKU: &armiothub.SKUInfo{
			Name:     to.Ptr(armiothub.IotHubSKUS1),
			Capacity: to.Ptr[int64](1),
		},
	}, &armiothub.ResourceClientBeginCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Description = armiothub.Description{
	// 	Name: to.Ptr("testHub"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 	ID: to.Ptr("/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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),
	// 		},
	// 		EnableDataResidency: to.Ptr(false),
	// 		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"),
	// 				},
	// 			},
	// 			MinTLSVersion: to.Ptr("1.2"),
	// 			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{
	// 					CosmosDBSQLContainers: []*armiothub.RoutingCosmosDBSQLAPIProperties{
	// 						{
	// 							Name: to.Ptr("endpointcosmos"),
	// 							AuthenticationType: to.Ptr(armiothub.AuthenticationTypeKeyBased),
	// 							ContainerName: to.Ptr("test"),
	// 							DatabaseName: to.Ptr("systemstore"),
	// 							EndpointURI: to.Ptr("https://test-systemstore-test2.documents.azure.com"),
	// 							ID: to.Ptr("009208fa-9cb7-4b90-bfbd-f40086e766c9"),
	// 							PartitionKeyName: to.Ptr("keystamped"),
	// 							PartitionKeyTemplate: to.Ptr("{deviceid}-{YYYY}-{MM}"),
	// 							ResourceGroup: to.Ptr("rg-test"),
	// 							SubscriptionID: to.Ptr("<subscription-id>"),
	// 					}},
	// 					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

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

/**
 * This sample demonstrates how to Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
 *
 * @summary Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_addRoutingCosmosDBEndpoint.json
 */
async function iotHubResourceAddCosmosDbEndpoint() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const iotHubDescription = {
    etag: "AAAAAAFD6M4=",
    location: "centraluseuap",
    properties: {
      cloudToDevice: {
        defaultTtlAsIso8601: "PT1H",
        feedback: {
          lockDurationAsIso8601: "PT1M",
          maxDeliveryCount: 10,
          ttlAsIso8601: "PT1H",
        },
        maxDeliveryCount: 10,
      },
      enableDataResidency: false,
      enableFileUploadNotifications: false,
      eventHubEndpoints: {
        events: { partitionCount: 2, retentionTimeInDays: 1 },
      },
      features: "None",
      ipFilterRules: [],
      messagingEndpoints: {
        fileNotifications: {
          lockDurationAsIso8601: "PT1M",
          maxDeliveryCount: 10,
          ttlAsIso8601: "PT1H",
        },
      },
      minTlsVersion: "1.2",
      networkRuleSets: {
        applyToBuiltInEventHubEndpoint: true,
        defaultAction: "Deny",
        ipRules: [
          { action: "Allow", filterName: "rule1", ipMask: "131.117.159.53" },
          { action: "Allow", filterName: "rule2", ipMask: "157.55.59.128/25" },
        ],
      },
      routing: {
        endpoints: {
          cosmosDBSqlContainers: [
            {
              name: "endpointcosmos",
              authenticationType: "keyBased",
              containerName: "test",
              databaseName: "systemstore",
              endpointUri: "https://test-systemstore-test2.documents.azure.com",
              partitionKeyName: "keystamped",
              partitionKeyTemplate: "{deviceid}-{YYYY}-{MM}",
              primaryKey: "<primary-key>",
              resourceGroup: "rg-test",
              secondaryKey: "<secondary-key>",
              subscriptionId: "<subscription-id>",
            },
          ],
          eventHubs: [],
          serviceBusQueues: [],
          serviceBusTopics: [],
          storageContainers: [],
        },
        fallbackRoute: {
          name: "$fallback",
          condition: "true",
          endpointNames: ["events"],
          isEnabled: true,
          source: "DeviceMessages",
        },
        routes: [],
      },
      storageEndpoints: {
        $default: {
          connectionString: "",
          containerName: "",
          sasTtlAsIso8601: "PT1H",
        },
      },
    },
    sku: { name: "S1", capacity: 1 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.beginCreateOrUpdateAndWait(
    resourceGroupName,
    resourceName,
    iotHubDescription
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_addRoutingCosmosDBEndpoint.json
// this example is just showing the usage of "IotHubResource_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this IotHubDescriptionResource
IotHubDescriptionCollection collection = resourceGroupResource.GetIotHubDescriptions();

// invoke the operation
string resourceName = "testHub";
IotHubDescriptionData data = new IotHubDescriptionData(new AzureLocation("centraluseuap"), new IotHubSkuInfo(IotHubSku.S1)
{
    Capacity = 1L,
})
{
    ETag = new ETag("AAAAAAFD6M4="),
    Properties = new IotHubProperties()
    {
        IPFilterRules =
        {
        },
        NetworkRuleSets = new IotHubNetworkRuleSetProperties(true, new IotHubNetworkRuleSetIPRule[]
{
new IotHubNetworkRuleSetIPRule("rule1","131.117.159.53")
{
Action = IotHubNetworkRuleIPAction.Allow,
},new IotHubNetworkRuleSetIPRule("rule2","157.55.59.128/25")
{
Action = IotHubNetworkRuleIPAction.Allow,
}
})
        {
            DefaultAction = IotHubNetworkRuleSetDefaultAction.Deny,
        },
        MinTlsVersion = "1.2",
        EventHubEndpoints =
        {
        ["events"] = new EventHubCompatibleEndpointProperties()
        {
        RetentionTimeInDays = 1L,
        PartitionCount = 2,
        },
        },
        Routing = new IotHubRoutingProperties()
        {
            Endpoints = new RoutingEndpoints()
            {
                ServiceBusQueues =
                {
                },
                ServiceBusTopics =
                {
                },
                EventHubs =
                {
                },
                StorageContainers =
                {
                },
                CosmosDBSqlContainers =
                {
                new RoutingCosmosDBSqlApiProperties("endpointcosmos",new Uri("https://test-systemstore-test2.documents.azure.com"),"systemstore","test")
                {
                SubscriptionId = "<subscription-id>",
                ResourceGroup = "rg-test",
                AuthenticationType = IotHubAuthenticationType.KeyBased,
                PrimaryKey = "<primary-key>",
                SecondaryKey = "<secondary-key>",
                PartitionKeyName = "keystamped",
                PartitionKeyTemplate = "{deviceid}-{YYYY}-{MM}",
                }
                },
            },
            Routes =
            {
            },
            FallbackRoute = new IotHubFallbackRouteProperties(IotHubRoutingSource.DeviceMessages, new string[]
{
"events"
}, true)
            {
                Name = "$fallback",
                Condition = "true",
            },
        },
        StorageEndpoints =
        {
        ["$default"] = new IotHubStorageEndpointProperties("","")
        {
        SasTtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
        },
        },
        MessagingEndpoints =
        {
        ["fileNotifications"] = new MessagingEndpointProperties()
        {
        LockDurationAsIso8601 = XmlConvert.ToTimeSpan("PT1M"),
        TtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
        MaxDeliveryCount = 10,
        },
        },
        EnableFileUploadNotifications = false,
        CloudToDevice = new CloudToDeviceProperties()
        {
            MaxDeliveryCount = 10,
            DefaultTtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
            Feedback = new CloudToDeviceFeedbackQueueProperties()
            {
                LockDurationAsIso8601 = XmlConvert.ToTimeSpan("PT1M"),
                TtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
                MaxDeliveryCount = 10,
            },
        },
        Features = IotHubCapability.None,
        EnableDataResidency = false,
    },
    Tags =
    {
    },
};
ArmOperation<IotHubDescriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, resourceName, data);
IotHubDescriptionResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

IotHubResource_CreateOrUpdate

要求のサンプル

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

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "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"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}


import com.azure.resourcemanager.iothub.models.Capabilities;
import com.azure.resourcemanager.iothub.models.CloudToDeviceProperties;
import com.azure.resourcemanager.iothub.models.DefaultAction;
import com.azure.resourcemanager.iothub.models.EventHubProperties;
import com.azure.resourcemanager.iothub.models.FallbackRouteProperties;
import com.azure.resourcemanager.iothub.models.FeedbackProperties;
import com.azure.resourcemanager.iothub.models.IotHubProperties;
import com.azure.resourcemanager.iothub.models.IotHubSku;
import com.azure.resourcemanager.iothub.models.IotHubSkuInfo;
import com.azure.resourcemanager.iothub.models.MessagingEndpointProperties;
import com.azure.resourcemanager.iothub.models.NetworkRuleIpAction;
import com.azure.resourcemanager.iothub.models.NetworkRuleSetIpRule;
import com.azure.resourcemanager.iothub.models.NetworkRuleSetProperties;
import com.azure.resourcemanager.iothub.models.RoutingEndpoints;
import com.azure.resourcemanager.iothub.models.RoutingProperties;
import com.azure.resourcemanager.iothub.models.RoutingSource;
import com.azure.resourcemanager.iothub.models.StorageEndpointProperties;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for IotHubResource CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_createOrUpdate.json
     */
    /**
     * Sample code: IotHubResource_CreateOrUpdate.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceCreateOrUpdate(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().define("testHub").withRegion("centraluseuap")
            .withExistingResourceGroup("myResourceGroup")
            .withSku(new IotHubSkuInfo().withName(IotHubSku.S1).withCapacity(1L)).withTags(
                mapOf())
            .withEtag("AAAAAAFD6M4=")
            .withProperties(new IotHubProperties().withIpFilterRules(Arrays.asList())
                .withNetworkRuleSets(new NetworkRuleSetProperties().withDefaultAction(DefaultAction.DENY)
                    .withApplyToBuiltInEventHubEndpoint(true)
                    .withIpRules(Arrays.asList(
                        new NetworkRuleSetIpRule().withFilterName("rule1").withAction(NetworkRuleIpAction.ALLOW)
                            .withIpMask("131.117.159.53"),
                        new NetworkRuleSetIpRule().withFilterName("rule2").withAction(NetworkRuleIpAction.ALLOW)
                            .withIpMask("157.55.59.128/25"))))
                .withMinTlsVersion("1.2")
                .withEventHubEndpoints(
                    mapOf("events", new EventHubProperties().withRetentionTimeInDays(1L).withPartitionCount(2)))
                .withRouting(new RoutingProperties()
                    .withEndpoints(new RoutingEndpoints().withServiceBusQueues(Arrays.asList())
                        .withServiceBusTopics(Arrays.asList()).withEventHubs(Arrays.asList())
                        .withStorageContainers(Arrays.asList()))
                    .withRoutes(Arrays.asList()).withFallbackRoute(
                        new FallbackRouteProperties().withName("$fallback").withSource(RoutingSource.DEVICE_MESSAGES)
                            .withCondition("true").withEndpointNames(Arrays.asList("events")).withIsEnabled(true)))
                .withStorageEndpoints(mapOf("$default",
                    new StorageEndpointProperties().withSasTtlAsIso8601(Duration.parse("PT1H")).withConnectionString("")
                        .withContainerName("")))
                .withMessagingEndpoints(mapOf("fileNotifications",
                    new MessagingEndpointProperties().withLockDurationAsIso8601(Duration.parse("PT1M"))
                        .withTtlAsIso8601(Duration.parse("PT1H")).withMaxDeliveryCount(10)))
                .withEnableFileUploadNotifications(false)
                .withCloudToDevice(new CloudToDeviceProperties().withMaxDeliveryCount(10)
                    .withDefaultTtlAsIso8601(Duration.parse("PT1H"))
                    .withFeedback(new FeedbackProperties().withLockDurationAsIso8601(Duration.parse("PT1M"))
                        .withTtlAsIso8601(Duration.parse("PT1H")).withMaxDeliveryCount(10)))
                .withFeatures(Capabilities.NONE).withEnableDataResidency(false))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_create_or_update.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
        iot_hub_description={
            "etag": "AAAAAAFD6M4=",
            "location": "centraluseuap",
            "properties": {
                "cloudToDevice": {
                    "defaultTtlAsIso8601": "PT1H",
                    "feedback": {"lockDurationAsIso8601": "PT1M", "maxDeliveryCount": 10, "ttlAsIso8601": "PT1H"},
                    "maxDeliveryCount": 10,
                },
                "enableDataResidency": False,
                "enableFileUploadNotifications": False,
                "eventHubEndpoints": {"events": {"partitionCount": 2, "retentionTimeInDays": 1}},
                "features": "None",
                "ipFilterRules": [],
                "messagingEndpoints": {
                    "fileNotifications": {
                        "lockDurationAsIso8601": "PT1M",
                        "maxDeliveryCount": 10,
                        "ttlAsIso8601": "PT1H",
                    }
                },
                "minTlsVersion": "1.2",
                "networkRuleSets": {
                    "applyToBuiltInEventHubEndpoint": True,
                    "defaultAction": "Deny",
                    "ipRules": [
                        {"action": "Allow", "filterName": "rule1", "ipMask": "131.117.159.53"},
                        {"action": "Allow", "filterName": "rule2", "ipMask": "157.55.59.128/25"},
                    ],
                },
                "routing": {
                    "endpoints": {
                        "eventHubs": [],
                        "serviceBusQueues": [],
                        "serviceBusTopics": [],
                        "storageContainers": [],
                    },
                    "fallbackRoute": {
                        "condition": "true",
                        "endpointNames": ["events"],
                        "isEnabled": True,
                        "name": "$fallback",
                        "source": "DeviceMessages",
                    },
                    "routes": [],
                },
                "storageEndpoints": {
                    "$default": {"connectionString": "", "containerName": "", "sasTtlAsIso8601": "PT1H"}
                },
            },
            "sku": {"capacity": 1, "name": "S1"},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_createOrUpdate.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

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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_createOrUpdate.json
func ExampleResourceClient_BeginCreateOrUpdate_iotHubResourceCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewResourceClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "testHub", armiothub.Description{
		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),
			},
			EnableDataResidency:           to.Ptr(false),
			EnableFileUploadNotifications: to.Ptr(false),
			EventHubEndpoints: map[string]*armiothub.EventHubProperties{
				"events": {
					PartitionCount:      to.Ptr[int32](2),
					RetentionTimeInDays: to.Ptr[int64](1),
				},
			},
			Features:      to.Ptr(armiothub.CapabilitiesNone),
			IPFilterRules: []*armiothub.IPFilterRule{},
			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
				"fileNotifications": {
					LockDurationAsIso8601: to.Ptr("PT1M"),
					MaxDeliveryCount:      to.Ptr[int32](10),
					TTLAsIso8601:          to.Ptr("PT1H"),
				},
			},
			MinTLSVersion: to.Ptr("1.2"),
			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"),
					}},
			},
			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{},
			},
			StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
				"$default": {
					ConnectionString: to.Ptr(""),
					ContainerName:    to.Ptr(""),
					SasTTLAsIso8601:  to.Ptr("PT1H"),
				},
			},
		},
		SKU: &armiothub.SKUInfo{
			Name:     to.Ptr(armiothub.IotHubSKUS1),
			Capacity: to.Ptr[int64](1),
		},
	}, &armiothub.ResourceClientBeginCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Description = armiothub.Description{
	// 	Name: to.Ptr("testHub"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 	ID: to.Ptr("/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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),
	// 		},
	// 		EnableDataResidency: to.Ptr(false),
	// 		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"),
	// 				},
	// 			},
	// 			MinTLSVersion: to.Ptr("1.2"),
	// 			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

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

/**
 * This sample demonstrates how to Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
 *
 * @summary Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_createOrUpdate.json
 */
async function iotHubResourceCreateOrUpdate() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const iotHubDescription = {
    etag: "AAAAAAFD6M4=",
    location: "centraluseuap",
    properties: {
      cloudToDevice: {
        defaultTtlAsIso8601: "PT1H",
        feedback: {
          lockDurationAsIso8601: "PT1M",
          maxDeliveryCount: 10,
          ttlAsIso8601: "PT1H",
        },
        maxDeliveryCount: 10,
      },
      enableDataResidency: false,
      enableFileUploadNotifications: false,
      eventHubEndpoints: {
        events: { partitionCount: 2, retentionTimeInDays: 1 },
      },
      features: "None",
      ipFilterRules: [],
      messagingEndpoints: {
        fileNotifications: {
          lockDurationAsIso8601: "PT1M",
          maxDeliveryCount: 10,
          ttlAsIso8601: "PT1H",
        },
      },
      minTlsVersion: "1.2",
      networkRuleSets: {
        applyToBuiltInEventHubEndpoint: true,
        defaultAction: "Deny",
        ipRules: [
          { action: "Allow", filterName: "rule1", ipMask: "131.117.159.53" },
          { action: "Allow", filterName: "rule2", ipMask: "157.55.59.128/25" },
        ],
      },
      routing: {
        endpoints: {
          eventHubs: [],
          serviceBusQueues: [],
          serviceBusTopics: [],
          storageContainers: [],
        },
        fallbackRoute: {
          name: "$fallback",
          condition: "true",
          endpointNames: ["events"],
          isEnabled: true,
          source: "DeviceMessages",
        },
        routes: [],
      },
      storageEndpoints: {
        $default: {
          connectionString: "",
          containerName: "",
          sasTtlAsIso8601: "PT1H",
        },
      },
    },
    sku: { name: "S1", capacity: 1 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.beginCreateOrUpdateAndWait(
    resourceGroupName,
    resourceName,
    iotHubDescription
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_createOrUpdate.json
// this example is just showing the usage of "IotHubResource_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this IotHubDescriptionResource
IotHubDescriptionCollection collection = resourceGroupResource.GetIotHubDescriptions();

// invoke the operation
string resourceName = "testHub";
IotHubDescriptionData data = new IotHubDescriptionData(new AzureLocation("centraluseuap"), new IotHubSkuInfo(IotHubSku.S1)
{
    Capacity = 1L,
})
{
    ETag = new ETag("AAAAAAFD6M4="),
    Properties = new IotHubProperties()
    {
        IPFilterRules =
        {
        },
        NetworkRuleSets = new IotHubNetworkRuleSetProperties(true, new IotHubNetworkRuleSetIPRule[]
{
new IotHubNetworkRuleSetIPRule("rule1","131.117.159.53")
{
Action = IotHubNetworkRuleIPAction.Allow,
},new IotHubNetworkRuleSetIPRule("rule2","157.55.59.128/25")
{
Action = IotHubNetworkRuleIPAction.Allow,
}
})
        {
            DefaultAction = IotHubNetworkRuleSetDefaultAction.Deny,
        },
        MinTlsVersion = "1.2",
        EventHubEndpoints =
        {
        ["events"] = new EventHubCompatibleEndpointProperties()
        {
        RetentionTimeInDays = 1L,
        PartitionCount = 2,
        },
        },
        Routing = new IotHubRoutingProperties()
        {
            Endpoints = new RoutingEndpoints()
            {
                ServiceBusQueues =
                {
                },
                ServiceBusTopics =
                {
                },
                EventHubs =
                {
                },
                StorageContainers =
                {
                },
            },
            Routes =
            {
            },
            FallbackRoute = new IotHubFallbackRouteProperties(IotHubRoutingSource.DeviceMessages, new string[]
{
"events"
}, true)
            {
                Name = "$fallback",
                Condition = "true",
            },
        },
        StorageEndpoints =
        {
        ["$default"] = new IotHubStorageEndpointProperties("","")
        {
        SasTtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
        },
        },
        MessagingEndpoints =
        {
        ["fileNotifications"] = new MessagingEndpointProperties()
        {
        LockDurationAsIso8601 = XmlConvert.ToTimeSpan("PT1M"),
        TtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
        MaxDeliveryCount = 10,
        },
        },
        EnableFileUploadNotifications = false,
        CloudToDevice = new CloudToDeviceProperties()
        {
            MaxDeliveryCount = 10,
            DefaultTtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
            Feedback = new CloudToDeviceFeedbackQueueProperties()
            {
                LockDurationAsIso8601 = XmlConvert.ToTimeSpan("PT1M"),
                TtlAsIso8601 = XmlConvert.ToTimeSpan("PT1H"),
                MaxDeliveryCount = 10,
            },
        },
        Features = IotHubCapability.None,
        EnableDataResidency = false,
    },
    Tags =
    {
    },
};
ArmOperation<IotHubDescriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, resourceName, data);
IotHubDescriptionResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

定義

名前	説明
AccessRights	共有アクセスポリシーに割り当てられたアクセス許可。
ArmIdentity
ArmUserIdentity
AuthenticationType	ストレージアカウントへの接続に使用する認証の種類を指定します。
authenticationType	Service Bus キューエンドポイントに対する認証に使用されるメソッド
Capabilities	IoT ハブで有効になっている機能。
CloudToDeviceProperties	IoT Hub のクラウドからデバイスへのメッセージングプロパティ。
createdByType	リソースを作成した ID の種類。
DefaultAction	ネットワークルールセットの既定のアクション
EnrichmentProperties	IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。
ErrorDetails	エラーの詳細。
EventHubProperties	IoT ハブによって使用されるプロビジョニング済みの Event Hub 互換エンドポイントのプロパティ。
FallbackRouteProperties	フォールバックルートのプロパティ。 IoT Hub は、フォールバックエンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。
FeedbackProperties	クラウドからデバイスへのメッセージのフィードバックキューのプロパティ。
IotHubDescription	IoT ハブの説明。
IotHubLocationDescription	リソースがプロビジョニングされている場所の 1 つをパブリックに表現します。
IotHubProperties	IoT ハブのプロパティ。
IotHubReplicaRoleType	リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。プライマリリージョンは、IoT ハブが現在プロビジョニングされている場所です。セカンダリリージョンは、Azure ディザスターリカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。
IotHubSku	SKU の名前。
IotHubSkuInfo	IoT ハブの SKU に関する情報。
IotHubSkuTier	IoT ハブの課金レベル。
IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
IpFilterRule	IoT ハブの IP フィルター規則。
ManagedIdentity	マネージド ID のプロパティ。
MessagingEndpointProperties	この IoT ハブで使用されるメッセージングエンドポイントのプロパティ。
NetworkRuleIPAction	IP フィルターアクション
NetworkRuleSetIpRule	ネットワークルールセットの一部として適用される IP ルール
NetworkRuleSetProperties	IotHub のネットワークルールセットプロパティ
PrivateEndpoint	プライベートエンドポイント接続のプライベートエンドポイントプロパティ
PrivateEndpointConnection	IotHub のプライベートエンドポイント接続
PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ
PrivateLinkServiceConnectionState	プライベートエンドポイント接続の現在の状態
PrivateLinkServiceConnectionStatus	プライベートエンドポイント接続の状態
PublicNetworkAccess	パブリックネットワークからの要求が許可されるかどうか
ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
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	Service Bus キューエンドポイントの種類に関連するプロパティ。
RoutingServiceBusTopicEndpointProperties	Service Bus トピックエンドポイントの種類に関連するプロパティ。
RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。
RoutingStorageContainerProperties	ストレージコンテナーエンドポイントに関連するプロパティ。
SharedAccessSignatureAuthorizationRule	IoT Hub 共有アクセスポリシーのプロパティ。
StorageEndpointProperties	ファイルアップロード用の Azure Storage エンドポイントのプロパティ。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AccessRights

列挙

共有アクセスポリシーに割り当てられたアクセス許可。

値	説明
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ArmIdentity

Object

名前	型	説明
principalId	string	プリンシパル ID
tenantId	string	テナント ID
type	ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Object

名前	型	説明
clientId	string
principalId	string

AuthenticationType

列挙

ストレージアカウントへの接続に使用する認証の種類を指定します。

値	説明
identityBased
keyBased

authenticationType

列挙

Service Bus キューエンドポイントに対する認証に使用されるメソッド

値	説明
identityBased
keyBased

Capabilities

列挙

IoT ハブで有効になっている機能。

値	説明
DeviceManagement
None

CloudToDeviceProperties

Object

IoT Hub のクラウドからデバイスへのメッセージングプロパティ。

名前	型	説明
defaultTtlAsIso8601	string (duration)	デバイスキュー内のクラウドからデバイスへのメッセージの既定の有効期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messagesを参照してください。
feedback	FeedbackProperties	クラウドからデバイスへのメッセージのフィードバックキューのプロパティ。
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	デバイスキュー内のクラウドからデバイスへのメッセージの最大配信数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messagesを参照してください。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DefaultAction

列挙

ネットワークルールセットの既定のアクション

値	説明
Allow
Deny

EnrichmentProperties

Object

IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。

名前	型	説明
endpointNames	string[]	エンリッチメントがメッセージに適用されるエンドポイントの一覧。
key	string	エンリッチメントプロパティのキーまたは名前。
value	string	エンリッチメントプロパティの値。

ErrorDetails

Object

エラーの詳細。

名前	型	説明
code	string	エラーコード。
details	string	エラーの詳細。
httpStatusCode	string	HTTP 状態コード。
message	string	エラーメッセージ。

EventHubProperties

Object

IoT ハブによって使用されるプロビジョニング済みの Event Hub 互換エンドポイントのプロパティ。

名前	型	説明
endpoint	string	イベントハブと互換性のあるエンドポイント。
partitionCount	integer (int32)	Event Hub と互換性のあるエンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messagesを参照してください。
partitionIds	string[]	Event Hub と互換性のあるエンドポイントのパーティション ID。
path	string	イベントハブと互換性のある名前。
retentionTimeInDays	integer (int64)	デバイスからクラウドへのメッセージのリテンション期間 (日数)。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照

FallbackRouteProperties

Object

フォールバックルートのプロパティ。 IoT Hub は、フォールバックエンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。

名前	型	説明
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

Object

クラウドからデバイスへのメッセージのフィードバックキューのプロパティ。

名前	型	説明
lockDurationAsIso8601	string (duration)	フィードバックキューのロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messagesを参照してください。
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	IoT ハブがフィードバックキューにメッセージを配信しようとした回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messagesを参照してください。
ttlAsIso8601	string (duration)	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messagesを参照してください。

IotHubDescription

Object

IoT ハブの説明。

名前	型	説明
etag	string	Etag フィールドは必要ありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id	string	リソース識別子。
identity	ArmIdentity	IotHub のマネージド ID。
location	string	リソースの場所。
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	リソース名。
properties	IotHubProperties	IotHub プロパティ
sku	IotHubSkuInfo	IotHub SKU 情報
systemData	systemData	このリソースに関連するシステムメタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。

IotHubLocationDescription

Object

リソースがプロビジョニングされている場所の 1 つをパブリックに表現します。

名前	型	説明
location	string	Azure リージョンの名前
role	IotHubReplicaRoleType	リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。プライマリリージョンは、IoT ハブが現在プロビジョニングされている場所です。セカンダリリージョンは、Azure ディザスターリカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。

IotHubProperties

Object

IoT ハブのプロパティ。

名前	型	説明
allowedFqdnList	string[]	IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセスポリシー。
cloudToDevice	CloudToDeviceProperties	IoT Hub のクラウドからデバイスへのメッセージングプロパティ。
comments	string	IoT Hub のコメント。
disableDeviceSAS	boolean	true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。
disableLocalAuth	boolean	true の場合、IoT ハブスコープの SAS キーを持つ SAS トークンは認証に使用できません。
disableModuleSAS	boolean	true の場合、すべてのモジュールスコープ SAS キーを認証に使用できません。
enableDataResidency	boolean	このプロパティを true に設定すると、データ所在地が有効になり、ディザスターリカバリーが無効になります。
enableFileUploadNotifications	boolean	True の場合、ファイルのアップロード通知が有効になります。
eventHubEndpoints	<string, EventHubProperties>	Event Hub と互換性のあるエンドポイントのプロパティ。このディクショナリに使用できる唯一のキーはイベントです。このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。
features	Capabilities	IoT ハブで有効になっている機能。
hostName	string	ホストの名前。
ipFilterRules	IpFilterRule[]	IP フィルター規則。
locations	IotHubLocationDescription[]	IoT ハブのプライマリとセカンダリの場所
messagingEndpoints	<string, MessagingEndpointProperties>	ファイルアップロード通知キューのメッセージングエンドポイントプロパティ。
minTlsVersion	string	このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。
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 Storage エンドポイントの一覧。現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。複数のストレージアカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。

IotHubReplicaRoleType

列挙

リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。プライマリリージョンは、IoT ハブが現在プロビジョニングされている場所です。セカンダリリージョンは、Azure ディザスターリカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。

値	説明
primary
secondary

IotHubSku

列挙

SKU の名前。

値	説明
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Object

IoT ハブの SKU に関する情報。

名前	型	説明
capacity	integer (int64)	プロビジョニングされた IoT Hub ユニットの数。 https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limitsを参照してください。
name	IotHubSku	SKU の名前。
tier	IotHubSkuTier	IoT ハブの課金レベル。

IotHubSkuTier

列挙

IoT ハブの課金レベル。

値	説明
Basic
Free
Standard

IpFilterActionType

列挙

このルールによってキャプチャされた要求に対して必要なアクション。

値	説明
Accept
Reject

IpFilterRule

Object

IoT ハブの IP フィルター規則。

名前	型	説明
action	IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
filterName	string	IP フィルター規則の名前。
ipMask	string	規則の IP アドレス範囲を CIDR 表記で含む文字列。

ManagedIdentity

Object

マネージド ID のプロパティ。

名前	型	説明
userAssignedIdentity	string	ユーザー割り当て ID。

MessagingEndpointProperties

Object

この IoT ハブで使用されるメッセージングエンドポイントのプロパティ。

名前	型	説明
lockDurationAsIso8601	string (duration)	ロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-uploadを参照してください。
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	IoT ハブがメッセージの配信を試みる回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-uploadを参照してください。
ttlAsIso8601	string (duration)	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-uploadを参照してください。

NetworkRuleIPAction

列挙

IP フィルターアクション

値	説明
Allow

NetworkRuleSetIpRule

Object

ネットワークルールセットの一部として適用される IP ルール

名前	型	規定値	説明
action	NetworkRuleIPAction	Allow	IP フィルターアクション
filterName	string		IP フィルター規則の名前。
ipMask	string		規則の IP アドレス範囲を CIDR 表記で含む文字列。

NetworkRuleSetProperties

Object

IotHub のネットワークルールセットプロパティ

名前	型	規定値	説明
applyToBuiltInEventHubEndpoint	boolean		True の場合、ネットワークルールセットは IotHub の BuiltIn EventHub EndPoint にも適用されます
defaultAction	DefaultAction	Deny	ネットワークルールセットの既定のアクション
ipRules	NetworkRuleSetIpRule[]		IP 規則の一覧

PrivateEndpoint

Object

プライベートエンドポイント接続のプライベートエンドポイントプロパティ

名前	型	説明
id	string	リソース識別子。

PrivateEndpointConnection

Object

IotHub のプライベートエンドポイント接続

名前	型	説明
id	string	リソース識別子。
name	string	リソース名。
properties	PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ
type	string	リソースの種類。

PrivateEndpointConnectionProperties

Object

プライベートエンドポイント接続のプロパティ

名前	型	説明
privateEndpoint	PrivateEndpoint	プライベートエンドポイント接続のプライベートエンドポイントプロパティ
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートエンドポイント接続の現在の状態

PrivateLinkServiceConnectionState

Object

プライベートエンドポイント接続の現在の状態

名前	型	説明
actionsRequired	string	プライベートエンドポイント接続に必要なアクション
description	string	プライベートエンドポイント接続の現在の状態の説明
status	PrivateLinkServiceConnectionStatus	プライベートエンドポイント接続の状態

PrivateLinkServiceConnectionStatus

列挙

プライベートエンドポイント接続の状態

値	説明
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

列挙

パブリックネットワークからの要求が許可されるかどうか

値	説明
Disabled
Enabled

ResourceIdentityType

列挙

リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Object

IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。

名前	型	説明
condition	string	ルーティング規則を適用するために評価される条件。条件が指定されていない場合は、既定で true に評価されます。文法については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language」を参照してください。
endpointNames	string[]	条件を満たすメッセージがルーティングされるエンドポイントの一覧。現在、許可されているエンドポイントは 1 つだけです。
isEnabled	boolean	ルートを有効にするかどうかを指定するために使用します。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	ルートの名前。名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source	RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。

RoutingCosmosDBSqlApiProperties

Object

Cosmos DB SQL コンテナーエンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Cosmos DB SQL コンテナーエンドポイントに対する認証に使用されるメソッド
containerName	string	Cosmos DB データベース内の Cosmos DB SQL コンテナーの名前。
databaseName	string	Cosmos DB アカウント内の Cosmos DB データベースの名前。
endpointUri	string (uri)	Cosmos DB アカウントの URL。プロトコル https:// を含める必要があります
id	string	Cosmos DB SQL コンテナーエンドポイントの ID
identity	ManagedIdentity	Cosmos DB コンテナーエンドポイントのルーティングのマネージド ID プロパティ。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	このエンドポイントを識別する名前。名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。予約されている名前は、イベント、fileNotifications、$defaultです。エンドポイント名は、エンドポイントの種類間で一意である必要があります。
partitionKeyName	string	この Cosmos DB SQL コンテナーに関連付けられているパーティションキーの名前 (存在する場合)。これは省略可能なパラメーターです。
partitionKeyTemplate	string	この Cosmos DB SQL コンテナーで使用する合成パーティションキー値を生成するためのテンプレート。テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。
primaryKey	string	Cosmos DB アカウントの主キー。
resourceGroup	string	Cosmos DB アカウントのリソースグループの名前。
secondaryKey	string	Cosmos DB アカウントのセカンダリキー。
subscriptionId	string	Cosmos DB アカウントのサブスクリプション識別子。

RoutingEndpoints

Object

IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタムエンドポイントに関連するプロパティ。有料ハブのすべての種類のすべてのエンドポイントで最大 10 個のカスタムエンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタムエンドポイントは 1 つだけです。

名前	型	説明
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	IoT Hub がルーティング規則に基づいてメッセージをルーティングする Cosmos DB コンテナーエンドポイントの一覧。
eventHubs	RoutingEventHubProperties[]	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングする Event Hubs エンドポイントの一覧。この一覧には、組み込みの Event Hubs エンドポイントは含まれません。
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キューエンドポイントの一覧。
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピックエンドポイントの一覧。
storageContainers	RoutingStorageContainerProperties[]	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングするストレージコンテナーエンドポイントの一覧。

RoutingEventHubProperties

Object

イベントハブエンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	イベントハブエンドポイントに対する認証に使用されるメソッド
connectionString	string	イベントハブエンドポイントの接続文字列。
endpointUri	string	イベントハブエンドポイントの URL。プロトコル sb:// を含める必要があります
entityPath	string	イベントハブ名前空間のイベントハブ名
id	string	イベントハブエンドポイントの ID
identity	ManagedIdentity	ルーティングイベントハブエンドポイントのマネージド ID プロパティ。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	このエンドポイントを識別する名前。名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。予約されている名前は、イベント、fileNotifications、$defaultです。エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup	string	イベントハブエンドポイントのリソースグループの名前。
subscriptionId	string	イベントハブエンドポイントのサブスクリプション識別子。

RoutingProperties

Object

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

Object

Service Bus キューエンドポイントの種類に関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Service Bus キューエンドポイントに対する認証に使用されるメソッド
connectionString	string	Service Bus キューエンドポイントの接続文字列。
endpointUri	string	Service Bus キューエンドポイントの URL。プロトコル sb:// を含める必要があります
entityPath	string	Service Bus 名前空間のキュー名
id	string	Service Bus キューエンドポイントの ID
identity	ManagedIdentity	ルーティングサービスバスキューエンドポイントのマネージド ID プロパティ。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	このエンドポイントを識別する名前。名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。予約されている名前は、イベント、fileNotifications、$defaultです。エンドポイント名は、エンドポイントの種類間で一意である必要があります。実際のキュー名と同じ名前である必要はありません。
resourceGroup	string	Service Bus キューエンドポイントのリソースグループの名前。
subscriptionId	string	Service Bus キューエンドポイントのサブスクリプション識別子。

RoutingServiceBusTopicEndpointProperties

Object

Service Bus トピックエンドポイントの種類に関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Service Bus トピックエンドポイントに対する認証に使用されるメソッド
connectionString	string	Service Bus トピックエンドポイントの接続文字列。
endpointUri	string	Service Bus トピックエンドポイントの URL。プロトコル sb:// を含める必要があります
entityPath	string	Service Bus トピックのキュー名
id	string	Service Bus トピックエンドポイントの ID
identity	ManagedIdentity	ルーティングサービスバストピックエンドポイントのマネージド ID プロパティ。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	このエンドポイントを識別する名前。名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。予約されている名前は、イベント、fileNotifications、$defaultです。エンドポイント名は、エンドポイントの種類間で一意である必要があります。名前は、実際のトピック名と同じである必要はありません。
resourceGroup	string	Service Bus トピックエンドポイントのリソースグループの名前。
subscriptionId	string	Service Bus トピックエンドポイントのサブスクリプション識別子。

RoutingSource

列挙

ルーティング規則を適用するソース (DeviceMessages など)。

値	説明
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Object

ストレージコンテナーエンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	ストレージエンドポイントに対する認証に使用されるメソッド
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	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	ルーティングストレージエンドポイントのマネージド ID プロパティ。
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	ストレージに書き込まれる各 BLOB の最大バイト数。値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。既定値は 314572800(300 MB) です。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	このエンドポイントを識別する名前。名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。予約されている名前は、イベント、fileNotifications、$defaultです。エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup	string	ストレージアカウントのリソースグループの名前。
subscriptionId	string	ストレージアカウントのサブスクリプション識別子。

SharedAccessSignatureAuthorizationRule

Object

IoT Hub 共有アクセスポリシーのプロパティ。

名前	型	説明
keyName	string	共有アクセスポリシーの名前。
primaryKey	string	主キー。
rights	AccessRights	共有アクセスポリシーに割り当てられたアクセス許可。
secondaryKey	string	セカンダリキー。

StorageEndpointProperties

Object

ファイルアップロード用の Azure Storage エンドポイントのプロパティ。

名前	型	説明
authenticationType	AuthenticationType	ストレージアカウントへの接続に使用する認証の種類を指定します。
connectionString	string	ファイルがアップロードされる Azure Storage アカウントの接続文字列。
containerName	string	ファイルをアップロードするルートコンテナーの名前。コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。
identity	ManagedIdentity	ファイルアップロード用のストレージエンドポイントのマネージド ID プロパティ。
sasTtlAsIso8601	string (duration)	IoT Hub によって生成されたファイルアップロード用の SAS URI が有効な期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-optionsを参照してください。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Iot Hub Resource - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

IotHubResource_AddCosmosDbEndpoint

要求のサンプル

応答のサンプル

IotHubResource_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

AccessRights

ArmIdentity

ArmUserIdentity

AuthenticationType

authenticationType

Capabilities

CloudToDeviceProperties

createdByType

DefaultAction

EnrichmentProperties

ErrorDetails

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubDescription

IotHubLocationDescription

IotHubProperties

IotHubReplicaRoleType

IotHubSku

IotHubSkuInfo

IotHubSkuTier

IpFilterActionType

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

NetworkRuleIPAction

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

PublicNetworkAccess

ResourceIdentityType

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingSource

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

systemData

その他のリソース