Iot Hub Resource - Get

Referenz

Dienst:: IoT Hub

API-Version:: 2023-06-30

Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT-Hubs ab.

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

URI-Parameter

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

Antworten

Name	Typ	Beschreibung
200 OK	IotHubDescription	Der Text enthält alle nicht sicherheitsrelevanten Eigenschaften des IoT-Hubs. Sicherheitsbezogene Eigenschaften werden auf NULL festgelegt.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

IotHubResource_Get

Beispielanforderung

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


/**
 * Samples for IotHubResource GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.json
     */
    /**
     * Sample code: IotHubResource_Get.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceGet(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().getByResourceGroupWithResponse("myResourceGroup", "testHub",
            com.azure.core.util.Context.NONE);
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_get.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.get(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.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/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_get.json
func ExampleResourceClient_Get() {
	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)
	}
	res, err := clientFactory.NewResourceClient().Get(ctx, "myResourceGroup", "testHub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("AAAAAAFD6M4="),
	// 	Properties: &armiothub.Properties{
	// 		CloudToDevice: &armiothub.CloudToDeviceProperties{
	// 			DefaultTTLAsIso8601: to.Ptr("PT1H"),
	// 			Feedback: &armiothub.FeedbackProperties{
	// 				LockDurationAsIso8601: to.Ptr("PT1M"),
	// 				MaxDeliveryCount: to.Ptr[int32](10),
	// 				TTLAsIso8601: to.Ptr("PT1H"),
	// 			},
	// 			MaxDeliveryCount: to.Ptr[int32](10),
	// 		},
	// 		EnableFileUploadNotifications: to.Ptr(false),
	// 		EventHubEndpoints: map[string]*armiothub.EventHubProperties{
	// 			"events": &armiothub.EventHubProperties{
	// 				Path: to.Ptr("iot-dps-cit-hub-1"),
	// 				Endpoint: to.Ptr("sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"),
	// 				PartitionCount: to.Ptr[int32](2),
	// 				PartitionIDs: []*string{
	// 					to.Ptr("0"),
	// 					to.Ptr("1")},
	// 					RetentionTimeInDays: to.Ptr[int64](1),
	// 				},
	// 			},
	// 			Features: to.Ptr(armiothub.CapabilitiesNone),
	// 			HostName: to.Ptr("iot-dps-cit-hub-1.azure-devices.net"),
	// 			IPFilterRules: []*armiothub.IPFilterRule{
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule1"),
	// 					IPMask: to.Ptr("131.117.159.53"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule2"),
	// 					IPMask: to.Ptr("157.55.59.128/25"),
	// 			}},
	// 			Locations: []*armiothub.LocationDescription{
	// 				{
	// 					Location: to.Ptr("West US"),
	// 					Role: to.Ptr(armiothub.IotHubReplicaRoleTypePrimary),
	// 				},
	// 				{
	// 					Location: to.Ptr("East US"),
	// 					Role: to.Ptr(armiothub.IotHubReplicaRoleTypeSecondary),
	// 			}},
	// 			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{
	// 					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 Get the non-security related metadata of an IoT hub.
 *
 * @summary Get the non-security related metadata of an IoT hub.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.json
 */
async function iotHubResourceGet() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.get(resourceGroupName, resourceName);
  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_get.json
// this example is just showing the usage of "IotHubResource_Get" 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";
NullableResponse<IotHubDescriptionResource> response = await collection.GetIfExistsAsync(resourceName);
IotHubDescriptionResource result = response.HasValue ? response.Value : null;

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

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "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",
    "locations": [
      {
        "location": "West US",
        "role": "primary"
      },
      {
        "location": "East US",
        "role": "secondary"
      }
    ],
    "minTlsVersion": "1.2"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definitionen

Name	Beschreibung
AccessRights	Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.
ArmIdentity
ArmUserIdentity
AuthenticationType	Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird.
authenticationType	Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange
Capabilities	Die Funktionen und Features, die für den IoT-Hub aktiviert sind.
CloudToDeviceProperties	Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultAction	Standardaktion für netzwerkregelsatz
EnrichmentProperties	Die Eigenschaften einer Anreicherung, die Ihr IoT-Hub auf Nachrichten an Endpunkte anwendet.
ErrorDetails	Fehlerdetails.
EventHubProperties	Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT-Hub verwendet wird.
FallbackRouteProperties	Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn nachrichten an den Fallbackendpunkt weitergeleitet werden.
FeedbackProperties	Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten.
IotHubDescription	Die Beschreibung des IoT-Hubs.
IotHubLocationDescription	Öffentliche Darstellung eines der Speicherorte, an denen eine Ressource bereitgestellt wird.
IotHubProperties	Die Eigenschaften eines IoT-Hubs.
IotHubReplicaRoleType	Die Rolle der Region kann entweder primär oder sekundär sein. Die primäre Region ist der Ort, an dem der IoT-Hub derzeit bereitgestellt wird. Die sekundäre Region ist die mit Azure Disaster Recovery (DR) gekoppelte Region und auch die Region, in der der IoT-Hub Failover ausführen kann.
IotHubSku	Der Name der SKU.
IotHubSkuInfo	Informationen zur SKU des IoT-Hubs.
IotHubSkuTier	Die Abrechnungsstufe für den IoT-Hub.
IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
IpFilterRule	Die IP-Filterregeln für den IoT-Hub.
ManagedIdentity	Die Eigenschaften der verwalteten Identität.
MessagingEndpointProperties	Die Eigenschaften der von diesem IoT-Hub verwendeten Messaging-Endpunkte.
NetworkRuleIPAction	IP-Filteraktion
NetworkRuleSetIpRule	IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll
NetworkRuleSetProperties	Netzwerkregelsatzeigenschaften von IotHub
PrivateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung
PrivateEndpointConnection	Die private Endpunktverbindung eines IotHub
PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
PrivateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung
PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung
PublicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
RouteProperties	Die Eigenschaften einer Routingregel, die Ihr IoT-Hub zum Weiterleiten von Nachrichten an Endpunkte verwendet.
RoutingCosmosDBSqlApiProperties	Die Eigenschaften im Zusammenhang mit einem Cosmos DB SQL-Containerendpunkt.
RoutingEndpoints	Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT-Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur 1 benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig.
RoutingEventHubProperties	Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.
RoutingProperties	Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Die Eigenschaften im Zusammenhang mit Dienstenbus-Warteschlangenendpunkttypen.
RoutingServiceBusTopicEndpointProperties	Die Eigenschaften im Zusammenhang mit Dienstenbus-Themenendpunkttypen.
RoutingSource	Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.
RoutingStorageContainerProperties	Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.
SharedAccessSignatureAuthorizationRule	Die Eigenschaften einer IoT-Hub-Richtlinie für den freigegebenen Zugriff.
StorageEndpointProperties	Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRights

Enumeration

Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.

Wert	Beschreibung
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	Beschreibung
principalId	string	Prinzipal-ID
tenantId	string	Mandanten-ID
type	ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Objekt

Name	Typ	Beschreibung
clientId	string
principalId	string

AuthenticationType

Enumeration

Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird.

Wert	Beschreibung
identityBased
keyBased

authenticationType

Enumeration

Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange

Wert	Beschreibung
identityBased
keyBased

Capabilities

Enumeration

Die Funktionen und Features, die für den IoT-Hub aktiviert sind.

Wert	Beschreibung
DeviceManagement
None

CloudToDeviceProperties

Objekt

Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften.

Name	Typ	Beschreibung
defaultTtlAsIso8601	string (duration)	Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Die maximale Anzahl der Zustellungen für Nachrichten in der Cloud-zu-Gerät in der Gerätewarteschlange. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DefaultAction

Enumeration

Standardaktion für netzwerkregelsatz

Wert	Beschreibung
Allow
Deny

EnrichmentProperties

Objekt

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

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

ErrorDetails

Objekt

Fehlerdetails.

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

EventHubProperties

Objekt

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

Name	Typ	Beschreibung
endpoint	string	Der event Hub-kompatible Endpunkt.
partitionCount	integer (int32)	Die Anzahl der Partitionen für den Empfang von Geräte-zu-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Die Partitions-IDs im Event Hub-kompatiblen Endpunkt.
path	string	Der ereignishubkompatible Name.
retentionTimeInDays	integer (int64)	Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Objekt

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

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

FeedbackProperties

Objekt

Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten.

Name	Typ	Beschreibung
lockDurationAsIso8601	string (duration)	Die Sperrdauer für die Feedbackwarteschlange. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Objekt

Die Beschreibung des IoT-Hubs.

Name	Typ	Beschreibung
etag	string	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.
id	string	Der Ressourcenbezeichner.
identity	ArmIdentity	Die verwalteten Identitäten für IotHub.
location	string	Der Ressourcenspeicherort.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Der Ressourcenname.
properties	IotHubProperties	IotHub-Eigenschaften
sku	IotHubSkuInfo	IotHub-SKU-Informationen
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

IotHubLocationDescription

Objekt

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

Name	Typ	Beschreibung
location	string	Der Name der Azure-Region
role	IotHubReplicaRoleType	Die Rolle der Region kann entweder primär oder sekundär sein. Die primäre Region ist der Ort, an dem der IoT-Hub derzeit bereitgestellt wird. Die sekundäre Region ist die mit Azure Disaster Recovery (DR) gekoppelte Region und auch die Region, in der der IoT-Hub Failover ausführen kann.

IotHubProperties

Objekt

Die Eigenschaften eines IoT-Hubs.

Name	Typ	Beschreibung
allowedFqdnList	string[]	Liste der zulässigen FQDNs(Vollqualifizierter Domänenname) für den Ausgang von Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Die Richtlinien für den freigegebenen Zugriff, die Sie verwenden können, um eine Verbindung mit dem IoT-Hub zu sichern.
cloudToDevice	CloudToDeviceProperties	Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften.
comments	string	IoT-Hubkommentare.
disableDeviceSAS	boolean	Bei "true" können alle Geräte(einschließlich Edgegeräte, jedoch ohne Module) für die Authentifizierung nicht für die Authentifizierung verwendet werden.
disableLocalAuth	boolean	Wenn wahr, können SAS-Token mit Iot-Hub-bezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden.
disableModuleSAS	boolean	Bei "true" können alle sas-Schlüssel mit Modulbereich nicht für die Authentifizierung verwendet werden.
enableDataResidency	boolean	Wenn diese Eigenschaft auf "true" festgelegt ist, wird die Datenaufbewahrung aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird.
enableFileUploadNotifications	boolean	Bei "True" sind Dateiuploadbenachrichtigungen aktiviert.
eventHubEndpoints	<string, EventHubProperties>	Die Ereignishub-kompatiblen Endpunkteigenschaften. Die einzigen möglichen Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Aufrufe für den IoT-Hub erstellt oder aktualisiert werden.
features	Capabilities	Die Funktionen und Features, die für den IoT-Hub aktiviert sind.
hostName	string	Der Name des Hosts.
ipFilterRules	IpFilterRule[]	Die IP-Filterregeln.
locations	IotHubLocationDescription[]	Primärer und sekundärer Standort für iot Hub
messagingEndpoints	<string, MessagingEndpointProperties>	Die Messaging-Endpunkteigenschaften für die Benachrichtigungswarteschlange für den Dateiupload.
minTlsVersion	string	Gibt die mindeste TLS-Version an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden.
networkRuleSets	NetworkRuleSetProperties	Netzwerkregelsatzeigenschaften von IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden
provisioningState	string	Der Bereitstellungsstatus.
publicNetworkAccess	PublicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
restrictOutboundNetworkAccess	boolean	Wenn "true", wird der Ausgang von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert sind.
routing	RoutingProperties	Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Der Hubstatus.
storageEndpoints	<string, StorageEndpointProperties>	Die Liste der Azure Storage-Endpunkte, in die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren und den Schlüssel als $default haben. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn die Eigenschaft "enableFileUploadNotifications" nicht auf "True" festgelegt ist, wird ein Fehler ausgelöst.

IotHubReplicaRoleType

Enumeration

Die Rolle der Region kann entweder primär oder sekundär sein. Die primäre Region ist der Ort, an dem der IoT-Hub derzeit bereitgestellt wird. Die sekundäre Region ist die mit Azure Disaster Recovery (DR) gekoppelte Region und auch die Region, in der der IoT-Hub Failover ausführen kann.

Wert	Beschreibung
primary
secondary

IotHubSku

Enumeration

Der Name der SKU.

Wert	Beschreibung
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Objekt

Informationen zur SKU des IoT-Hubs.

Name	Typ	Beschreibung
capacity	integer (int64)	Die Anzahl der bereitgestellten IoT Hub-Einheiten. Siehe: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Der Name der SKU.
tier	IotHubSkuTier	Die Abrechnungsstufe für den IoT-Hub.

IotHubSkuTier

Enumeration

Die Abrechnungsstufe für den IoT-Hub.

Wert	Beschreibung
Basic
Free
Standard

IpFilterActionType

Enumeration

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

Wert	Beschreibung
Accept
Reject

IpFilterRule

Objekt

Die IP-Filterregeln für den IoT-Hub.

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

ManagedIdentity

Objekt

Die Eigenschaften der verwalteten Identität.

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

MessagingEndpointProperties

Objekt

Die Eigenschaften der von diesem IoT-Hub verwendeten Messaging-Endpunkte.

Name	Typ	Beschreibung
lockDurationAsIso8601	string (duration)	Die Sperrdauer. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht zu übermitteln. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Enumeration

IP-Filteraktion

Wert	Beschreibung
Allow

NetworkRuleSetIpRule

Objekt

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

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

NetworkRuleSetProperties

Objekt

Netzwerkregelsatzeigenschaften von IotHub

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

PrivateEndpoint

Objekt

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.

PrivateEndpointConnection

Objekt

Die private Endpunktverbindung eines IotHub

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

PrivateEndpointConnectionProperties

Objekt

Die Eigenschaften einer privaten Endpunktverbindung

Name	Typ	Beschreibung
privateEndpoint	PrivateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionState

Objekt

Der aktuelle Status einer privaten Endpunktverbindung

Name	Typ	Beschreibung
actionsRequired	string	Aktionen, die für eine private Endpunktverbindung erforderlich sind
description	string	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung
status	PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Enumeration

Der Status einer privaten Endpunktverbindung

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeration

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

Wert	Beschreibung
Disabled
Enabled

ResourceIdentityType

Enumeration

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Objekt

Die Eigenschaften einer Routingregel, die Ihr IoT-Hub zum Weiterleiten von Nachrichten an Endpunkte verwendet.

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

RoutingCosmosDBSqlApiProperties

Objekt

Die Eigenschaften im Zusammenhang mit einem Cosmos DB SQL-Containerendpunkt.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Sql-Containerendpunkt von Cosmos DB
containerName	string	Der Name des Cosmos DB-SQL-Containers in der Cosmos DB-Datenbank.
databaseName	string	Der Name der Cosmos DB-Datenbank im Cosmos DB-Konto.
endpointUri	string (uri)	Die URL des Cosmos DB-Kontos. Es muss das Protokoll https://
id	string	ID des Cosmos DB SQL-Containerendpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routing-Cosmos DB-Containerendpunkts.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein.
partitionKeyName	string	Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, falls vorhanden. Dies ist ein optionaler Parameter.
partitionKeyTemplate	string	Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem Cosmos DB-SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {JJJJ}. Jeder Platzhalter kann höchstens einmal angegeben werden, aber Reihenfolge und Nicht-Platzhalterkomponenten sind beliebig. Dieser Parameter ist nur erforderlich, wenn PartitionKeyName angegeben ist.
primaryKey	string	Der Primärschlüssel des Cosmos DB-Kontos.
resourceGroup	string	Der Name der Ressourcengruppe des Cosmos DB-Kontos.
secondaryKey	string	Der Sekundärschlüssel des Cosmos DB-Kontos.
subscriptionId	string	Der Abonnementbezeichner des Cosmos DB-Kontos.

RoutingEndpoints

Objekt

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

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

RoutingEventHubProperties

Objekt

Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Event Hub-Endpunkt
connectionString	string	Die Verbindungszeichenfolge des Event Hub-Endpunkts.
endpointUri	string	Die URL des Event Hub-Endpunkts. Es muss das Protokoll sb://
entityPath	string	Event Hub-Name im Event Hub-Namespace
id	string	ID des Event Hub-Endpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routingereignishub-Endpunkts.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein.
resourceGroup	string	Der Name der Ressourcengruppe des Event Hub-Endpunkts.
subscriptionId	string	Der Abonnementbezeichner des Event Hub-Endpunkts.

RoutingProperties

Objekt

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

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

RoutingServiceBusQueueEndpointProperties

Objekt

Die Eigenschaften im Zusammenhang mit Dienstenbus-Warteschlangenendpunkttypen.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange
connectionString	string	Die Verbindungszeichenfolge des Dienstenbus-Warteschlangenendpunkts.
endpointUri	string	Die URL des Dienstenbus-Warteschlangenendpunkts. Es muss das Protokoll sb://
entityPath	string	Warteschlangenname im Servicebusnamespace
id	string	ID des Dienstenbus-Warteschlangenendpunkts
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen übereinstimmen.
resourceGroup	string	Der Name der Ressourcengruppe des Dienstenbus-Warteschlangenendpunkts.
subscriptionId	string	Der Abonnementbezeichner des Dienstenbus-Warteschlangenendpunkts.

RoutingServiceBusTopicEndpointProperties

Objekt

Die Eigenschaften im Zusammenhang mit Dienstenbus-Themenendpunkttypen.

Name	Typ	Beschreibung
authenticationType	authenticationType	Methode zur Authentifizierung beim Endpunkt des Servicebusthemas
connectionString	string	Die Verbindungszeichenfolge des Servicebus-Themenendpunkts.
endpointUri	string	Die URL des Endpunkts des Servicebusthemas. Es muss das Protokoll sb://
entityPath	string	Warteschlangenname im Thema "Servicebus"
id	string	ID des Endpunkts des Servicebusthemas
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Endpunkts des Routingdienstbus.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themanamen identisch sein.
resourceGroup	string	Der Name der Ressourcengruppe des Servicebus-Themenendpunkts.
subscriptionId	string	Der Abonnementbezeichner des Servicebus-Themenendpunkts.

RoutingSource

Enumeration

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

Wert	Beschreibung
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Objekt

Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.

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

SharedAccessSignatureAuthorizationRule

Objekt

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

Name	Typ	Beschreibung
keyName	string	Der Name der Richtlinie für den freigegebenen Zugriff.
primaryKey	string	Der Primärschlüssel.
rights	AccessRights	Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind.
secondaryKey	string	Der sekundäre Schlüssel.

StorageEndpointProperties

Objekt

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

Name	Typ	Beschreibung
authenticationType	AuthenticationType	Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird.
connectionString	string	Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden.
containerName	string	Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte jedoch mithilfe der angegebenen connectionString erstellt werden.
identity	ManagedIdentity	Verwaltete Identitätseigenschaften des Speicherendpunkts für den Dateiupload.
sasTtlAsIso8601	string (duration)	Der Zeitraum, für den der SAS-URI, der vom IoT Hub für den Dateiupload generiert wurde, gültig ist. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

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