Iot Hub Resource - Get

Referentie

Service:: IoT Hub

API-versie:: 2023-06-30

Haal de niet-beveiligingsgerelateerde metagegevens van een IoT-hub op.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de IoT-hub bevat.
resourceName	path	True	string	De naam van de IoT-hub.
subscriptionId	path	True	string	De abonnement-ID.
api-version	query	True	string	De versie van de API.

Antwoorden

Name	Type	Description
200 OK	IotHubDescription	De hoofdtekst bevat alle niet-beveiligingseigenschappen van de IoT-hub. Beveiligingsgerelateerde eigenschappen worden ingesteld op null.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

IotHubResource_Get

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AccessRights	De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.
ArmIdentity
ArmUserIdentity
AuthenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij
Capabilities	De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.
CloudToDeviceProperties	De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultAction	Standaardactie voor netwerkregelset
EnrichmentProperties	De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die aan eindpunten worden geleverd.
ErrorDetails	Foutdetails.
EventHubProperties	De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.
FallbackRouteProperties	De eigenschappen van de terugvalroute. IoT Hub gebruikt deze eigenschappen wanneer berichten worden gerouteerd naar het terugvaleindpunt.
FeedbackProperties	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.
IotHubDescription	De beschrijving van de IoT-hub.
IotHubLocationDescription	Openbare weergave van een van de locaties waar een resource is ingericht.
IotHubProperties	De eigenschappen van een IoT-hub.
IotHubReplicaRoleType	De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde azure-regio voor herstel na noodgevallen en ook de regio waarnaar de IoT-hub een failover kan uitvoeren.
IotHubSku	De naam van de SKU.
IotHubSkuInfo	Informatie over de SKU van de IoT-hub.
IotHubSkuTier	De factureringslaag voor de IoT-hub.
IpFilterActionType	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.
IpFilterRule	De IP-filterregels voor de IoT-hub.
ManagedIdentity	De eigenschappen van de beheerde identiteit.
MessagingEndpointProperties	De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.
NetworkRuleIPAction	IP-filteractie
NetworkRuleSetIpRule	IP-regel die moet worden toegepast als onderdeel van de netwerkregelset
NetworkRuleSetProperties	Eigenschappen van set netwerkregels van IotHub
PrivateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding
PrivateEndpointConnection	De privé-eindpuntverbinding van een IotHub
PrivateEndpointConnectionProperties	De eigenschappen van een privé-eindpuntverbinding
PrivateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding
PrivateLinkServiceConnectionStatus	De status van een privé-eindpuntverbinding
PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
RouteProperties	De eigenschappen van een routeringsregel die door uw IoT-hub wordt gebruikt om berichten naar eindpunten te routeren.
RoutingCosmosDBSqlApiProperties	De eigenschappen met betrekking tot een cosmos DB SQL-containereindpunt.
RoutingEndpoints	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.
RoutingEventHubProperties	De eigenschappen met betrekking tot een Event Hub-eindpunt.
RoutingProperties	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	De eigenschappen met betrekking tot eindpunttypen van de Service Bus-wachtrij.
RoutingServiceBusTopicEndpointProperties	De eigenschappen met betrekking tot eindpunttypen voor Service Bus-onderwerpen.
RoutingSource	De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.
RoutingStorageContainerProperties	De eigenschappen met betrekking tot een eindpunt van een opslagcontainer.
SharedAccessSignatureAuthorizationRule	De eigenschappen van een gedeeld toegangsbeleid voor IoT Hub.
StorageEndpointProperties	De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AccessRights

Inventarisatie

De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.

Waarde	Description
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ArmIdentity

Object

Name	Type	Description
principalId	string	Principal-id
tenantId	string	Tenant-id
type	ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Object

Name	Type	Description
clientId	string
principalId	string

AuthenticationType

Inventarisatie

Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.

Waarde	Description
identityBased
keyBased

authenticationType

Inventarisatie

Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij

Waarde	Description
identityBased
keyBased

Capabilities

Inventarisatie

De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.

Waarde	Description
DeviceManagement
None

CloudToDeviceProperties

Object

De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.

Name	Type	Description
defaultTtlAsIso8601	string (duration)	De standaardtijd voor live voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

DefaultAction

Inventarisatie

Standaardactie voor netwerkregelset

Waarde	Description
Allow
Deny

EnrichmentProperties

Object

De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die aan eindpunten worden geleverd.

Name	Type	Description
endpointNames	string[]	De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht.
key	string	De sleutel of naam voor de verrijkingseigenschap.
value	string	De waarde voor de verrijkingseigenschap.

ErrorDetails

Object

Foutdetails.

Name	Type	Description
code	string	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

EventHubProperties

Object

De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.

Name	Type	Description
endpoint	string	Het event hub-compatibele eindpunt.
partitionCount	integer (int32)	Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	De partitie-id's in het event hub-compatibele eindpunt.
path	string	De naam die compatibel is met Event Hub.
retentionTimeInDays	integer (int64)	De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Object

De eigenschappen van de terugvalroute. IoT Hub gebruikt deze eigenschappen wanneer berichten worden gerouteerd naar het terugvaleindpunt.

Name	Type	Description
condition	string	De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	De lijst met eindpunten waarnaar de berichten waaraan de voorwaarde voldoet, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan.
isEnabled	boolean	Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld.
name	string	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.
source	RoutingSource	De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages

FeedbackProperties

Object

De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.

Name	Type	Description
lockDurationAsIso8601	string (duration)	De vergrendelingsduur voor de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Object

De beschrijving van de IoT-hub.

Name	Type	Description
etag	string	Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.
id	string	De resource-id.
identity	ArmIdentity	De beheerde identiteiten voor de IotHub.
location	string	De resourcelocatie.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	De resourcenaam.
properties	IotHubProperties	IotHub-eigenschappen
sku	IotHubSkuInfo	IotHub-SKU-gegevens
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
tags	object	De resourcetags.
type	string	Het resourcetype.

IotHubLocationDescription

Object

Openbare weergave van een van de locaties waar een resource is ingericht.

Name	Type	Description
location	string	De naam van de Azure-regio
role	IotHubReplicaRoleType	De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde azure-regio voor herstel na noodgevallen en ook de regio waarnaar de IoT-hub een failover kan uitvoeren.

IotHubProperties

Object

De eigenschappen van een IoT-hub.

Name	Type	Description
allowedFqdnList	string[]	Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen.
cloudToDevice	CloudToDeviceProperties	De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.
comments	string	Opmerkingen bij IoT Hub.
disableDeviceSAS	boolean	Indien waar, kunnen alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik niet worden gebruikt voor verificatie.
disableLocalAuth	boolean	Indien waar, kunnen SAS-tokens met sas-sleutels met ioT-bereik niet worden gebruikt voor verificatie.
disableModuleSAS	boolean	Indien waar, kunnen alle SAS-sleutels met modulebereik niet worden gebruikt voor verificatie.
enableDataResidency	boolean	Met deze eigenschap wanneer deze is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld.
enableFileUploadNotifications	boolean	Indien waar, worden meldingen voor het uploaden van bestanden ingeschakeld.
eventHubEndpoints	<string, EventHubProperties>	De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub.
features	Capabilities	De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.
hostName	string	De naam van de host.
ipFilterRules	IpFilterRule[]	De IP-filterregels.
locations	IotHubLocationDescription[]	Primaire en secundaire locatie voor ioT-hub
messagingEndpoints	<string, MessagingEndpointProperties>	De eigenschappen van het berichteindpunt voor de meldingswachtrij voor het uploaden van bestanden.
minTlsVersion	string	Hiermee geeft u de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.
networkRuleSets	NetworkRuleSetProperties	Eigenschappen van set netwerkregels van IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub
provisioningState	string	De inrichtingsstatus.
publicNetworkAccess	PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
restrictOutboundNetworkAccess	boolean	Indien waar, worden uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList.
routing	RoutingProperties	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	De hubstatus.
storageEndpoints	<string, StorageEndpointProperties>	De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er geen waarde opgegeven voor deze eigenschap. Er wordt een fout gegenereerd.

IotHubReplicaRoleType

Inventarisatie

De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde azure-regio voor herstel na noodgevallen en ook de regio waarnaar de IoT-hub een failover kan uitvoeren.

Waarde	Description
primary
secondary

IotHubSku

Inventarisatie

De naam van de SKU.

Waarde	Description
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Object

Informatie over de SKU van de IoT-hub.

Name	Type	Description
capacity	integer (int64)	Het aantal ingerichte IoT Hub-eenheden. Zie: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	De naam van de SKU.
tier	IotHubSkuTier	De factureringslaag voor de IoT-hub.

IotHubSkuTier

Inventarisatie

De factureringslaag voor de IoT-hub.

Waarde	Description
Basic
Free
Standard

IpFilterActionType

Inventarisatie

De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.

Waarde	Description
Accept
Reject

IpFilterRule

Object

De IP-filterregels voor de IoT-hub.

Name	Type	Description
action	IpFilterActionType	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.
filterName	string	De naam van de IP-filterregel.
ipMask	string	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.

ManagedIdentity

Object

De eigenschappen van de beheerde identiteit.

Name	Type	Description
userAssignedIdentity	string	De door de gebruiker toegewezen identiteit.

MessagingEndpointProperties

Object

De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.

Name	Type	Description
lockDurationAsIso8601	string (duration)	De duur van de vergrendeling. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Inventarisatie

IP-filteractie

Waarde	Description
Allow

NetworkRuleSetIpRule

Object

IP-regel die moet worden toegepast als onderdeel van de netwerkregelset

Name	Type	Default value	Description
action	NetworkRuleIPAction	Allow	IP-filteractie
filterName	string		Naam van de IP-filterregel.
ipMask	string		Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.

NetworkRuleSetProperties

Object

Eigenschappen van set netwerkregels van IotHub

Name	Type	Default value	Description
applyToBuiltInEventHubEndpoint	boolean		Indien waar, wordt de netwerkregelset ook toegepast op builtIn EventHub EndPoint van IotHub
defaultAction	DefaultAction	Deny	Standaardactie voor netwerkregelset
ipRules	NetworkRuleSetIpRule[]		Lijst met IP-regels

PrivateEndpoint

Object

De eigenschap privé-eindpunt van een privé-eindpuntverbinding

Name	Type	Description
id	string	De resource-id.

PrivateEndpointConnection

Object

De privé-eindpuntverbinding van een IotHub

Name	Type	Description
id	string	De resource-id.
name	string	De resourcenaam.
properties	PrivateEndpointConnectionProperties	De eigenschappen van een privé-eindpuntverbinding
type	string	Het resourcetype.

PrivateEndpointConnectionProperties

Object

De eigenschappen van een privé-eindpuntverbinding

Name	Type	Description
privateEndpoint	PrivateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionState

Object

De huidige status van een privé-eindpuntverbinding

Name	Type	Description
actionsRequired	string	Acties die vereist zijn voor een privé-eindpuntverbinding
description	string	De beschrijving voor de huidige status van een privé-eindpuntverbinding
status	PrivateLinkServiceConnectionStatus	De status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionStatus

Inventarisatie

De status van een privé-eindpuntverbinding

Waarde	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Inventarisatie

Of aanvragen van openbaar netwerk zijn toegestaan

Waarde	Description
Disabled
Enabled

ResourceIdentityType

Inventarisatie

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Object

De eigenschappen van een routeringsregel die door uw IoT-hub wordt gebruikt om berichten naar eindpunten te routeren.

Name	Type	Description
condition	string	De voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	De lijst met eindpunten waarnaar berichten die voldoen aan de voorwaarde, worden gerouteerd. Op dit moment is slechts één eindpunt toegestaan.
isEnabled	boolean	Wordt gebruikt om op te geven of een route is ingeschakeld.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.
source	RoutingSource	De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.

RoutingCosmosDBSqlApiProperties

Object

De eigenschappen met betrekking tot een cosmos DB SQL-containereindpunt.

Name	Type	Description
authenticationType	authenticationType	Methode die wordt gebruikt voor verificatie op basis van het cosmos DB SQL-containereindpunt
containerName	string	De naam van de cosmos DB SQL-container in de cosmos DB-database.
databaseName	string	De naam van de cosmos DB-database in het cosmos DB-account.
endpointUri	string (uri)	De URL van het Cosmos DB-account. Het moet het protocol bevatten https://
id	string	Id van het cosmos DB SQL-containereindpunt
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van het routeren van cosmos DB-containereindpunt.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.
partitionKeyName	string	De naam van de partitiesleutel die is gekoppeld aan deze cosmos DB SQL-container als deze bestaat. Dit is een optionele parameter.
partitionKeyTemplate	string	De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-container. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Elke tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar volgorde en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven.
primaryKey	string	De primaire sleutel van het Cosmos DB-account.
resourceGroup	string	De naam van de resourcegroep van het Cosmos DB-account.
secondaryKey	string	De secundaire sleutel van het cosmos DB-account.
subscriptionId	string	De abonnements-id van het cosmos DB-account.

RoutingEndpoints

Object

De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.

Name	Type	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	De lijst met Cosmos DB-containereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.
eventHubs	RoutingEventHubProperties[]	De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	De lijst met Service Bus-wachtrijeindpunten waarnaar ioT Hub de berichten routeert op basis van de routeringsregels.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert, op basis van de routeringsregels.
storageContainers	RoutingStorageContainerProperties[]	De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.

RoutingEventHubProperties

Object

De eigenschappen met betrekking tot een Event Hub-eindpunt.

Name	Type	Description
authenticationType	authenticationType	Methode die wordt gebruikt voor verificatie op basis van het Event Hub-eindpunt
connectionString	string	De verbindingsreeks van het Event Hub-eindpunt.
endpointUri	string	De URL van het Event Hub-eindpunt. Het moet het protocol sb:// bevatten
entityPath	string	Event Hub-naam in de Event Hub-naamruimte
id	string	Id van het Event Hub-eindpunt
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van het eindpunt van de Event Hub routeren.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.
resourceGroup	string	De naam van de resourcegroep van het Event Hub-eindpunt.
subscriptionId	string	De abonnements-id van het Event Hub-eindpunt.

RoutingProperties

Object

De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Type	Description
endpoints	RoutingEndpoints	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.
enrichments	EnrichmentProperties[]	De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden geleverd aan ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie Routes wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet aanwezig is in de sjabloon, is de terugvalroute standaard uitgeschakeld.
routes	RouteProperties[]	De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs.

RoutingServiceBusQueueEndpointProperties

Object

De eigenschappen met betrekking tot eindpunttypen van de Service Bus-wachtrij.

Name	Type	Description
authenticationType	authenticationType	Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij
connectionString	string	De verbindingsreeks van het service bus-wachtrijeindpunt.
endpointUri	string	De URL van het service bus-wachtrijeindpunt. Het moet het protocol sb:// bevatten
entityPath	string	Wachtrijnaam in de Service Bus-naamruimte
id	string	Id van het service bus-wachtrijeindpunt
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van het eindpunt van de service bus-wachtrij.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam.
resourceGroup	string	De naam van de resourcegroep van het service bus-wachtrijeindpunt.
subscriptionId	string	De abonnements-id van het service bus-wachtrijeindpunt.

RoutingServiceBusTopicEndpointProperties

Object

De eigenschappen met betrekking tot eindpunttypen voor Service Bus-onderwerpen.

Name	Type	Description
authenticationType	authenticationType	Methode die wordt gebruikt voor verificatie op basis van het service bus-onderwerpeindpunt
connectionString	string	De verbindingsreeks van het service bus-onderwerpeindpunt.
endpointUri	string	De URL van het service bus-onderwerpeindpunt. Het moet het protocol sb:// bevatten
entityPath	string	Wachtrijnaam in het Service Bus-onderwerp
id	string	Id van het service bus-onderwerpeindpunt
identity	ManagedIdentity	Beheerde identiteiteigenschappen van het eindpunt van het routeren van Service Bus-onderwerp.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam.
resourceGroup	string	De naam van de resourcegroep van het service bus-onderwerpeindpunt.
subscriptionId	string	De abonnements-id van het service bus-onderwerpeindpunt.

RoutingSource

Inventarisatie

De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.

Waarde	Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Object

De eigenschappen met betrekking tot een eindpunt van een opslagcontainer.

Name	Type	Description
authenticationType	authenticationType	Methode die wordt gebruikt voor verificatie op basis van het opslageindpunt
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden.
connectionString	string	De verbindingsreeks van het opslagaccount.
containerName	string	De naam van de opslagcontainer in het opslagaccount.
encoding	enum: Avro AvroDeflate JSON	Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.
endpointUri	string	De URL van het opslageindpunt. Het moet het protocol bevatten https://
fileNameFormat	string	Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt.
id	string	Id van het eindpunt van de opslagcontainer
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van eindpunt voor routeringsopslag.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Maximum aantal bytes voor elke blob die naar de opslag is geschreven. De waarde moet tussen 10485760(10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.
resourceGroup	string	De naam van de resourcegroep van het opslagaccount.
subscriptionId	string	De abonnements-id van het opslagaccount.

SharedAccessSignatureAuthorizationRule

Object

De eigenschappen van een gedeeld toegangsbeleid voor IoT Hub.

Name	Type	Description
keyName	string	De naam van het beleid voor gedeelde toegang.
primaryKey	string	De primaire sleutel.
rights	AccessRights	De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.
secondaryKey	string	De secundaire sleutel.

StorageEndpointProperties

Object

De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.

Name	Type	Description
authenticationType	AuthenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.
connectionString	string	De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.
containerName	string	De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden.
sasTtlAsIso8601	string (duration)	De periode waarvoor de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden, is geldig. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.