Iot Hub Resource - Delete

Service:

IoT Hub

API Version:

2023-06-30

Ta bort en IoT-hubb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller IoT-hubben.
resourceName	path	True	string	Namnet på IoT-hubben.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Typ	Description
200 OK	IotHubDescription	Detta returneras som ett svar på statussökningsbegäran för borttagningsåtgärden. Brödtexten innehåller resursrepresentationen som anger ett övergångsetableringstillstånd.
202 Accepted	IotHubDescription	Iot Hub-resursprovidern returnerar alltid statuskoden 202 Accepterad med giltig plats och Retry-After huvuden. Resursprovidern anger också Azure-AsyncOperation-huvudet med en URL som pekar på åtgärdsresursen för den här åtgärden. Efterföljande GET-försök på resursen efter en DELETE-åtgärd returnerar en resursrepresentation som anger ett övergångsetableringstillstånd (till exempel Avslutande). Om du vill hämta status för åtgärden kan en klient antingen avsöka URL:en som returneras i platshuvudet efter Retry-After intervall, hämta IoT Hub tjänststatus direkt eller fråga åtgärdsresursen. Headers Azure-AsyncOperation: string Location: string
204 No Content		När den långvariga borttagningsåtgärden har slutförts returneras statuskoden 204 Inget innehåll när statussökningsbegäran hittar Iot Hub-metadata i tjänsten och statusen för borttagningsåtgärden är inställd på ett slutfört tillstånd.
404 Not Found	ErrorDetails	När den långvariga borttagningsåtgärden har slutförts returneras en 404 Not Found när statussökningsbegäran inte längre hittar Iot Hub-metadata i tjänsten.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

IotHubResource_Delete

Sample Request

HTTP

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

Java

/** Samples for IotHubResource Delete. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_delete.json
     */
    /**
     * Sample code: IotHubResource_Delete.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceDelete(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().delete("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

Python

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

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

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


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

    response = client.iot_hub_resource.begin_delete(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
    ).result()
    print(response)


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

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

Go

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/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_delete.json
func ExampleResourceClient_BeginDelete() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewResourceClient().BeginDelete(ctx, "myResourceGroup", "testHub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Description = armiothub.Description{
	// 	Name: to.Ptr("testHub"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 	ID: to.Ptr("/subscriptions/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"),
	// 			}},
	// 			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
	// 				"fileNotifications": &armiothub.MessagingEndpointProperties{
	// 					LockDurationAsIso8601: to.Ptr("PT1M"),
	// 					MaxDeliveryCount: to.Ptr[int32](10),
	// 					TTLAsIso8601: to.Ptr("PT1H"),
	// 				},
	// 			},
	// 			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

JavaScript

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

/**
 * This sample demonstrates how to Delete an IoT hub.
 *
 * @summary Delete an IoT hub.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_delete.json
 */
async function iotHubResourceDelete() {
  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.beginDeleteAndWait(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

dotnet

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_delete.json
// this example is just showing the usage of "IotHubResource_Delete" 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 IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "testHub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);

// invoke the operation
ArmOperation<IotHubDescriptionResource> lro = await iotHubDescription.DeleteAsync(WaitUntil.Completed);
IotHubDescriptionResource result = lro.Value;

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

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

Sample Response

Status code:

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"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Status code:

204

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih

Response Body

{
  "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"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Status code:

404

{}

Definitioner

Name	Description
AccessRights	Behörigheterna som tilldelats till principen för delad åtkomst.
ArmIdentity
ArmUserIdentity
AuthenticationType	Anger vilken autentiseringstyp som används för att ansluta till lagringskontot.
authenticationType	Metod som används för att autentisera mot service bus-köslutpunkten
Capabilities	Funktionerna och funktionerna som är aktiverade för IoT-hubben.
CloudToDeviceProperties	Meddelandeegenskaperna för IoT Hub från moln till enhet.
createdByType	Den typ av identitet som skapade resursen.
DefaultAction	Standardåtgärd för nätverksregeluppsättning
EnrichmentProperties	Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter.
ErrorDetails	Felinformation.
EventHubProperties	Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.
FallbackRouteProperties	Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten.
FeedbackProperties	Egenskaperna för feedbackkön för meddelanden från molnet till enheten.
IotHubDescription	Beskrivningen av IoT-hubben.
IotHubLocationDescription	Offentlig representation av en av de platser där en resurs etableras.
IotHubProperties	Egenskaperna för en IoT-hubb.
IotHubReplicaRoleType	Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande är etablerad. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till.
IotHubSku	Namnet på SKU:n.
IotHubSkuInfo	Information om IoT-hubbens SKU.
IotHubSkuTier	Faktureringsnivån för IoT-hubben.
IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
IpFilterRule	IP-filterreglerna för IoT-hubben.
ManagedIdentity	Egenskaperna för den hanterade identiteten.
MessagingEndpointProperties	Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.
NetworkRuleIPAction	IP-filteråtgärd
NetworkRuleSetIpRule	IP-regel som ska tillämpas som en del av nätverksregeluppsättningen
NetworkRuleSetProperties	Egenskaper för nätverksregeluppsättning för IotHub
PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
PrivateEndpointConnection	Den privata slutpunktsanslutningen för en IotHub
PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning
PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning
PublicNetworkAccess	Om begäranden från offentligt nätverk tillåts
ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
RouteProperties	Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.
RoutingCosmosDBSqlApiProperties	Egenskaperna som är relaterade till en cosmos DB sql-containerslutpunkt.
RoutingEndpoints	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.
RoutingEventHubProperties	Egenskaperna som är relaterade till en händelsehubbslutpunkt.
RoutingProperties	Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	De egenskaper som är relaterade till service bus-köslutpunktstyper.
RoutingServiceBusTopicEndpointProperties	Egenskaper relaterade till service bus-ämnesslutpunktstyper.
RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.
RoutingStorageContainerProperties	Egenskaperna som är relaterade till en slutpunkt för lagringscontainer.
SharedAccessSignatureAuthorizationRule	Egenskaperna för en princip för delad åtkomst i IoT Hub.
StorageEndpointProperties	Egenskaperna för Azure Storage-slutpunkten för filuppladdning.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AccessRights

Behörigheterna som tilldelats till principen för delad åtkomst.

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

ArmIdentity

Name	Typ	Description
principalId	string	Huvudkonto-ID
tenantId	string	Klientorganisations-ID
type	ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string,  ArmUserIdentity>

ArmUserIdentity

Name	Typ	Description
clientId	string
principalId	string

AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till lagringskontot.

Name	Typ	Description
identityBased	string
keyBased	string

authenticationType

Metod som används för att autentisera mot service bus-köslutpunkten

Name	Typ	Description
identityBased	string
keyBased	string

Capabilities

Funktionerna och funktionerna som är aktiverade för IoT-hubben.

Name	Typ	Description
DeviceManagement	string
None	string

CloudToDeviceProperties

Meddelandeegenskaperna för IoT Hub från moln till enhet.

Name	Typ	Description
defaultTtlAsIso8601	string	Standardtiden för meddelanden från molnet till enheten i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Egenskaperna för feedbackkön för meddelanden från molnet till enheten.
maxDeliveryCount	integer	Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Standardåtgärd för nätverksregeluppsättning

Name	Typ	Description
Allow	string
Deny	string

EnrichmentProperties

Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter.

Name	Typ	Description
endpointNames	string[]	Listan över slutpunkter för vilka berikandet tillämpas på meddelandet.
key	string	Nyckeln eller namnet på berikningsegenskapen.
value	string	Värdet för berikningsegenskapen.

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

EventHubProperties

Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.

Name	Typ	Description
endpoint	string	Den Event Hub-kompatibla slutpunkten.
partitionCount	integer	Antalet partitioner för att ta emot meddelanden från enheten till molnet i den Event Hub-kompatibla slutpunkten. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Partitions-ID:na i den Event Hub-kompatibla slutpunkten.
path	string	Event Hub-kompatibelt namn.
retentionTimeInDays	integer	Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten.

Name	Typ	Description
condition	string	Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det till sant som standard. För grammatik, se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast 1 slutpunkt.
isEnabled	boolean	Används för att ange om återställningsvägen är aktiverad.
name	string	Namnet på vägen. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.
source	RoutingSource	Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages

FeedbackProperties

Egenskaperna för feedbackkön för meddelanden från molnet till enheten.

Name	Typ	Description
lockDurationAsIso8601	string	Låsets varaktighet för feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer	Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string	Den tidsperiod då ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Beskrivningen av IoT-hubben.

Name	Typ	Description
etag	string	Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
id	string	Resursidentifieraren.
identity	ArmIdentity	Hanterade identiteter för IotHub.
location	string	Resursplatsen.
name	string	Resursnamnet.
properties	IotHubProperties	IotHub-egenskaper
sku	IotHubSkuInfo	IotHub SKU-information
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
tags	object	Resurstaggar.
type	string	Resurstypen.

IotHubLocationDescription

Offentlig representation av en av de platser där en resurs etableras.

Name	Typ	Description
location	string	Namnet på Azure-regionen
role	IotHubReplicaRoleType	Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande är etablerad. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till.

IotHubProperties

Egenskaperna för en IoT-hubb.

Name	Typ	Description
allowedFqdnList	string[]	Lista över tillåtna FQDN(fullständigt kvalificerat domännamn) för utgående trafik från Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.
cloudToDevice	CloudToDeviceProperties	Meddelandeegenskaperna för IoT Hub från moln till enhet.
comments	string	IoT Hub-kommentarer.
disableDeviceSAS	boolean	Om det är sant kan inte alla SAS-nycklar med omfång (inklusive Edge-enheter men exklusive moduler) användas för autentisering.
disableLocalAuth	boolean	Om det är sant kan SAS-token med SAS-nycklar med Iot Hub-omfång inte användas för autentisering.
disableModuleSAS	boolean	Om det är sant kan inte alla SAS-nycklar med modulomfång användas för autentisering.
enableDataResidency	boolean	När den här egenskapen är inställd på true aktiveras datahemvist, vilket inaktiverar haveriberedskap.
enableFileUploadNotifications	boolean	Om värdet är Sant aktiveras meddelanden om filuppladdning.
eventHubEndpoints	<string,  EventHubProperties>	Egenskaper för Event Hub-kompatibla slutpunkter. De enda möjliga nycklarna till den här ordlistan är händelser. Den här nyckeln måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.
features	Capabilities	Funktionerna och funktionerna som är aktiverade för IoT-hubben.
hostName	string	Namnet på värden.
ipFilterRules	IpFilterRule[]	IP-filterreglerna.
locations	IotHubLocationDescription[]	Primär och sekundär plats för iot-hubb
messagingEndpoints	<string,  MessagingEndpointProperties>	Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.
minTlsVersion	string	Anger den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" för att klienter som använder en TLS-version under 1.2 ska avvisas.
networkRuleSets	NetworkRuleSetProperties	Egenskaper för nätverksregeluppsättning för IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Privata slutpunktsanslutningar som skapats på denna IotHub
provisioningState	string	Etableringstillståndet.
publicNetworkAccess	PublicNetworkAccess	Om begäranden från offentligt nätverk tillåts
restrictOutboundNetworkAccess	boolean	Om det är sant begränsas utgående från IotHub till endast de tillåtna FQDN:er som konfigureras via allowedFqdnList.
routing	RoutingProperties	Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Hubbtillståndet.
storageEndpoints	<string,  StorageEndpointProperties>	Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och som MÅSTE ha sin nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger ett värde för den här egenskapen när egenskapen enableFileUploadNotifications är inställd på True genereras ett fel.

IotHubReplicaRoleType

Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande är etablerad. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till.

Name	Typ	Description
primary	string
secondary	string

IotHubSku

Namnet på SKU:n.

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

IotHubSkuInfo

Information om IoT-hubbens SKU.

Name	Typ	Description
capacity	integer	Antalet etablerade IoT Hub enheter. Se: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Namnet på SKU:n.
tier	IotHubSkuTier	Faktureringsnivån för IoT-hubben.

IotHubSkuTier

Faktureringsnivån för IoT-hubben.

Name	Typ	Description
Basic	string
Free	string
Standard	string

IpFilterActionType

Önskad åtgärd för begäranden som samlas in av den här regeln.

Name	Typ	Description
Accept	string
Reject	string

IpFilterRule

IP-filterreglerna för IoT-hubben.

Name	Typ	Description
action	IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
filterName	string	Namnet på IP-filterregeln.
ipMask	string	En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln.

ManagedIdentity

Egenskaperna för den hanterade identiteten.

Name	Typ	Description
userAssignedIdentity	string	Den användartilldelade identiteten.

MessagingEndpointProperties

Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.

Name	Typ	Description
lockDurationAsIso8601	string	Låsets varaktighet. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer	Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string	Den tidsperiod då ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

IP-filteråtgärd

Name	Typ	Description
Allow	string

NetworkRuleSetIpRule

IP-regel som ska tillämpas som en del av nätverksregeluppsättningen

Name	Typ	Standardvärde	Description
action	NetworkRuleIPAction	Allow	IP-filteråtgärd
filterName	string		Namnet på IP-filterregeln.
ipMask	string		En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln.

NetworkRuleSetProperties

Egenskaper för nätverksregeluppsättning för IotHub

Name	Typ	Standardvärde	Description
applyToBuiltInEventHubEndpoint	boolean		Om det är sant tillämpas även nätverksregeluppsättningen på BuiltIn EventHub EndPoint för IotHub
defaultAction	DefaultAction	Deny	Standardåtgärd för nätverksregeluppsättning
ipRules	NetworkRuleSetIpRule[]		Lista över IP-regler

PrivateEndpoint

Egenskapen privat slutpunkt för en privat slutpunktsanslutning

Name	Typ	Description
id	string	Resursidentifieraren.

PrivateEndpointConnection

Den privata slutpunktsanslutningen för en IotHub

Name	Typ	Description
id	string	Resursidentifieraren.
name	string	Resursnamnet.
properties	PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
type	string	Resurstypen.

PrivateEndpointConnectionProperties

Egenskaperna för en privat slutpunktsanslutning

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning

PrivateLinkServiceConnectionState

Det aktuella tillståndet för en privat slutpunktsanslutning

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs för en privat slutpunktsanslutning
description	string	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning
status	PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning

PrivateLinkServiceConnectionStatus

Status för en privat slutpunktsanslutning

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Om begäranden från offentligt nätverk tillåts

Name	Typ	Description
Disabled	string
Enabled	string

ResourceIdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RouteProperties

Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.

Name	Typ	Description
condition	string	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det till sant som standard. Grammatik finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.
isEnabled	boolean	Används för att ange om en väg är aktiverad.
name	string	Namnet på vägen. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.
source	RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

RoutingCosmosDBSqlApiProperties

Egenskaperna som är relaterade till en cosmos DB sql-containerslutpunkt.

Name	Typ	Description
authenticationType	authenticationType	Metod som används för att autentisera mot cosmos DB sql-containerslutpunkten
containerName	string	Namnet på cosmos DB sql-containern i Cosmos DB-databasen.
databaseName	string	Namnet på cosmos DB-databasen i Cosmos DB-kontot.
endpointUri	string	URL:en för Cosmos DB-kontot. Det måste innehålla protokollet https://
id	string	ID för cosmos DB sql-containerslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av cosmos DB-containerslutpunkt.
name	string	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika för slutpunktstyper.
partitionKeyName	string	Namnet på partitionsnyckeln som är associerad med den här Cosmos DB sql-containern om det finns en sådan. Det här är en valfri parameter.
partitionKeyTemplate	string	Mallen för att generera ett syntetiskt partitionsnyckelvärde för användning med den här Cosmos DB sql-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Den här parametern krävs bara om PartitionKeyName har angetts.
primaryKey	string	Den primära nyckeln för Cosmos DB-kontot.
resourceGroup	string	Namnet på resursgruppen för Cosmos DB-kontot.
secondaryKey	string	Den sekundära nyckeln för Cosmos DB-kontot.
subscriptionId	string	Prenumerationsidentifieraren för cosmos DB-kontot.

RoutingEndpoints

Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.

Name	Typ	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.
eventHubs	RoutingEventHubProperties[]	Listan över Event Hubs-slutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. Den här listan innehåller inte den inbyggda Event Hubs-slutpunkten.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.
storageContainers	RoutingStorageContainerProperties[]	Listan över slutpunkter för lagringscontainer som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.

RoutingEventHubProperties

Egenskaperna som är relaterade till en händelsehubbslutpunkt.

Name	Typ	Description
authenticationType	authenticationType	Metod som används för att autentisera mot händelsehubbens slutpunkt
connectionString	string	Anslutningssträng för händelsehubbens slutpunkt.
endpointUri	string	URL:en för händelsehubbens slutpunkt. Det måste innehålla protokollet sb://
entityPath	string	Händelsehubbens namn på händelsehubbens namnområde
id	string	ID för händelsehubbens slutpunkt
identity	ManagedIdentity	Hanterade identitetsegenskaper för routningshändelsehubbens slutpunkt.
name	string	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika för slutpunktstyper.
resourceGroup	string	Namnet på resursgruppen för händelsehubbens slutpunkt.
subscriptionId	string	Prenumerationsidentifieraren för händelsehubbens slutpunkt.

RoutingProperties

Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Typ	Description
endpoints	RoutingEndpoints	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.
enrichments	EnrichmentProperties[]	Listan över berikanden från användaren som IoT-hubben gäller för meddelanden som ska levereras till inbyggda och anpassade slutpunkter. Se: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Egenskaperna för den väg som används som reservväg när inget av de villkor som anges i avsnittet "vägar" är uppfyllda. Det här är en valfri parameter. Om den här egenskapen inte finns i mallen är återställningsvägen inaktiverad som standard.
routes	RouteProperties[]	Listan över användardefinierade routningsregler som IoT-hubben använder för att dirigera meddelanden till inbyggda och anpassade slutpunkter. Högst 100 routningsregler tillåts för betalda hubbar och högst 5 routningsregler tillåts för kostnadsfria hubbar.

RoutingServiceBusQueueEndpointProperties

De egenskaper som är relaterade till service bus-köslutpunktstyper.

Name	Typ	Description
authenticationType	authenticationType	Metod som används för att autentisera mot service bus-köslutpunkten
connectionString	string	Anslutningssträng för service bus-köslutpunkten.
endpointUri	string	URL:en för service bus-köslutpunkten. Det måste innehålla protokollet sb://
entityPath	string	Könamn på Service Bus-namnområdet
id	string	ID för service bus-köslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av service bus-köslutpunkten.
name	string	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika för slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.
resourceGroup	string	Namnet på resursgruppen för service bus-köslutpunkten.
subscriptionId	string	Prenumerationsidentifieraren för service bus-köslutpunkten.

RoutingServiceBusTopicEndpointProperties

Egenskaper relaterade till service bus-ämnesslutpunktstyper.

Name	Typ	Description
authenticationType	authenticationType	Metod som används för att autentisera mot service bus-ämnesslutpunkten
connectionString	string	Anslutningssträng för service bus-ämnesslutpunkten.
endpointUri	string	URL:en för service bus-ämnesslutpunkten. Det måste innehålla protokollet sb://
entityPath	string	Könamn i service bus-ämnet
id	string	ID för service bus-ämnesslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av service bus-ämnesslutpunkt.
name	string	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika för slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.
resourceGroup	string	Namnet på resursgruppen för service bus-ämnesslutpunkten.
subscriptionId	string	Prenumerationsidentifieraren för service bus-ämnesslutpunkten.

RoutingSource

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

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

RoutingStorageContainerProperties

Egenskaperna som är relaterade till en slutpunkt för lagringscontainer.

Name	Typ	Description
authenticationType	authenticationType	Metod som används för att autentisera mot lagringsslutpunkten
batchFrequencyInSeconds	integer	Tidsintervall där blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.
connectionString	string	Lagringskontots anslutningssträng.
containerName	string	Namnet på lagringscontainern i lagringskontot.
encoding	enum: Avro AvroDeflate JSON	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".
endpointUri	string	Url:en för lagringsslutpunkten. Det måste innehålla protokollet https://
fileNameFormat	string	Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.
id	string	ID för lagringscontainerns slutpunkt
identity	ManagedIdentity	Egenskaper för hanterad identitet för routning av lagringsslutpunkt.
maxChunkSizeInBytes	integer	Maximalt antal byte för varje blob som skrivs till lagring. Värdet ska vara mellan 10485760(10 MB) och 524288000(500 MB). Standardvärdet är 314572800(300 MB).
name	string	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika för slutpunktstyper.
resourceGroup	string	Namnet på resursgruppen för lagringskontot.
subscriptionId	string	Prenumerationsidentifieraren för lagringskontot.

SharedAccessSignatureAuthorizationRule

Egenskaperna för en princip för delad åtkomst i IoT Hub.

Name	Typ	Description
keyName	string	Namnet på principen för delad åtkomst.
primaryKey	string	Primärnyckeln.
rights	AccessRights	Behörigheterna som tilldelats till principen för delad åtkomst.
secondaryKey	string	Den sekundära nyckeln.

StorageEndpointProperties

Egenskaperna för Azure Storage-slutpunkten för filuppladdning.

Name	Typ	Description
authenticationType	AuthenticationType	Anger vilken autentiseringstyp som används för att ansluta till lagringskontot.
connectionString	string	Anslutningssträng för Det Azure Storage-konto som filer laddas upp till.
containerName	string	Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas, men den bör vara kan skapas med hjälp av den angivna connectionString.
identity	ManagedIdentity	Egenskaper för hanterad identitet för lagringsslutpunkten för filuppladdning.
sasTtlAsIso8601	string	Den tidsperiod som SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.