Iot Hub Resource - Create Or Update

Dienst:

IoT Hub

API-Version:

2023-06-30

Create oder aktualisieren Sie die Metadaten eines Iot Hubs. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die IoT Hub-Metadaten und Sicherheitsmetadaten abzurufen und sie dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den IoT Hub zu aktualisieren. Wenn bestimmte Eigenschaften im JSON-Code fehlen, kann das Aktualisieren IoT Hub dazu führen, dass diese Werte auf den Standardwert zurückgesetzt werden, was zu unerwartetem Verhalten führen kann.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den IoT Hub enthält.
resourceName	path	True	string	Der Name des IoT-Hubs.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag des IoT Hub. Geben Sie zum Erstellen eines brandneuen IoT Hub nicht an. Erforderlich, um eine vorhandene IoT Hub zu aktualisieren.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der Ressourcenspeicherort.
sku	True	IotHubSkuInfo	Informationen zur IotHub-SKU
etag		string	Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden.
identity		ArmIdentity	Die verwalteten Identitäten für IotHub.
properties		IotHubProperties	IotHub-Eigenschaften
tags		object	Die Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	IotHubDescription	Dies wird als Antwort auf die status Abrufanforderung für den Erstellungs- oder Aktualisierungsvorgang zurückgegeben. Der Text enthält die Ressourcendarstellung, die einen Übergangsbereitstellungsstatus angibt.
201 Created	IotHubDescription	Dieser Vorgang dauert lange. Der Vorgang gibt einen Wert vom Typ 201 zurück, wenn die Überprüfung abgeschlossen ist. Die Antwort enthält einen Azure-AsyncOperation-Header, der eine status-URL enthält. Von Clients wird erwartet, dass sie die status-URL für die status des Vorgangs abfragen. Bei erfolgreicher Ausführung gibt der Vorgang HTTP-status Code von 201 (OK) zurück.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_AddCosmosDbEndpoint

IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

Beispielanforderung

HTTP

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
  }
}

Java

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_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

Go

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

JavaScript

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

dotnet

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_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 = 1,
})
{
    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 = 1,
        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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Statuscode:

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

Beispielanforderung

HTTP

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
  }
}

Java

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_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

Go

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

JavaScript

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

dotnet

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_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 = 1,
})
{
    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 = 1,
        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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Statuscode:

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"
  }
}

Definitionen

Name	Beschreibung
AccessRights	Die Berechtigungen, die der Shared Access-Richtlinie zugewiesen sind.
ArmIdentity
ArmUserIdentity
AuthenticationType	Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
authenticationType	Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt
Capabilities	Die funktionen und features, die für ioT hub aktiviert sind.
CloudToDeviceProperties	Die Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultAction	Standardaktion für Den Netzwerkregelsatz
EnrichmentProperties	Die Eigenschaften einer Anreicherung, die Ihr IoT Hub auf nachrichten an Endpunkte anwendet.
ErrorDetails	Fehlerdetails.
EventHubProperties	Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT Hub verwendet wird.
FallbackRouteProperties	Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn Nachrichten an den Fallbackendpunkt weitergeleitet werden.
FeedbackProperties	Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.
IotHubDescription	Die Beschreibung des IoT Hubs.
IotHubLocationDescription	Öffentliche Darstellung eines der Standorte, an denen eine Ressource bereitgestellt wird.
IotHubProperties	Die Eigenschaften eines IoT Hubs.
IotHubReplicaRoleType	Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.
IotHubSku	Der Name der SKU.
IotHubSkuInfo	Informationen zur SKU des IoT Hubs.
IotHubSkuTier	Der Abrechnungstarif für den IoT Hub.
IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
IpFilterRule	Die IP-Filterregeln für den IoT Hub.
ManagedIdentity	Die Eigenschaften der verwalteten Identität.
MessagingEndpointProperties	Die Eigenschaften der Messagingendpunkte, die von diesem IoT Hub verwendet werden.
NetworkRuleIPAction	IP-Filteraktion
NetworkRuleSetIpRule	IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll
NetworkRuleSetProperties	Netzwerkregelsatzeigenschaften von IotHub
PrivateEndpoint	Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung
PrivateEndpointConnection	Die private Endpunktverbindung eines IotHub
PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
PrivateLinkServiceConnectionState	Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt
PrivateLinkServiceConnectionStatus	Die status einer Verbindung mit einem privaten Endpunkt
PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
RouteProperties	Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.
RoutingCosmosDBSqlApiProperties	Die Eigenschaften im Zusammenhang mit einem sql-Containerendpunkt von Cosmos DB.
RoutingEndpoints	Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur ein benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig.
RoutingEventHubProperties	Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.
RoutingProperties	Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Die Eigenschaften im Zusammenhang mit Service Bus-Warteschlangenendpunkttypen.
RoutingServiceBusTopicEndpointProperties	Die Eigenschaften im Zusammenhang mit Service Bus-Themenendpunkttypen.
RoutingSource	Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.
RoutingStorageContainerProperties	Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.
SharedAccessSignatureAuthorizationRule	Die Eigenschaften einer IoT Hub-Richtlinie für den freigegebenen Zugriff.
StorageEndpointProperties	Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AccessRights

Die Berechtigungen, die der Shared Access-Richtlinie zugewiesen sind.

Name	Typ	Beschreibung
DeviceConnect	string
RegistryRead	string
RegistryRead, DeviceConnect	string
RegistryRead, RegistryWrite	string
RegistryRead, RegistryWrite, DeviceConnect	string
RegistryRead, RegistryWrite, ServiceConnect	string
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect	string
RegistryRead, ServiceConnect	string
RegistryRead, ServiceConnect, DeviceConnect	string
RegistryWrite	string
RegistryWrite, DeviceConnect	string
RegistryWrite, ServiceConnect	string
RegistryWrite, ServiceConnect, DeviceConnect	string
ServiceConnect	string
ServiceConnect, DeviceConnect	string

ArmIdentity

Name	Typ	Beschreibung
principalId	string	Prinzipal-ID
tenantId	string	Mandanten-ID
type	ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	<string,  ArmUserIdentity>

ArmUserIdentity

Name	Typ	Beschreibung
clientId	string
principalId	string

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

Name	Typ	Beschreibung
identityBased	string
keyBased	string

authenticationType

Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt

Name	Typ	Beschreibung
identityBased	string
keyBased	string

Capabilities

Die funktionen und features, die für ioT hub aktiviert sind.

Name	Typ	Beschreibung
DeviceManagement	string
None	string

CloudToDeviceProperties

Die Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub.

Name	Typ	Beschreibung
defaultTtlAsIso8601	string	Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.
maxDeliveryCount	integer	Die maximale Übermittlungsanzahl für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Standardaktion für Den Netzwerkregelsatz

Name	Typ	Beschreibung
Allow	string
Deny	string

EnrichmentProperties

Die Eigenschaften einer Anreicherung, die Ihr IoT Hub auf nachrichten an Endpunkte anwendet.

Name	Typ	Beschreibung
endpointNames	string[]	Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird.
key	string	Der Schlüssel oder Name für die Anreicherungseigenschaft.
value	string	Der Wert für die Anreicherungseigenschaft.

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

EventHubProperties

Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT Hub verwendet wird.

Name	Typ	Beschreibung
endpoint	string	Der Event Hub-kompatible Endpunkt.
partitionCount	integer	Die Anzahl der Partitionen zum Empfangen von Geräte-zu-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Die Partitions-IDs im Event Hub-kompatiblen Endpunkt.
path	string	Der Event Hub-kompatible Name.
retentionTimeInDays	integer	Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn Nachrichten an den Fallbackendpunkt weitergeleitet werden.

Name	Typ	Beschreibung
condition	string	Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht bereitgestellt wird, wird sie standardmäßig auf true ausgewertet. Informationen zur Grammatik finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Die Liste der Endpunkte, an die die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur 1 Endpunkt zulässig.
isEnabled	boolean	Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist.
name	string	Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein.
source	RoutingSource	Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages

FeedbackProperties

Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.

Name	Typ	Beschreibung
lockDurationAsIso8601	string	Die Sperrdauer für die Feedbackwarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer	Die Anzahl der Versuche des IoT Hubs, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string	Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT Hub abgelaufen ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Die Beschreibung des IoT Hubs.

Name	Typ	Beschreibung
etag	string	Das Feld Etag ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss es auch als Header gemäß der normalen ETag-Konvention bereitgestellt werden.
id	string	Der Ressourcenbezeichner.
identity	ArmIdentity	Die verwalteten Identitäten für IotHub.
location	string	Der Ressourcenspeicherort.
name	string	Der Name der Ressource.
properties	IotHubProperties	IotHub-Eigenschaften
sku	IotHubSkuInfo	Informationen zur IotHub-SKU
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

IotHubLocationDescription

Öffentliche Darstellung eines der Standorte, an denen eine Ressource bereitgestellt wird.

Name	Typ	Beschreibung
location	string	Der Name der Azure-Region
role	IotHubReplicaRoleType	Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.

IotHubProperties

Die Eigenschaften eines IoT Hubs.

Name	Typ	Beschreibung
allowedFqdnList	string[]	Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr aus Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Die Richtlinien für den freigegebenen Zugriff, die Sie verwenden können, um eine Verbindung mit dem IoT Hub zu sichern.
cloudToDevice	CloudToDeviceProperties	Die Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub.
comments	string	IoT Hub-Kommentare.
disableDeviceSAS	boolean	Wenn true, können alle sas-Bereichsschlüssel für alle Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) nicht für die Authentifizierung verwendet werden.
disableLocalAuth	boolean	Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden.
disableModuleSAS	boolean	Wenn true, können alle modulbezogenen SAS-Schlüssel nicht für die Authentifizierung verwendet werden.
enableDataResidency	boolean	Wenn diese Eigenschaft auf TRUE festgelegt ist, aktiviert sie die Datenresidenz, wodurch die Notfallwiederherstellung deaktiviert wird.
enableFileUploadNotifications	boolean	Bei True sind Dateiuploadbenachrichtigungen aktiviert.
eventHubEndpoints	<string,  EventHubProperties>	Die Event Hub-kompatiblen Endpunkteigenschaften. Die einzigen möglichen Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden.
features	Capabilities	Die funktionen und features, die für ioT hub aktiviert sind.
hostName	string	Der Name des Hosts.
ipFilterRules	IpFilterRule[]	Die IP-Filterregeln.
locations	IotHubLocationDescription[]	Primärer und sekundärer Standort für iot Hub
messagingEndpoints	<string,  MessagingEndpointProperties>	Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange.
minTlsVersion	string	Gibt die TLS-Mindestversion an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden.
networkRuleSets	NetworkRuleSetProperties	Netzwerkregelsatzeigenschaften von IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden
provisioningState	string	Der Bereitstellungsstatus.
publicNetworkAccess	PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
restrictOutboundNetworkAccess	boolean	Wenn true, ist der Ausgehende von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert werden.
routing	RoutingProperties	Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Der Hubstatus.
storageEndpoints	<string,  StorageEndpointProperties>	Die Liste der Azure Storage-Endpunkte, an denen Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst.

IotHubReplicaRoleType

Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.

Name	Typ	Beschreibung
primary	string
secondary	string

IotHubSku

Der Name der SKU.

Name	Typ	Beschreibung
B1	string
B2	string
B3	string
F1	string
S1	string
S2	string
S3	string

IotHubSkuInfo

Informationen zur SKU des IoT Hubs.

Name	Typ	Beschreibung
capacity	integer	Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Der Name der SKU.
tier	IotHubSkuTier	Der Abrechnungstarif für den IoT Hub.

IotHubSkuTier

Der Abrechnungstarif für den IoT Hub.

Name	Typ	Beschreibung
Basic	string
Free	string
Standard	string

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

Name	Typ	Beschreibung
Accept	string
Reject	string

IpFilterRule

Die IP-Filterregeln für den IoT Hub.

Name	Typ	Beschreibung
action	IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
filterName	string	Der Name der IP-Filterregel.
ipMask	string	Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

Name	Typ	Beschreibung
userAssignedIdentity	string	Die vom Benutzer zugewiesene Identität.

MessagingEndpointProperties

Die Eigenschaften der Messagingendpunkte, die von diesem IoT Hub verwendet werden.

Name	Typ	Beschreibung
lockDurationAsIso8601	string	Die Sperrdauer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer	Die Anzahl der Versuche des IoT Hubs, eine Nachricht zu übermitteln. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string	Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT Hub abgelaufen ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

IP-Filteraktion

Name	Typ	Beschreibung
Allow	string

NetworkRuleSetIpRule

IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll

Name	Typ	Standardwert	Beschreibung
action	NetworkRuleIPAction	Allow	IP-Filteraktion
filterName	string		Name der IP-Filterregel.
ipMask	string		Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.

NetworkRuleSetProperties

Netzwerkregelsatzeigenschaften von IotHub

Name	Typ	Standardwert	Beschreibung
applyToBuiltInEventHubEndpoint	boolean		Bei True wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet.
defaultAction	DefaultAction	Deny	Standardaktion für Den Netzwerkregelsatz
ipRules	NetworkRuleSetIpRule[]		Liste der IP-Regeln

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.

PrivateEndpointConnection

Die private Endpunktverbindung eines IotHub

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string	Der Name der Ressource.
properties	PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
type	string	Der Ressourcentyp.

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

Name	Typ	Beschreibung
privateEndpoint	PrivateEndpoint	Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionState

Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
actionsRequired	string	Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen
description	string	Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt
status	PrivateLinkServiceConnectionStatus	Die status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionStatus

Die status einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

Name	Typ	Beschreibung
Disabled	string
Enabled	string

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RouteProperties

Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.

Name	Typ	Beschreibung
condition	string	Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig auf true ausgewertet. Informationen zur Grammatik finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig.
isEnabled	boolean	Wird verwendet, um anzugeben, ob eine Route aktiviert ist.
name	string	Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein.
source	RoutingSource	Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

RoutingCosmosDBSqlApiProperties

Die Eigenschaften im Zusammenhang mit einem sql-Containerendpunkt von Cosmos DB.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim sql-Containerendpunkt von Cosmos DB
containerName	string	Der Name des cosmos DB-SQL-Containers in der cosmos DB-Datenbank.
databaseName	string	Der Name der cosmos DB-Datenbank im cosmos DB-Konto.
endpointUri	string	Die URL des cosmos DB-Kontos. Es muss das Protokoll enthalten https://
id	string	ID des sql-Containerendpunkts von Cosmos DB
identity	ManagedIdentity	Eigenschaften der verwalteten Identität des Routings des Cosmos DB-Containerendpunkts.
name	string	Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein.
partitionKeyName	string	Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, sofern vorhanden. Dies ist ein optionaler Parameter.
partitionKeyTemplate	string	Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem cosmos DB-SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {YYYY}. Jeder Platzhalter kann höchstens einmal angegeben werden, aber Die Komponenten der Reihenfolge und nicht des Platzhalters sind beliebig. Dieser Parameter ist nur erforderlich, wenn PartitionKeyName angegeben ist.
primaryKey	string	Der Primärschlüssel des cosmos DB-Kontos.
resourceGroup	string	Der Name der Ressourcengruppe des cosmos DB-Kontos.
secondaryKey	string	Der sekundäre Schlüssel des cosmos DB-Kontos.
subscriptionId	string	Der Abonnementbezeichner des cosmos DB-Kontos.

RoutingEndpoints

Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur ein benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig.

Name	Typ	Beschreibung
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Die Liste der Cosmos DB-Containerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet.
eventHubs	RoutingEventHubProperties[]	Die Liste der Event Hubs-Endpunkte, an die IoT Hub-Nachrichten basierend auf den Routingregeln weiterleitet. Diese Liste enthält nicht den integrierten Event Hubs-Endpunkt.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Die Liste der Service Bus-Warteschlangenendpunkte, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Die Liste der Service Bus-Themenendpunkte, an die der IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet.
storageContainers	RoutingStorageContainerProperties[]	Die Liste der Speichercontainerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet.

RoutingEventHubProperties

Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Event Hub-Endpunkt
connectionString	string	Die Verbindungszeichenfolge des Event Hub-Endpunkts.
endpointUri	string	Die URL des Event Hub-Endpunkts. Es muss das Protokoll enthalten sb://
entityPath	string	Event Hub-Name im Event Hub-Namespace
id	string	ID des Event Hub-Endpunkts
identity	ManagedIdentity	Eigenschaften der verwalteten Identität des Routing-Event Hub-Endpunkts.
name	string	Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein.
resourceGroup	string	Der Name der Ressourcengruppe des Event Hub-Endpunkts.
subscriptionId	string	Der Abonnementbezeichner des Event Hub-Endpunkts.

RoutingProperties

Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Typ	Beschreibung
endpoints	RoutingEndpoints	Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur ein benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig.
enrichments	EnrichmentProperties[]	Die Liste der vom Benutzer bereitgestellten Anreicherungen, die der IoT Hub auf Nachrichten anwendet, die an integrierte und benutzerdefinierte Endpunkte übermittelt werden sollen. Siehe: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Die Eigenschaften der Route, die als Fallbackroute verwendet wird, wenn keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllt ist. Dies ist ein optionaler Parameter. Wenn diese Eigenschaft in der Vorlage nicht vorhanden ist, ist die Fallbackroute standardmäßig deaktiviert.
routes	RouteProperties[]	Die Liste der vom Benutzer bereitgestellten Routingregeln, die der IoT Hub verwendet, um Nachrichten an integrierte und benutzerdefinierte Endpunkte weiterzuleiten. Für kostenpflichtige Hubs sind maximal 100 Routingregeln zulässig, für kostenlose Hubs sind maximal 5 Routingregeln zulässig.

RoutingServiceBusQueueEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Warteschlangenendpunkttypen.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt
connectionString	string	Die Verbindungszeichenfolge des Service Bus-Warteschlangenendpunkts.
endpointUri	string	Die URL des Service Bus-Warteschlangenendpunkts. Es muss das Protokoll enthalten sb://
entityPath	string	Warteschlangenname im Service Bus-Namespace
id	string	ID des Service Bus-Warteschlangenendpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts.
name	string	Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen identisch sein.
resourceGroup	string	Der Name der Ressourcengruppe des Service Bus-Warteschlangenendpunkts.
subscriptionId	string	Der Abonnementbezeichner des Service Bus-Warteschlangenendpunkts.

RoutingServiceBusTopicEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Themenendpunkttypen.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Service Bus-Themenendpunkt
connectionString	string	Die Verbindungszeichenfolge des Service Bus-Themenendpunkts.
endpointUri	string	Die URL des Service Bus-Themenendpunkts. Es muss das Protokoll enthalten sb://
entityPath	string	Warteschlangenname im Service Bus-Thema
id	string	ID des Service Bus-Themenendpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routing-Service Bus-Themenendpunkts.
name	string	Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themennamen identisch sein.
resourceGroup	string	Der Name der Ressourcengruppe des Service Bus-Themenendpunkts.
subscriptionId	string	Der Abonnementbezeichner des Service Bus-Themenendpunkts.

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

Name	Typ	Beschreibung
DeviceConnectionStateEvents	string
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingStorageContainerProperties

Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Speicherendpunkt
batchFrequencyInSeconds	integer	Zeitintervall, in dem Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert ist 300 Sekunden.
connectionString	string	Die Verbindungszeichenfolge des Speicherkontos.
containerName	string	Der Name des Speichercontainers im Speicherkonto.
encoding	enum: Avro AvroDeflate JSON	Codierung, die zum Serialisieren von Nachrichten in Blobs verwendet wird. Unterstützte Werte sind "avro", "avrodeflate" und "JSON". Der Standardwert ist "avro".
endpointUri	string	Die URL des Speicherendpunkts. Es muss das Protokoll enthalten https://
fileNameFormat	string	Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu angeordnet werden.
id	string	ID des Speichercontainerendpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routingspeicherendpunkts.
maxChunkSizeInBytes	integer	Maximale Anzahl von Bytes für jedes in den Speicher geschriebene Blob. Der Wert sollte zwischen 10485760(10MB) und 524288000(500MB) liegen. Der Standardwert ist 314572800(300MB).
name	string	Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein.
resourceGroup	string	Der Name der Ressourcengruppe des Speicherkontos.
subscriptionId	string	Der Abonnementbezeichner des Speicherkontos.

SharedAccessSignatureAuthorizationRule

Die Eigenschaften einer IoT Hub-Richtlinie für den freigegebenen Zugriff.

Name	Typ	Beschreibung
keyName	string	Der Name der SAS-Richtlinie.
primaryKey	string	Der primäre Schlüssel.
rights	AccessRights	Die Berechtigungen, die der Shared Access-Richtlinie zugewiesen sind.
secondaryKey	string	Der sekundäre Schlüssel.

StorageEndpointProperties

Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload.

Name	Typ	Beschreibung
authenticationType	AuthenticationType	Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
connectionString	string	Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden.
containerName	string	Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte aber mit dem angegebenen connectionString bestellbar sein.
identity	ManagedIdentity	Eigenschaften der verwalteten Identität des Speicherendpunkts für den Dateiupload.
sasTtlAsIso8601	string	Der Zeitraum, für den der von IoT Hub für den Dateiupload generierte SAS-URI gültig ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.