Iot Hub Resource - Create Or Update

Reference

Služba:: IoT Hub

Verze rozhraní API:: 2023-06-30

Vytvořte nebo aktualizujte metadata centra IoT. Obvyklým způsobem úpravy vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování s upravenými hodnotami v novém textu za účelem aktualizace ioT Hubu. Pokud ve formátu JSON chybí některé vlastnosti, může aktualizace služby IoT Hub způsobit, že se tyto hodnoty převedou do výchozího stavu, což může vést k neočekávanému chování.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje centrum IoT.
resourceName	path	True	string	Název ioT Hubu.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	ETag ioT Hubu Nezadávejte pro vytvoření úplně nové služby IoT Hub. Vyžaduje se k aktualizaci existujícího IoT Hubu.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění prostředku.
sku	True	IotHubSkuInfo	Informace o skladové posílce IotHubu
etag		string	Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag.
identity		ArmIdentity	Spravované identity pro IotHub.
properties		IotHubProperties	Vlastnosti IotHubu
tags		object	Značky prostředků.

Odpovědi

Name	Typ	Description
200 OK	IotHubDescription	Vrátí se jako odpověď na žádost o dotazování stavu pro operaci vytvoření nebo aktualizace. Tělo obsahuje reprezentaci prostředků, která označuje přechodný stav zřizování.
201 Created	IotHubDescription	Jedná se o dlouhotrvající operaci. Operace vrátí hodnotu 201, pokud je ověření dokončeno. Odpověď obsahuje hlavičku Azure-AsyncOperation, která obsahuje adresu URL stavu. Očekává se, že klienti se budou dotazovat na adresu URL stavu operace. V případě úspěchu operace vrátí stavový kód HTTP 201 (OK).
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

IotHubResource_AddCosmosDbEndpoint

IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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"
  }
}

Definice

Name	Description
AccessRights	Oprávnění přiřazená k zásadám sdíleného přístupu.
ArmIdentity
ArmUserIdentity
AuthenticationType	Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
authenticationType	Metoda použitá k ověření vůči koncovému bodu fronty služby Service Bus
Capabilities	Možnosti a funkce povolené pro Centrum IoT.
CloudToDeviceProperties	Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub
createdByType	Typ identity, která prostředek vytvořila.
DefaultAction	Výchozí akce pro sadu pravidel sítě
EnrichmentProperties	Vlastnosti obohacení, které vaše centrum IoT používá pro zprávy doručované do koncových bodů.
ErrorDetails	Podrobnosti o chybě
EventHubProperties	Vlastnosti zřízeného koncového bodu kompatibilního s centrem událostí, který používá centrum IoT.
FallbackRouteProperties	Vlastnosti náhradní trasy. IoT Hub tyto vlastnosti používá při směrování zpráv do záložního koncového bodu.
FeedbackProperties	Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení
IotHubDescription	Popis centra IoT.
IotHubLocationDescription	Veřejná reprezentace jednoho z umístění, kde je prostředek zřízený.
IotHubProperties	Vlastnosti ioT Hubu.
IotHubReplicaRoleType	Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii Azure (DR) a také oblast, do které může centrum IoT provést převzetí služeb při selhání.
IotHubSku	Název skladové položky.
IotHubSkuInfo	Informace o skladové posílce ioT Hubu.
IotHubSkuTier	Úroveň fakturace pro Centrum IoT.
IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem.
IpFilterRule	Pravidla filtru IP adres pro centrum IoT.
ManagedIdentity	Vlastnosti spravované identity.
MessagingEndpointProperties	Vlastnosti koncových bodů zasílání zpráv, které používá toto centrum IoT.
NetworkRuleIPAction	Akce filtru IP adres
NetworkRuleSetIpRule	Pravidlo PROTOKOLU IP, které se má použít jako součást sady pravidel sítě
NetworkRuleSetProperties	Vlastnosti sady pravidel sítě iotHubu
PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
PrivateEndpointConnection	Připojení privátního koncového bodu IotHubu
PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu
PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
RouteProperties	Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.
RoutingCosmosDBSqlApiProperties	Vlastnosti související s koncovým bodem kontejneru SQL služby Cosmos DB.
RoutingEndpoints	Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placené rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod.
RoutingEventHubProperties	Vlastnosti související s koncovým bodem centra událostí.
RoutingProperties	Vlastnosti související se směrováním centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Vlastnosti související s typy koncových bodů fronty služby Service Bus.
RoutingServiceBusTopicEndpointProperties	Vlastnosti související s typy koncových bodů tématu služby Service Bus.
RoutingSource	Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.
RoutingStorageContainerProperties	Vlastnosti související s koncovým bodem kontejneru úložiště.
SharedAccessSignatureAuthorizationRule	Vlastnosti zásad sdíleného přístupu služby IoT Hub.
StorageEndpointProperties	Vlastnosti koncového bodu služby Azure Storage pro nahrání souboru.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AccessRights

Výčet

Oprávnění přiřazená k zásadám sdíleného přístupu.

Hodnota	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

Objekt

Name	Typ	Description
principalId	string	ID objektu zabezpečení
tenantId	string	ID tenanta
type	ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Objekt

Name	Typ	Description
clientId	string
principalId	string

AuthenticationType

Výčet

Určuje typ ověřování, který se používá pro připojení k účtu úložiště.

Hodnota	Description
identityBased
keyBased

authenticationType

Výčet

Metoda použitá k ověření vůči koncovému bodu fronty služby Service Bus

Hodnota	Description
identityBased
keyBased

Capabilities

Výčet

Možnosti a funkce povolené pro Centrum IoT.

Hodnota	Description
DeviceManagement
None

CloudToDeviceProperties

Objekt

Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub

Name	Typ	Description
defaultTtlAsIso8601	string (duration)	Výchozí doba pro živé zprávy typu cloud-zařízení ve frontě zařízení. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Maximální počet doručení zpráv typu cloud-zařízení ve frontě zařízení. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

DefaultAction

Výčet

Výchozí akce pro sadu pravidel sítě

Hodnota	Description
Allow
Deny

EnrichmentProperties

Objekt

Vlastnosti obohacení, které vaše centrum IoT používá pro zprávy doručované do koncových bodů.

Name	Typ	Description
endpointNames	string[]	Seznamkoncovýchch
key	string	Klíč nebo název vlastnosti rozšiřování.
value	string	Hodnota vlastnosti rozšiřování.

ErrorDetails

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Kód chyby.
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP.
message	string	Chybová zpráva.

EventHubProperties

Objekt

Vlastnosti zřízeného koncového bodu kompatibilního s centrem událostí, který používá centrum IoT.

Name	Typ	Description
endpoint	string	Koncový bod kompatibilní s centrem událostí.
partitionCount	integer (int32)	Počet oddílů pro příjem zpráv typu zařízení-cloud v koncovém bodu kompatibilním s centrem událostí. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	ID oddílů v koncovém bodu kompatibilním s centrem událostí.
path	string	Název kompatibilní s centrem událostí.
retentionTimeInDays	integer (int64)	Doba uchovávání zpráv typu zařízení-cloud ve dnech. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Objekt

Vlastnosti náhradní trasy. IoT Hub tyto vlastnosti používá při směrování zpráv do záložního koncového bodu.

Name	Typ	Description
condition	string	Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není za předpokladu, že se ve výchozím nastavení vyhodnotí jako true. Gramatika: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Seznam koncových bodů, do kterých jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod.
isEnabled	boolean	Slouží k určení, jestli je povolená náhradní trasa.
name	string	Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný.
source	RoutingSource	Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages

FeedbackProperties

Objekt

Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení

Name	Typ	Description
lockDurationAsIso8601	string (duration)	Doba trvání uzamčení fronty zpětné vazby. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Objekt

Popis centra IoT.

Name	Typ	Description
etag	string	Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag.
id	string	Identifikátor prostředku.
identity	ArmIdentity	Spravované identity pro IotHub.
location	string	Umístění prostředku.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Název prostředku.
properties	IotHubProperties	Vlastnosti IotHubu
sku	IotHubSkuInfo	Informace o skladové posílce IotHubu
systemData	systemData	Systémová meta data týkající se tohoto prostředku.
tags	object	Značky prostředků.
type	string	Typ prostředku.

IotHubLocationDescription

Objekt

Veřejná reprezentace jednoho z umístění, kde je prostředek zřízený.

Name	Typ	Description
location	string	Název oblasti Azure
role	IotHubReplicaRoleType	Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii Azure (DR) a také oblast, do které může centrum IoT provést převzetí služeb při selhání.

IotHubProperties

Objekt

Vlastnosti ioT Hubu.

Name	Typ	Description
allowedFqdnList	string[]	Seznam povolených plně kvalifikovaných názvů domén (plně kvalifikovaný název domény) pro výchozí přenos dat ze služby Iot Hub
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení k centru IoT.
cloudToDevice	CloudToDeviceProperties	Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub
comments	string	Komentáře ke službě IoT Hub
disableDeviceSAS	boolean	Pokud je hodnota true, všechna zařízení (včetně zařízení Edge, ale s výjimkou modulů) s vymezeným oborem SAS se nedají použít k ověřování.
disableLocalAuth	boolean	Pokud je pravda, tokeny SAS s klíči SAS s vymezeným oborem služby Iot Hub se nedají použít k ověřování.
disableModuleSAS	boolean	Pokud je pravda, nelze pro ověřování použít všechny klíče SAS s vymezeným oborem modulu.
enableDataResidency	boolean	Tato vlastnost při nastavení na hodnotu true povolí rezidenci dat, a tím zakáže zotavení po havárii.
enableFileUploadNotifications	boolean	Pokud je true, oznámení o nahrání souboru jsou povolená.
eventHubEndpoints	<string, EventHubProperties>	Vlastnosti koncového bodu kompatibilního s centrem událostí. Jediným možnými klíči tohoto slovníku jsou události. Tento klíč musí být ve slovníku k dispozici při vytváření nebo aktualizaci volání ioT Hubu.
features	Capabilities	Možnosti a funkce povolené pro Centrum IoT.
hostName	string	Název hostitele.
ipFilterRules	IpFilterRule[]	Pravidla filtru IP adres.
locations	IotHubLocationDescription[]	Primární a sekundární umístění pro iot Hub
messagingEndpoints	<string, MessagingEndpointProperties>	Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení pro nahrání souboru.
minTlsVersion	string	Určuje minimální verzi protokolu TLS, která se má pro toto centrum podporovat. Můžete nastavit na 1.2, aby klienti, kteří používají protokol TLS verze nižší než 1.2, mohli odmítnout.
networkRuleSets	NetworkRuleSetProperties	Vlastnosti sady pravidel sítě iotHubu
privateEndpointConnections	PrivateEndpointConnection[]	Připojení privátního koncového bodu vytvořená na tomto IotHubu
provisioningState	string	Stav zřizování.
publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
restrictOutboundNetworkAccess	boolean	Pokud ano, výchozí přenos dat z IotHubu se omezí jenom na povolené plně kvalifikované názvy domén nakonfigurované přes allowedFqdnList.
routing	RoutingProperties	Vlastnosti související se směrováním centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Stav centra.
storageEndpoints	<string, StorageEndpointProperties>	Seznam koncových bodů služby Azure Storage, kde můžete nahrávat soubory. V současné době můžete nakonfigurovat jenom jeden účet Azure Storage a tento klíč musí mít jako $default. Zadání více než jednoho účtu úložiště způsobí vyvolání chyby. Nezadávejte hodnotu pro tuto vlastnost, pokud je vlastnost enableFileUploadNotifications nastavena na Hodnotu True, způsobí vyvolání chyby.

IotHubReplicaRoleType

Výčet

Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii Azure (DR) a také oblast, do které může centrum IoT provést převzetí služeb při selhání.

Hodnota	Description
primary
secondary

IotHubSku

Výčet

Název skladové položky.

Hodnota	Description
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Objekt

Informace o skladové posílce ioT Hubu.

Name	Typ	Description
capacity	integer (int64)	Počet zřízených jednotek IoT Hubu. Viz: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Název skladové položky.
tier	IotHubSkuTier	Úroveň fakturace pro Centrum IoT.

IotHubSkuTier

Výčet

Úroveň fakturace pro Centrum IoT.

Hodnota	Description
Basic
Free
Standard

IpFilterActionType

Výčet

Požadovaná akce pro požadavky zachycené tímto pravidlem.

Hodnota	Description
Accept
Reject

IpFilterRule

Objekt

Pravidla filtru IP adres pro centrum IoT.

Name	Typ	Description
action	IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem.
filterName	string	Název pravidla filtru IP adres.
ipMask	string	Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla.

ManagedIdentity

Objekt

Vlastnosti spravované identity.

Name	Typ	Description
userAssignedIdentity	string	Identita přiřazená uživatelem.

MessagingEndpointProperties

Objekt

Vlastnosti koncových bodů zasílání zpráv, které používá toto centrum IoT.

Name	Typ	Description
lockDurationAsIso8601	string (duration)	Doba trvání zámku. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Počet pokusů o doručení zprávy službou IoT Hub Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Výčet

Akce filtru IP adres

Hodnota	Description
Allow

NetworkRuleSetIpRule

Objekt

Pravidlo PROTOKOLU IP, které se má použít jako součást sady pravidel sítě

Name	Typ	Default value	Description
action	NetworkRuleIPAction	Allow	Akce filtru IP adres
filterName	string		Název pravidla filtru IP adres.
ipMask	string		Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla.

NetworkRuleSetProperties

Objekt

Vlastnosti sady pravidel sítě iotHubu

Name	Typ	Default value	Description
applyToBuiltInEventHubEndpoint	boolean		Pokud je hodnota True, použije se sada pravidel sítě také u koncového bodu BuiltIn EventHubu iotHubu.
defaultAction	DefaultAction	Deny	Výchozí akce pro sadu pravidel sítě
ipRules	NetworkRuleSetIpRule[]		Seznam pravidel PROTOKOLU IP

PrivateEndpoint

Objekt

Vlastnost privátního koncového bodu připojení privátního koncového bodu

Name	Typ	Description
id	string	Identifikátor prostředku.

PrivateEndpointConnection

Objekt

Připojení privátního koncového bodu IotHubu

Name	Typ	Description
id	string	Identifikátor prostředku.
name	string	Název prostředku.
properties	PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
type	string	Typ prostředku.

PrivateEndpointConnectionProperties

Objekt

Vlastnosti připojení privátního koncového bodu

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu

PrivateLinkServiceConnectionState

Objekt

Aktuální stav připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Akce vyžadované pro připojení privátního koncového bodu
description	string	Popis aktuálního stavu připojení privátního koncového bodu
status	PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu

PrivateLinkServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu

Hodnota	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Výčet

Jestli jsou povolené požadavky z veřejné sítě

Hodnota	Description
Disabled
Enabled

ResourceIdentityType

Výčet

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.

Hodnota	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Objekt

Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.

Name	Typ	Description
condition	string	Podmínka, která se vyhodnotí jako použití pravidla směrování. Pokud není zadanou podmínkou, vyhodnotí se ve výchozím nastavení jako true. Gramatiku najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Seznam koncových bodů, do kterých se směrují zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod.
isEnabled	boolean	Slouží k určení, jestli je povolená trasa.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný.
source	RoutingSource	Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.

RoutingCosmosDBSqlApiProperties

Objekt

Vlastnosti související s koncovým bodem kontejneru SQL služby Cosmos DB.

Name	Typ	Description
authenticationType	authenticationType	Metoda použitá k ověření v koncovém bodu kontejneru SQL služby Cosmos DB
containerName	string	Název kontejneru SQL cosmos DB v databázi cosmos DB.
databaseName	string	Název databáze cosmos DB v účtu cosmos DB.
endpointUri	string (uri)	Adresa URL účtu cosmos DB. Musí obsahovat protokol https://
id	string	ID koncového bodu kontejneru SQL služby Cosmos DB
identity	ManagedIdentity	Vlastnosti spravované identity směrování koncového bodu kontejneru cosmos DB
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a maximální délku 64 znaků. Následující názvy jsou vyhrazené: události, fileNotifications, $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné.
partitionKeyName	string	Název klíče oddílu přidruženého k tomuto kontejneru SQL cosmos DB, pokud existuje. Jedná se o volitelný parametr.
partitionKeyTemplate	string	Šablona pro generování hodnoty syntetického klíče oddílu pro použití s tímto kontejnerem SQL služby Cosmos DB. Šablona musí obsahovat alespoň jeden z následujících zástupných symbolů: {iothub}, {deviceid}, {DD}, {MM} a {YYYY}. Všechny zástupné symboly mohou být zadány najednou, ale pořadí a neschybné součásti jsou libovolné. Tento parametr se vyžaduje pouze v případě, že je zadaný název PartitionKeyName.
primaryKey	string	Primární klíč účtu cosmos DB.
resourceGroup	string	Název skupiny prostředků účtu cosmos DB.
secondaryKey	string	Sekundární klíč účtu cosmos DB.
subscriptionId	string	Identifikátor předplatného účtu cosmos DB.

RoutingEndpoints

Objekt

Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placené rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod.

Name	Typ	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Seznam koncových bodů kontejneru Cosmos DB, do které IoT Hub směruje zprávy na základě pravidel směrování.
eventHubs	RoutingEventHubProperties[]	Seznam koncových bodů služby Event Hubs, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. Tento seznam neobsahuje integrovaný koncový bod služby Event Hubs.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Seznam koncových bodů fronty služby Service Bus, do které Služba IoT Hub směruje zprávy na základě pravidel směrování.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Seznam koncových bodů tématu služby Service Bus, do které centrum IoT směruje zprávy na základě pravidel směrování.
storageContainers	RoutingStorageContainerProperties[]	Seznam koncovýchbodůch

RoutingEventHubProperties

Objekt

Vlastnosti související s koncovým bodem centra událostí.

Name	Typ	Description
authenticationType	authenticationType	Metoda použitá k ověření v koncovém bodu centra událostí
connectionString	string	Připojovací řetězec koncového bodu centra událostí.
endpointUri	string	Adresa URL koncového bodu centra událostí. Musí obsahovat protokol sb://
entityPath	string	Název centra událostí v oboru názvů centra událostí
id	string	ID koncového bodu centra událostí
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu centra událostí směrování
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a maximální délku 64 znaků. Následující názvy jsou vyhrazené: události, fileNotifications, $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné.
resourceGroup	string	Název skupiny prostředků koncového bodu centra událostí.
subscriptionId	string	Identifikátor odběru koncového bodu centra událostí.

RoutingProperties

Objekt

Vlastnosti související se směrováním centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Typ	Description
endpoints	RoutingEndpoints	Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placené rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod.
enrichments	EnrichmentProperties[]	Seznam rozšíření poskytovaných uživatelem, které centrum IoT používá pro zprávy, které se mají doručovat do integrovaných a vlastních koncových bodů. Viz: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Vlastnosti trasy, která se používá jako náhradní trasa, pokud nejsou splněny žádné podmínky zadané v části trasy. Jedná se o volitelný parametr. Pokud tato vlastnost není v šabloně k dispozici, náhradní trasa je ve výchozím nastavení zakázaná.
routes	RouteProperties[]	Seznam pravidel směrování poskytovaných uživatelem, která ioT Hub používá ke směrování zpráv do předdefinovaných a vlastních koncových bodů. Pro placené rozbočovače je povoleno maximálně 100 pravidel směrování a pro bezplatná centra jsou povolená maximálně 5 pravidel směrování.

RoutingServiceBusQueueEndpointProperties

Objekt

Vlastnosti související s typy koncových bodů fronty služby Service Bus.

Name	Typ	Description
authenticationType	authenticationType	Metoda použitá k ověření vůči koncovému bodu fronty služby Service Bus
connectionString	string	Připojovací řetězec koncového bodu fronty služby Service Bus.
endpointUri	string	Adresa URL koncového bodu fronty služby Service Bus. Musí obsahovat protokol sb://
entityPath	string	Název fronty v oboru názvů služby Service Bus
id	string	ID koncového bodu fronty služby Service Bus
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu fronty služby Service Bus
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a maximální délku 64 znaků. Následující názvy jsou vyhrazené: události, fileNotifications, $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné. Název nemusí být stejný jako skutečný název fronty.
resourceGroup	string	Název skupiny prostředků koncového bodu fronty služby Service Bus.
subscriptionId	string	Identifikátor předplatného koncového bodu fronty služby Service Bus.

RoutingServiceBusTopicEndpointProperties

Objekt

Vlastnosti související s typy koncových bodů tématu služby Service Bus.

Name	Typ	Description
authenticationType	authenticationType	Metoda použitá k ověření v koncovém bodu tématu služby Service Bus
connectionString	string	Připojovací řetězec koncového bodu tématu služby Service Bus.
endpointUri	string	Adresa URL koncového bodu tématu služby Service Bus. Musí obsahovat protokol sb://
entityPath	string	Název fronty v tématu služby Service Bus
id	string	ID koncového bodu tématu služby Service Bus
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu tématu služby Service Bus směrování
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a maximální délku 64 znaků. Následující názvy jsou vyhrazené: události, fileNotifications, $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné. Název nemusí být stejný jako skutečný název tématu.
resourceGroup	string	Název skupiny prostředků koncového bodu tématu služby Service Bus.
subscriptionId	string	Identifikátor předplatného koncového bodu tématu služby Service Bus.

RoutingSource

Výčet

Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.

Hodnota	Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Objekt

Vlastnosti související s koncovým bodem kontejneru úložiště.

Name	Typ	Description
authenticationType	authenticationType	Metoda použitá k ověření v koncovém bodu úložiště
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Časový interval, ve kterém se objekty blob zapisují do úložiště. Hodnota by měla být v rozmezí 60 až 720 sekund. Výchozí hodnota je 300 sekund.
connectionString	string	Připojovací řetězec účtu úložiště.
containerName	string	Název kontejneru úložiště v účtu úložiště.
encoding	enum: Avro AvroDeflate JSON	Kódování, které se používá k serializaci zpráv do objektů blob. Podporované hodnoty jsou avro, avrodeflate a JSON. Výchozí hodnota je avro.
endpointUri	string	Adresa URL koncového bodu úložiště. Musí obsahovat protokol https://
fileNameFormat	string	Formát názvu souboru objektu blob. Výchozí formát je {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}. Všechny parametry jsou povinné, ale dají se změnit jejich pořadí.
id	string	ID koncového bodu kontejneru úložiště
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu úložiště směrování
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Maximální počet bajtů pro každý objekt blob zapsaný do úložiště Hodnota by měla být mezi 10485760(10 MB) a 524288000(500 MB). Výchozí hodnota je 314572800(300 MB).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a maximální délku 64 znaků. Následující názvy jsou vyhrazené: události, fileNotifications, $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné.
resourceGroup	string	Název skupiny prostředků účtu úložiště.
subscriptionId	string	Identifikátor předplatného účtu úložiště.

SharedAccessSignatureAuthorizationRule

Objekt

Vlastnosti zásad sdíleného přístupu služby IoT Hub.

Name	Typ	Description
keyName	string	Název zásady sdíleného přístupu.
primaryKey	string	Primární klíč.
rights	AccessRights	Oprávnění přiřazená k zásadám sdíleného přístupu.
secondaryKey	string	Sekundární klíč.

StorageEndpointProperties

Objekt

Vlastnosti koncového bodu služby Azure Storage pro nahrání souboru.

Name	Typ	Description
authenticationType	AuthenticationType	Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
connectionString	string	Připojovací řetězec pro účet služby Azure Storage, do kterého se soubory nahrají.
containerName	string	Název kořenového kontejneru, do kterého nahráváte soubory. Kontejner nemusí existovat, ale měl by být creatable pomocí zadaného připojovacího řetězce.
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu úložiště pro nahrání souboru
sasTtlAsIso8601	string (duration)	Doba, po kterou je identifikátor URI SAS vygenerovaný službou IoT Hub pro nahrání souboru platný. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Iot Hub Resource - Create Or Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

IotHubResource_AddCosmosDbEndpoint

Ukázkový požadavek

Ukázková odpověď

IotHubResource_CreateOrUpdate

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály