Iot Hub Resource - Create Or Update

Référence

Service:: IoT Hub

Version d'API:: 2023-06-30

Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du hub IoT et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le hub IoT.
resourceName	path	True	string	Nom du hub IoT.
subscriptionId	path	True	string	Identificateur d’abonnement.
api-version	query	True	string	Version de l’API.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’IoT Hub. Ne spécifiez pas de création d’un hub IoT. Requis pour mettre à jour un IoT Hub existant.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement de la ressource.
sku	True	IotHubSkuInfo	Informations sur la référence SKU IotHub
etag		string	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.
identity		ArmIdentity	Identités managées pour IotHub.
properties		IotHubProperties	Propriétés IotHub
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	IotHubDescription	Cette opération est retournée en réponse à la demande d’interrogation d’état pour l’opération de création ou de mise à jour. Le corps contient la représentation de ressource qui indique un état d’approvisionnement transitionnel.
201 Created	IotHubDescription	Il s’agit d’une opération longue. L’opération retourne une valeur 201 si la validation est terminée. La réponse inclut un en-tête Azure-AsyncOperation qui contient une URL d’état. Les clients sont censés interroger l’URL d’état pour l’état de l’opération. Si elle réussit, l’opération retourne le code d’état HTTP 201 (OK).
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_AddCosmosDbEndpoint

IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

Exemple de requête

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

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": [],
        "cosmosDBSqlContainers": [
          {
            "primaryKey": "<primary-key>",
            "secondaryKey": "<secondary-key>",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}


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

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

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

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

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

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

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


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

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


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

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

package armiothub_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_addRoutingCosmosDBEndpoint.json
func ExampleResourceClient_BeginCreateOrUpdate_iotHubResourceAddCosmosDbEndpoint() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewResourceClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "testHub", armiothub.Description{
		Location: to.Ptr("centraluseuap"),
		Tags:     map[string]*string{},
		Etag:     to.Ptr("AAAAAAFD6M4="),
		Properties: &armiothub.Properties{
			CloudToDevice: &armiothub.CloudToDeviceProperties{
				DefaultTTLAsIso8601: to.Ptr("PT1H"),
				Feedback: &armiothub.FeedbackProperties{
					LockDurationAsIso8601: to.Ptr("PT1M"),
					MaxDeliveryCount:      to.Ptr[int32](10),
					TTLAsIso8601:          to.Ptr("PT1H"),
				},
				MaxDeliveryCount: to.Ptr[int32](10),
			},
			EnableDataResidency:           to.Ptr(false),
			EnableFileUploadNotifications: to.Ptr(false),
			EventHubEndpoints: map[string]*armiothub.EventHubProperties{
				"events": {
					PartitionCount:      to.Ptr[int32](2),
					RetentionTimeInDays: to.Ptr[int64](1),
				},
			},
			Features:      to.Ptr(armiothub.CapabilitiesNone),
			IPFilterRules: []*armiothub.IPFilterRule{},
			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
				"fileNotifications": {
					LockDurationAsIso8601: to.Ptr("PT1M"),
					MaxDeliveryCount:      to.Ptr[int32](10),
					TTLAsIso8601:          to.Ptr("PT1H"),
				},
			},
			MinTLSVersion: to.Ptr("1.2"),
			NetworkRuleSets: &armiothub.NetworkRuleSetProperties{
				ApplyToBuiltInEventHubEndpoint: to.Ptr(true),
				DefaultAction:                  to.Ptr(armiothub.DefaultActionDeny),
				IPRules: []*armiothub.NetworkRuleSetIPRule{
					{
						Action:     to.Ptr(armiothub.NetworkRuleIPActionAllow),
						FilterName: to.Ptr("rule1"),
						IPMask:     to.Ptr("131.117.159.53"),
					},
					{
						Action:     to.Ptr(armiothub.NetworkRuleIPActionAllow),
						FilterName: to.Ptr("rule2"),
						IPMask:     to.Ptr("157.55.59.128/25"),
					}},
			},
			Routing: &armiothub.RoutingProperties{
				Endpoints: &armiothub.RoutingEndpoints{
					CosmosDBSQLContainers: []*armiothub.RoutingCosmosDBSQLAPIProperties{
						{
							Name:                 to.Ptr("endpointcosmos"),
							AuthenticationType:   to.Ptr(armiothub.AuthenticationTypeKeyBased),
							ContainerName:        to.Ptr("test"),
							DatabaseName:         to.Ptr("systemstore"),
							EndpointURI:          to.Ptr("https://test-systemstore-test2.documents.azure.com"),
							PartitionKeyName:     to.Ptr("keystamped"),
							PartitionKeyTemplate: to.Ptr("{deviceid}-{YYYY}-{MM}"),
							PrimaryKey:           to.Ptr("<primary-key>"),
							ResourceGroup:        to.Ptr("rg-test"),
							SecondaryKey:         to.Ptr("<secondary-key>"),
							SubscriptionID:       to.Ptr("<subscription-id>"),
						}},
					EventHubs:         []*armiothub.RoutingEventHubProperties{},
					ServiceBusQueues:  []*armiothub.RoutingServiceBusQueueEndpointProperties{},
					ServiceBusTopics:  []*armiothub.RoutingServiceBusTopicEndpointProperties{},
					StorageContainers: []*armiothub.RoutingStorageContainerProperties{},
				},
				FallbackRoute: &armiothub.FallbackRouteProperties{
					Name:      to.Ptr("$fallback"),
					Condition: to.Ptr("true"),
					EndpointNames: []*string{
						to.Ptr("events")},
					IsEnabled: to.Ptr(true),
					Source:    to.Ptr(armiothub.RoutingSourceDeviceMessages),
				},
				Routes: []*armiothub.RouteProperties{},
			},
			StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
				"$default": {
					ConnectionString: to.Ptr(""),
					ContainerName:    to.Ptr(""),
					SasTTLAsIso8601:  to.Ptr("PT1H"),
				},
			},
		},
		SKU: &armiothub.SKUInfo{
			Name:     to.Ptr(armiothub.IotHubSKUS1),
			Capacity: to.Ptr[int64](1),
		},
	}, &armiothub.ResourceClientBeginCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Description = armiothub.Description{
	// 	Name: to.Ptr("testHub"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 	ID: to.Ptr("/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("AAAAAAFD6M4="),
	// 	Properties: &armiothub.Properties{
	// 		CloudToDevice: &armiothub.CloudToDeviceProperties{
	// 			DefaultTTLAsIso8601: to.Ptr("PT1H"),
	// 			Feedback: &armiothub.FeedbackProperties{
	// 				LockDurationAsIso8601: to.Ptr("PT1M"),
	// 				MaxDeliveryCount: to.Ptr[int32](10),
	// 				TTLAsIso8601: to.Ptr("PT1H"),
	// 			},
	// 			MaxDeliveryCount: to.Ptr[int32](10),
	// 		},
	// 		EnableDataResidency: to.Ptr(false),
	// 		EnableFileUploadNotifications: to.Ptr(false),
	// 		EventHubEndpoints: map[string]*armiothub.EventHubProperties{
	// 			"events": &armiothub.EventHubProperties{
	// 				Path: to.Ptr("iot-dps-cit-hub-1"),
	// 				Endpoint: to.Ptr("sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"),
	// 				PartitionCount: to.Ptr[int32](2),
	// 				PartitionIDs: []*string{
	// 					to.Ptr("0"),
	// 					to.Ptr("1")},
	// 					RetentionTimeInDays: to.Ptr[int64](1),
	// 				},
	// 			},
	// 			Features: to.Ptr(armiothub.CapabilitiesNone),
	// 			HostName: to.Ptr("iot-dps-cit-hub-1.azure-devices.net"),
	// 			IPFilterRules: []*armiothub.IPFilterRule{
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule1"),
	// 					IPMask: to.Ptr("131.117.159.53"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule2"),
	// 					IPMask: to.Ptr("157.55.59.128/25"),
	// 			}},
	// 			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
	// 				"fileNotifications": &armiothub.MessagingEndpointProperties{
	// 					LockDurationAsIso8601: to.Ptr("PT1M"),
	// 					MaxDeliveryCount: to.Ptr[int32](10),
	// 					TTLAsIso8601: to.Ptr("PT1H"),
	// 				},
	// 			},
	// 			MinTLSVersion: to.Ptr("1.2"),
	// 			NetworkRuleSets: &armiothub.NetworkRuleSetProperties{
	// 				ApplyToBuiltInEventHubEndpoint: to.Ptr(true),
	// 				DefaultAction: to.Ptr(armiothub.DefaultActionDeny),
	// 				IPRules: []*armiothub.NetworkRuleSetIPRule{
	// 					{
	// 						Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
	// 						FilterName: to.Ptr("rule1"),
	// 						IPMask: to.Ptr("131.117.159.53"),
	// 					},
	// 					{
	// 						Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
	// 						FilterName: to.Ptr("rule2"),
	// 						IPMask: to.Ptr("157.55.59.128/25"),
	// 				}},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			Routing: &armiothub.RoutingProperties{
	// 				Endpoints: &armiothub.RoutingEndpoints{
	// 					CosmosDBSQLContainers: []*armiothub.RoutingCosmosDBSQLAPIProperties{
	// 						{
	// 							Name: to.Ptr("endpointcosmos"),
	// 							AuthenticationType: to.Ptr(armiothub.AuthenticationTypeKeyBased),
	// 							ContainerName: to.Ptr("test"),
	// 							DatabaseName: to.Ptr("systemstore"),
	// 							EndpointURI: to.Ptr("https://test-systemstore-test2.documents.azure.com"),
	// 							ID: to.Ptr("009208fa-9cb7-4b90-bfbd-f40086e766c9"),
	// 							PartitionKeyName: to.Ptr("keystamped"),
	// 							PartitionKeyTemplate: to.Ptr("{deviceid}-{YYYY}-{MM}"),
	// 							ResourceGroup: to.Ptr("rg-test"),
	// 							SubscriptionID: to.Ptr("<subscription-id>"),
	// 					}},
	// 					EventHubs: []*armiothub.RoutingEventHubProperties{
	// 					},
	// 					ServiceBusQueues: []*armiothub.RoutingServiceBusQueueEndpointProperties{
	// 					},
	// 					ServiceBusTopics: []*armiothub.RoutingServiceBusTopicEndpointProperties{
	// 					},
	// 					StorageContainers: []*armiothub.RoutingStorageContainerProperties{
	// 					},
	// 				},
	// 				FallbackRoute: &armiothub.FallbackRouteProperties{
	// 					Name: to.Ptr("$fallback"),
	// 					Condition: to.Ptr("true"),
	// 					EndpointNames: []*string{
	// 						to.Ptr("events")},
	// 						IsEnabled: to.Ptr(true),
	// 						Source: to.Ptr(armiothub.RoutingSourceDeviceMessages),
	// 					},
	// 					Routes: []*armiothub.RouteProperties{
	// 					},
	// 				},
	// 				State: to.Ptr("Active"),
	// 				StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
	// 					"$default": &armiothub.StorageEndpointProperties{
	// 						ConnectionString: to.Ptr(""),
	// 						ContainerName: to.Ptr(""),
	// 						SasTTLAsIso8601: to.Ptr("PT1H"),
	// 					},
	// 				},
	// 			},
	// 			SKU: &armiothub.SKUInfo{
	// 				Name: to.Ptr(armiothub.IotHubSKUS1),
	// 				Capacity: to.Ptr[int64](1),
	// 				Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
	// 			},
	// 			SystemData: &armiothub.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:28:38.963Z"); return t}()),
	// 			},
	// 		}
}

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

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

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

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

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

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

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

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

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

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

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
IotHubDescriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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

Exemple de requête

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

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}


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

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

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

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

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

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

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


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

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


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

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

package armiothub_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

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

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

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

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

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

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
IotHubDescriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
AccessRights	Autorisations affectées à la stratégie d’accès partagé.
ArmIdentity
ArmUserIdentity
AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus
Capabilities	Fonctionnalités et fonctionnalités activées pour le hub IoT.
CloudToDeviceProperties	Propriétés de messagerie cloud-à-appareil ioT Hub.
createdByType	Type d’identité qui a créé la ressource.
DefaultAction	Action par défaut pour l’ensemble de règles réseau
EnrichmentProperties	Propriétés d’un enrichissement que votre hub IoT s’applique aux messages remis aux points de terminaison.
ErrorDetails	Détails de l’erreur.
EventHubProperties	Propriétés du point de terminaison compatible Event Hub provisionné utilisé par le hub IoT.
FallbackRouteProperties	Propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il route les messages vers le point de terminaison de secours.
FeedbackProperties	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.
IotHubDescription	Description du hub IoT.
IotHubLocationDescription	Représentation publique de l’un des emplacements où une ressource est provisionnée.
IotHubProperties	Propriétés d’un hub IoT.
IotHubReplicaRoleType	Le rôle de la région peut être principal ou secondaire. La région primaire est l’emplacement où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée de récupération d’urgence Azure et la région vers laquelle le hub IoT peut basculer.
IotHubSku	Nom de la référence SKU.
IotHubSkuInfo	Informations sur la référence SKU du hub IoT.
IotHubSkuTier	Niveau de facturation pour le hub IoT.
IpFilterActionType	Action souhaitée pour les demandes capturées par cette règle.
IpFilterRule	Règles de filtre IP pour le hub IoT.
ManagedIdentity	Propriétés de l’identité managée.
MessagingEndpointProperties	Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.
NetworkRuleIPAction	Action de filtre IP
NetworkRuleSetIpRule	Règle IP à appliquer dans le cadre de l’ensemble de règles réseau
NetworkRuleSetProperties	Propriétés de l’ensemble de règles réseau d’IotHub
PrivateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé
PrivateEndpointConnection	Connexion de point de terminaison privé d’un IotHub
PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé
PrivateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé
PrivateLinkServiceConnectionStatus	État d’une connexion de point de terminaison privé
PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
RouteProperties	Propriétés d’une règle de routage utilisée par votre hub IoT pour acheminer les messages vers des points de terminaison.
RoutingCosmosDBSqlApiProperties	Propriétés liées à un point de terminaison de conteneur sql cosmos DB.
RoutingEndpoints	Propriétés liées aux points de terminaison personnalisés auxquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.
RoutingEventHubProperties	Propriétés associées à un point de terminaison Event Hub.
RoutingProperties	Propriétés associées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Propriétés associées aux types de points de terminaison de file d’attente Service Bus.
RoutingServiceBusTopicEndpointProperties	Propriétés associées aux types de points de terminaison de rubrique Service Bus.
RoutingSource	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.
RoutingStorageContainerProperties	Propriétés associées à un point de terminaison de conteneur de stockage.
SharedAccessSignatureAuthorizationRule	Propriétés d’une stratégie d’accès partagé IoT Hub.
StorageEndpointProperties	Propriétés du point de terminaison stockage Azure pour le chargement de fichiers.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AccessRights

Énumération

Autorisations affectées à la stratégie d’accès partagé.

Valeur	Description
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ArmIdentity

Object

Nom	Type	Description
principalId	string	Principal Id
tenantId	string	ID de locataire
type	ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Object

Nom	Type	Description
clientId	string
principalId	string

AuthenticationType

Énumération

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

Valeur	Description
identityBased
keyBased

authenticationType

Énumération

Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus

Valeur	Description
identityBased
keyBased

Capabilities

Énumération

Fonctionnalités et fonctionnalités activées pour le hub IoT.

Valeur	Description
DeviceManagement
None

CloudToDeviceProperties

Object

Propriétés de messagerie cloud-à-appareil ioT Hub.

Nom	Type	Description
defaultTtlAsIso8601	string (duration)	Heure par défaut de vie des messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

DefaultAction

Énumération

Action par défaut pour l’ensemble de règles réseau

Valeur	Description
Allow
Deny

EnrichmentProperties

Object

Propriétés d’un enrichissement que votre hub IoT s’applique aux messages remis aux points de terminaison.

Nom	Type	Description
endpointNames	string[]	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.
key	string	Clé ou nom de la propriété d’enrichissement.
value	string	Valeur de la propriété d’enrichissement.

ErrorDetails

Object

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

EventHubProperties

Object

Propriétés du point de terminaison compatible Event Hub provisionné utilisé par le hub IoT.

Nom	Type	Description
endpoint	string	Point de terminaison compatible Event Hub.
partitionCount	integer (int32)	Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	ID de partition dans le point de terminaison compatible Event Hub.
path	string	Nom compatible Event Hub.
retentionTimeInDays	integer (int64)	Durée de rétention des messages appareil-à-cloud en jours. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Object

Propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il route les messages vers le point de terminaison de secours.

Nom	Type	Description
condition	string	Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle prend la valeur true par défaut. Pour plus d’informations sur la grammaire, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, seul 1 point de terminaison est autorisé.
isEnabled	boolean	Permet de spécifier si l’itinéraire de secours est activé.
name	string	Nom de l’itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.
source	RoutingSource	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages

FeedbackProperties

Object

Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.

Nom	Type	Description
lockDurationAsIso8601	string (duration)	Durée de verrouillage de la file d’attente de commentaires. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre de tentatives de remise d’un message sur la file d’attente de commentaires par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Object

Description du hub IoT.

Nom	Type	Description
etag	string	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.
id	string	Identificateur de ressource.
identity	ArmIdentity	Identités managées pour IotHub.
location	string	Emplacement de la ressource.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Nom de la ressource.
properties	IotHubProperties	Propriétés IotHub
sku	IotHubSkuInfo	Informations sur la référence SKU IotHub
systemData	systemData	Métadonnées système relatives à cette ressource.
tags	object	Balises de ressource.
type	string	Type de ressource.

IotHubLocationDescription

Object

Représentation publique de l’un des emplacements où une ressource est provisionnée.

Nom	Type	Description
location	string	Nom de la région Azure
role	IotHubReplicaRoleType	Le rôle de la région peut être principal ou secondaire. La région primaire est l’emplacement où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée de récupération d’urgence Azure et la région vers laquelle le hub IoT peut basculer.

IotHubProperties

Object

Propriétés d’un hub IoT.

Nom	Type	Description
allowedFqdnList	string[]	Liste des noms de domaine complets autorisés (nom de domaine complet) pour la sortie à partir d’Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.
cloudToDevice	CloudToDeviceProperties	Propriétés de messagerie cloud-à-appareil ioT Hub.
comments	string	Commentaires ioT Hub.
disableDeviceSAS	boolean	Si la valeur est true, tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisés pour l’authentification.
disableLocalAuth	boolean	Si la valeur est true, les jetons SAP avec des clés SAP étendues Iot hub ne peuvent pas être utilisés pour l’authentification.
disableModuleSAS	boolean	Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.
enableDataResidency	boolean	Cette propriété lorsqu’elle est définie sur true active la résidence des données, ce qui désactive la récupération d’urgence.
enableFileUploadNotifications	boolean	Si la valeur est True, les notifications de chargement de fichiers sont activées.
eventHubEndpoints	<string, EventHubProperties>	Propriétés de point de terminaison compatibles avec Event Hub. La seule clé possible pour ce dictionnaire est les événements. Cette clé doit être présente dans le dictionnaire tout en effectuant des appels de création ou de mise à jour pour le hub IoT.
features	Capabilities	Fonctionnalités et fonctionnalités activées pour le hub IoT.
hostName	string	Nom de l’hôte.
ipFilterRules	IpFilterRule[]	Règles de filtre IP.
locations	IotHubLocationDescription[]	Emplacement principal et secondaire pour iot Hub
messagingEndpoints	<string, MessagingEndpointProperties>	Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.
minTlsVersion	string	Spécifie la version TLS minimale à prendre en charge pour ce hub. Peut être défini sur « 1.2 » pour que les clients qui utilisent une version TLS inférieure à la version 1.2 soient rejetés.
networkRuleSets	NetworkRuleSetProperties	Propriétés de l’ensemble de règles réseau d’IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Connexions de point de terminaison privé créées sur cet IotHub
provisioningState	string	État d’approvisionnement.
publicNetworkAccess	PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
restrictOutboundNetworkAccess	boolean	Si la valeur est true, la sortie d’IotHub est limitée uniquement aux noms de domaine complets autorisés configurés via allowedFqdnList.
routing	RoutingProperties	Propriétés associées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	État du hub.
storageEndpoints	<string, StorageEndpointProperties>	Liste des points de terminaison stockage Azure où vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte stockage Azure et qui doit avoir sa clé comme $default. La spécification de plusieurs comptes de stockage provoque la levée d’une erreur. Si vous ne spécifiez pas de valeur pour cette propriété lorsque la propriété enableFileUploadNotifications a la valeur True, une erreur est générée.

IotHubReplicaRoleType

Énumération

Le rôle de la région peut être principal ou secondaire. La région primaire est l’emplacement où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée de récupération d’urgence Azure et la région vers laquelle le hub IoT peut basculer.

Valeur	Description
primary
secondary

IotHubSku

Énumération

Nom de la référence SKU.

Valeur	Description
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Object

Informations sur la référence SKU du hub IoT.

Nom	Type	Description
capacity	integer (int64)	Nombre d’unités IoT Hub approvisionnées. Voir : https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Nom de la référence SKU.
tier	IotHubSkuTier	Niveau de facturation pour le hub IoT.

IotHubSkuTier

Énumération

Niveau de facturation pour le hub IoT.

Valeur	Description
Basic
Free
Standard

IpFilterActionType

Énumération

Action souhaitée pour les demandes capturées par cette règle.

Valeur	Description
Accept
Reject

IpFilterRule

Object

Règles de filtre IP pour le hub IoT.

Nom	Type	Description
action	IpFilterActionType	Action souhaitée pour les demandes capturées par cette règle.
filterName	string	Nom de la règle de filtre IP.
ipMask	string	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

ManagedIdentity

Object

Propriétés de l’identité managée.

Nom	Type	Description
userAssignedIdentity	string	Identité affectée par l’utilisateur.

MessagingEndpointProperties

Object

Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.

Nom	Type	Description
lockDurationAsIso8601	string (duration)	Durée du verrou. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre de tentatives de remise d’un message par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Énumération

Action de filtre IP

Valeur	Description
Allow

NetworkRuleSetIpRule

Object

Règle IP à appliquer dans le cadre de l’ensemble de règles réseau

Nom	Type	Valeur par défaut	Description
action	NetworkRuleIPAction	Allow	Action de filtre IP
filterName	string		Nom de la règle de filtre IP.
ipMask	string		Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

NetworkRuleSetProperties

Object

Propriétés de l’ensemble de règles réseau d’IotHub

Nom	Type	Valeur par défaut	Description
applyToBuiltInEventHubEndpoint	boolean		Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub
defaultAction	DefaultAction	Deny	Action par défaut pour l’ensemble de règles réseau
ipRules	NetworkRuleSetIpRule[]		Liste des règles IP

PrivateEndpoint

Object

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

Nom	Type	Description
id	string	Identificateur de ressource.

PrivateEndpointConnection

Object

Connexion de point de terminaison privé d’un IotHub

Nom	Type	Description
id	string	Identificateur de ressource.
name	string	Nom de la ressource.
properties	PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé
type	string	Type de ressource.

PrivateEndpointConnectionProperties

Object

Propriétés d’une connexion de point de terminaison privé

Nom	Type	Description
privateEndpoint	PrivateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionState

Object

État actuel d’une connexion de point de terminaison privé

Nom	Type	Description
actionsRequired	string	Actions requises pour une connexion de point de terminaison privé
description	string	Description de l’état actuel d’une connexion de point de terminaison privé
status	PrivateLinkServiceConnectionStatus	État d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Énumération

État d’une connexion de point de terminaison privé

Valeur	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Énumération

Indique si les demandes du réseau public sont autorisées

Valeur	Description
Disabled
Enabled

ResourceIdentityType

Énumération

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Valeur	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Object

Propriétés d’une règle de routage utilisée par votre hub IoT pour acheminer les messages vers des points de terminaison.

Nom	Type	Description
condition	string	Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.
isEnabled	boolean	Permet de spécifier si un itinéraire est activé.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom de l’itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.
source	RoutingSource	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

RoutingCosmosDBSqlApiProperties

Object

Propriétés liées à un point de terminaison de conteneur sql cosmos DB.

Nom	Type	Description
authenticationType	authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de conteneur sql cosmos DB
containerName	string	Nom du conteneur sql cosmos DB dans la base de données Cosmos DB.
databaseName	string	Nom de la base de données cosmos DB dans le compte cosmos DB.
endpointUri	string (uri)	URL du compte cosmos DB. Il doit inclure le protocole https://
id	string	ID du point de terminaison de conteneur sql cosmos DB
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
partitionKeyName	string	Nom de la clé de partition associée à ce conteneur sql cosmos DB s’il en existe un. Il s’agit d’un paramètre facultatif.
partitionKeyTemplate	string	Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur sql cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Ce paramètre est obligatoire uniquement si PartitionKeyName est spécifié.
primaryKey	string	Clé primaire du compte Cosmos DB.
resourceGroup	string	Nom du groupe de ressources du compte cosmos DB.
secondaryKey	string	Clé secondaire du compte Cosmos DB.
subscriptionId	string	Identificateur d’abonnement du compte Cosmos DB.

RoutingEndpoints

Object

Propriétés liées aux points de terminaison personnalisés auxquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.

Nom	Type	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	La liste des points de terminaison de conteneur Cosmos DB vers utilisant IoT Hub achemine les messages en fonction des règles de routage.
eventHubs	RoutingEventHubProperties[]	Liste des points de terminaison Event Hubs auxquels IoT Hub achemine les messages en fonction des règles de routage. Cette liste n’inclut pas le point de terminaison Event Hubs intégré.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages en fonction des règles de routage.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Liste des points de terminaison de rubrique Service Bus auxquels le hub IoT achemine les messages en fonction des règles de routage.
storageContainers	RoutingStorageContainerProperties[]	Liste des points de terminaison de conteneur de stockage vers utilisant ioT Hub qui acheminent les messages en fonction des règles de routage.

RoutingEventHubProperties

Object

Propriétés associées à un point de terminaison Event Hub.

Nom	Type	Description
authenticationType	authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison event Hub
connectionString	string	Chaîne de connexion du point de terminaison event Hub.
endpointUri	string	URL du point de terminaison event Hub. Il doit inclure le protocole sb://
entityPath	string	Nom du hub d’événements sur l’espace de noms du hub d’événements
id	string	ID du point de terminaison du hub d’événements
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison event Hub de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
resourceGroup	string	Nom du groupe de ressources du point de terminaison event Hub.
subscriptionId	string	Identificateur d’abonnement du point de terminaison event Hub.

RoutingProperties

Object

Propriétés associées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Nom	Type	Description
endpoints	RoutingEndpoints	Propriétés liées aux points de terminaison personnalisés auxquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.
enrichments	EnrichmentProperties[]	Liste des enrichissements fournis par l’utilisateur que le hub IoT s’applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Consultez : https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Propriétés de l’itinéraire utilisé comme itinéraire de secours quand aucune des conditions spécifiées dans la section « routes » n’est remplie. Il s’agit d’un paramètre facultatif. Lorsque cette propriété n’est pas présente dans le modèle, l’itinéraire de secours est désactivé par défaut.
routes	RouteProperties[]	Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour router les messages vers des points de terminaison intégrés et personnalisés. Un maximum de 100 règles de routage sont autorisées pour les hubs payants et un maximum de 5 règles de routage sont autorisées pour les hubs gratuits.

RoutingServiceBusQueueEndpointProperties

Object

Propriétés associées aux types de points de terminaison de file d’attente Service Bus.

Nom	Type	Description
authenticationType	authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus
connectionString	string	Chaîne de connexion du point de terminaison de file d’attente Service Bus.
endpointUri	string	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://
entityPath	string	Nom de la file d’attente sur l’espace de noms Service Bus
id	string	ID du point de terminaison de file d’attente Service Bus
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de file d’attente réel.
resourceGroup	string	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.
subscriptionId	string	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.

RoutingServiceBusTopicEndpointProperties

Object

Propriétés associées aux types de points de terminaison de rubrique Service Bus.

Nom	Type	Description
authenticationType	authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de rubrique Service Bus
connectionString	string	Chaîne de connexion du point de terminaison de rubrique Service Bus.
endpointUri	string	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://
entityPath	string	Nom de la file d’attente dans la rubrique Service Bus
id	string	ID du point de terminaison de rubrique Service Bus
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de la rubrique réelle.
resourceGroup	string	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.
subscriptionId	string	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.

RoutingSource

Énumération

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

Valeur	Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Object

Propriétés associées à un point de terminaison de conteneur de stockage.

Nom	Type	Description
authenticationType	authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de stockage
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Intervalle de temps auquel les objets blob sont écrits dans le stockage. La valeur doit être comprise entre 60 et 720 secondes. La valeur par défaut est de 300 secondes.
connectionString	string	Chaîne de connexion du compte de stockage.
containerName	string	Nom du conteneur de stockage dans le compte de stockage.
encoding	enum: Avro AvroDeflate JSON	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».
endpointUri	string	URL du point de terminaison de stockage. Il doit inclure le protocole https://
fileNameFormat	string	Format de nom de fichier pour l’objet blob. Le format par défaut est {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tous les paramètres sont obligatoires, mais peuvent être réorganisé.
id	string	ID du point de terminaison du conteneur de stockage
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de stockage de routage.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Nombre maximal d’octets pour chaque objet blob écrit dans le stockage. La valeur doit être comprise entre 10485760(10 Mo) et 524288000(500 Mo). La valeur par défaut est 314572800(300 Mo).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
resourceGroup	string	Nom du groupe de ressources du compte de stockage.
subscriptionId	string	Identificateur d’abonnement du compte de stockage.

SharedAccessSignatureAuthorizationRule

Object

Propriétés d’une stratégie d’accès partagé IoT Hub.

Nom	Type	Description
keyName	string	Nom de la stratégie d’accès partagé.
primaryKey	string	Clé primaire.
rights	AccessRights	Autorisations affectées à la stratégie d’accès partagé.
secondaryKey	string	Clé secondaire.

StorageEndpointProperties

Object

Propriétés du point de terminaison stockage Azure pour le chargement de fichiers.

Nom	Type	Description
authenticationType	AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.
connectionString	string	Chaîne de connexion pour le compte stockage Azure vers lequel les fichiers sont chargés.
containerName	string	Nom du conteneur racine dans lequel vous chargez des fichiers. Le conteneur n’a pas besoin d’exister, mais doit être créatable à l’aide de connectionString spécifié.
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.
sasTtlAsIso8601	string (duration)	Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Iot Hub Resource - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

IotHubResource_AddCosmosDbEndpoint

Exemple de requête

Exemple de réponse

IotHubResource_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

AccessRights

ArmIdentity

ArmUserIdentity

AuthenticationType

authenticationType

Capabilities

CloudToDeviceProperties

createdByType

DefaultAction

EnrichmentProperties

ErrorDetails

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubDescription

IotHubLocationDescription

IotHubProperties

IotHubReplicaRoleType

IotHubSku

IotHubSkuInfo

IotHubSkuTier

IpFilterActionType

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

NetworkRuleIPAction

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

PublicNetworkAccess

ResourceIdentityType

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingSource

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

systemData

Ressources supplémentaires