Iot Hub Resource - List By Subscription

Usługa:

IoT Hub

Wersja interfejsu API:

2023-06-30

Pobierz wszystkie centra IoT w subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IotHubDescriptionListResult	Jest to operacja synchroniczna. Treść zawiera tablicę serializowaną w formacie JSON metadanych ze wszystkich centrów IoT w subskrypcji.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

IotHubResource_ListBySubscription

Przykładowe żądanie

HTTP

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

Java

/** Samples for IotHubResource List. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
     */
    /**
     * Sample code: IotHubResource_ListBySubscription.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceListBySubscription(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().list(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_listbysubscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.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_listbysubscription.json
func ExampleResourceClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewResourceClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DescriptionListResult = armiothub.DescriptionListResult{
		// 	Value: []*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{
		// 							Name: to.Ptr("$fallback"),
		// 							Condition: to.Ptr("true"),
		// 							EndpointNames: []*string{
		// 								to.Ptr("events")},
		// 								IsEnabled: to.Ptr(true),
		// 								Source: to.Ptr(armiothub.RoutingSourceDeviceMessages),
		// 							},
		// 							Routes: []*armiothub.RouteProperties{
		// 							},
		// 						},
		// 						State: to.Ptr("Active"),
		// 						StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
		// 							"$default": &armiothub.StorageEndpointProperties{
		// 								ConnectionString: to.Ptr(""),
		// 								ContainerName: to.Ptr(""),
		// 								SasTTLAsIso8601: to.Ptr("PT1H"),
		// 							},
		// 						},
		// 					},
		// 					SKU: &armiothub.SKUInfo{
		// 						Name: to.Ptr(armiothub.IotHubSKUS1),
		// 						Capacity: to.Ptr[int64](1),
		// 						Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
		// 					},
		// 					SystemData: &armiothub.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:28:38.963Z"); return t}()),
		// 					},
		// 			}},
		// 		}
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Get all the IoT hubs in a subscription.
 *
 * @summary Get all the IoT hubs in a subscription.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listbysubscription.json
 */
async function iotHubResourceListBySubscription() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.iotHubResource.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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_listbysubscription.json
// this example is just showing the usage of "IotHubResource_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (IotHubDescriptionResource item in subscriptionResource.GetIotHubDescriptionsAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "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": {
            "name": "$fallback",
            "source": "DeviceMessages",
            "condition": "true",
            "endpointNames": [
              "events"
            ],
            "isEnabled": true
          }
        },
        "storageEndpoints": {
          "$default": {
            "sasTtlAsIso8601": "PT1H",
            "connectionString": "",
            "containerName": ""
          }
        },
        "messagingEndpoints": {
          "fileNotifications": {
            "lockDurationAsIso8601": "PT1M",
            "ttlAsIso8601": "PT1H",
            "maxDeliveryCount": 10
          }
        },
        "enableFileUploadNotifications": false,
        "cloudToDevice": {
          "maxDeliveryCount": 10,
          "defaultTtlAsIso8601": "PT1H",
          "feedback": {
            "lockDurationAsIso8601": "PT1M",
            "ttlAsIso8601": "PT1H",
            "maxDeliveryCount": 10
          }
        },
        "features": "None"
      },
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      },
      "systemData": {
        "createdAt": "2021-01-30T00:28:38.963Z"
      }
    }
  ]
}

Definicje

Nazwa	Opis
AccessRights	Uprawnienia przypisane do zasad dostępu współdzielonego.
ArmIdentity
ArmUserIdentity
AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
authenticationType	Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus
Capabilities	Możliwości i funkcje włączone dla centrum IoT.
CloudToDeviceProperties	Właściwości komunikatów z chmury do urządzenia w usłudze IoT Hub.
createdByType	Typ tożsamości, która utworzyła zasób.
DefaultAction	Domyślna akcja dla zestawu reguł sieciowych
EnrichmentProperties	Właściwości wzbogacania, które centrum IoT ma zastosowanie do komunikatów dostarczanych do punktów końcowych.
ErrorDetails	Szczegóły błędu.
EventHubProperties	Właściwości aprowizowanego punktu końcowego zgodnego z centrum zdarzeń używanego przez centrum IoT Hub.
FallbackRouteProperties	Właściwości trasy rezerwowej. IoT Hub używa tych właściwości, gdy kieruje komunikaty do rezerwowego punktu końcowego.
FeedbackProperties	Właściwości kolejki opinii dla komunikatów z chmury do urządzenia.
IotHubDescription	Opis centrum IoT.
IotHubDescriptionListResult	Tablica serializowana w formacie JSON obiektów IotHubDescription z następnym linkiem.
IotHubLocationDescription	Publiczna reprezentacja jednej z lokalizacji, w których aprowizowany jest zasób.
IotHubProperties	Właściwości centrum IoT.
IotHubReplicaRoleType	Rola regionu może być podstawowa lub pomocnicza. Region podstawowy to miejsce, w którym jest obecnie aprowizowane centrum IoT. Region pomocniczy to sparowany region odzyskiwania po awarii platformy Azure, a także region, w którym centrum IoT może przejść w tryb failover.
IotHubSku	Nazwa jednostki SKU.
IotHubSkuInfo	Informacje o jednostce SKU centrum IoT.
IotHubSkuTier	Warstwa rozliczeń centrum IoT.
IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
IpFilterRule	Reguły filtrowania adresów IP dla centrum IoT.
ManagedIdentity	Właściwości tożsamości zarządzanej.
MessagingEndpointProperties	Właściwości punktów końcowych obsługi komunikatów używanych przez to centrum IoT.
NetworkRuleIPAction	Akcja filtru IP
NetworkRuleSetIpRule	Reguła adresu IP, która ma być stosowana w ramach zestawu reguł sieciowych
NetworkRuleSetProperties	Właściwości zestawu reguł sieciowych usługi IotHub
PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
PrivateEndpointConnection	Połączenie prywatnego punktu końcowego usługi IotHub
PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego
PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
ResourceIdentityType	Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie tożsamości z usługi.
RouteProperties	Właściwości reguły routingu używanej przez centrum IoT do kierowania komunikatów do punktów końcowych.
RoutingCosmosDBSqlApiProperties	Właściwości związane z punktem końcowym kontenera sql usługi Cosmos DB.
RoutingEndpoints	Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów.
RoutingEventHubProperties	Właściwości związane z punktem końcowym centrum zdarzeń.
RoutingProperties	Właściwości powiązane z routingiem centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Właściwości związane z typami punktów końcowych kolejki usługi Service Bus.
RoutingServiceBusTopicEndpointProperties	Właściwości związane z typami punktów końcowych tematu usługi Service Bus.
RoutingSource	Źródłem, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages.
RoutingStorageContainerProperties	Właściwości związane z punktem końcowym kontenera magazynu.
SharedAccessSignatureAuthorizationRule	Właściwości zasad dostępu współdzielonego centrum IoT.
StorageEndpointProperties	Właściwości punktu końcowego usługi Azure Storage na potrzeby przekazywania plików.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AccessRights

Uprawnienia przypisane do zasad dostępu współdzielonego.

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń
tenantId	string	Identyfikator dzierżawy
type	ResourceIdentityType	Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.
userAssignedIdentities	<string,  ArmUserIdentity>

ArmUserIdentity

Nazwa	Typ	Opis
clientId	string
principalId	string

AuthenticationType

Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.

Nazwa	Typ	Opis
identityBased	string
keyBased	string

authenticationType

Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus

Nazwa	Typ	Opis
identityBased	string
keyBased	string

Capabilities

Możliwości i funkcje włączone dla centrum IoT.

Nazwa	Typ	Opis
DeviceManagement	string
None	string

CloudToDeviceProperties

Właściwości komunikatów z chmury do urządzenia w usłudze IoT Hub.

Nazwa	Typ	Opis
defaultTtlAsIso8601	string	Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Właściwości kolejki opinii dla komunikatów z chmury do urządzenia.
maxDeliveryCount	integer	Maksymalna liczba dostarczania komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Domyślna akcja dla zestawu reguł sieciowych

Nazwa	Typ	Opis
Allow	string
Deny	string

EnrichmentProperties

Właściwości wzbogacania, które centrum IoT ma zastosowanie do komunikatów dostarczanych do punktów końcowych.

Nazwa	Typ	Opis
endpointNames	string[]	Lista punktów końcowych, dla których wzbogacenie jest stosowane do komunikatu.
key	string	Klucz lub nazwa właściwości wzbogacania.
value	string	Wartość właściwości wzbogacania.

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

EventHubProperties

Właściwości aprowizowanego punktu końcowego zgodnego z centrum zdarzeń używanego przez centrum IoT Hub.

Nazwa	Typ	Opis
endpoint	string	Punkt końcowy zgodny z centrum zdarzeń.
partitionCount	integer	Liczba partycji do odbierania komunikatów z urządzenia do chmury w punkcie końcowym zgodnym z centrum zdarzeń. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Identyfikatory partycji w punkcie końcowym zgodnym z centrum zdarzeń.
path	string	Nazwa zgodna z centrum zdarzeń.
retentionTimeInDays	integer	Czas przechowywania komunikatów z urządzenia do chmury w dniach. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Właściwości trasy rezerwowej. IoT Hub używa tych właściwości, gdy kieruje komunikaty do rezerwowego punktu końcowego.

Nazwa	Typ	Opis
condition	string	Warunek, który jest oceniany w celu zastosowania trasy powrotu. Jeśli warunek nie zostanie podany, zostanie on obliczony domyślnie na wartość true. W przypadku gramatyki zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko 1 punkt końcowy.
isEnabled	boolean	Służy do określania, czy trasa rezerwowa jest włączona.
name	string	Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa.
source	RoutingSource	Źródło, do którego ma zostać zastosowana reguła routingu. Na przykład DeviceMessages

FeedbackProperties

Właściwości kolejki opinii dla komunikatów z chmury do urządzenia.

Nazwa	Typ	Opis
lockDurationAsIso8601	string	Czas trwania blokady kolejki opinii. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer	Liczba prób dostarczenia komunikatu w kolejce opinii przez centrum IoT Hub. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string	Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Opis centrum IoT.

Nazwa	Typ	Opis
etag	string	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.
id	string	Identyfikator zasobu.
identity	ArmIdentity	Tożsamości zarządzane dla usługi IotHub.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties	IotHubProperties	Właściwości usługi IotHub
sku	IotHubSkuInfo	Informacje o jednostce SKU usługi IotHub
systemData	systemData	Metadane systemowe odnoszące się do tego zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

IotHubDescriptionListResult

Tablica serializowana w formacie JSON obiektów IotHubDescription z następnym linkiem.

Nazwa	Typ	Opis
nextLink	string	Następny link.
value	IotHubDescription[]	Tablica obiektów IotHubDescription.

IotHubLocationDescription

Publiczna reprezentacja jednej z lokalizacji, w których aprowizowany jest zasób.

Nazwa	Typ	Opis
location	string	Nazwa regionu świadczenia usługi Azure
role	IotHubReplicaRoleType	Rola regionu może być podstawowa lub pomocnicza. Region podstawowy to miejsce, w którym jest obecnie aprowizowane centrum IoT. Region pomocniczy to sparowany region odzyskiwania po awarii platformy Azure, a także region, w którym centrum IoT może przejść w tryb failover.

IotHubProperties

Właściwości centrum IoT.

Nazwa	Typ	Opis
allowedFqdnList	string[]	Lista dozwolonych nazw FQDN (w pełni kwalifikowana nazwa domeny) dla ruchu wychodzącego z usługi IoT Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Zasady dostępu współdzielonego, których można użyć do zabezpieczenia połączenia z centrum IoT.
cloudToDevice	CloudToDeviceProperties	Właściwości obsługi komunikatów z chmury do urządzenia w usłudze IoT Hub.
comments	string	Komentarze do centrum IoT Hub.
disableDeviceSAS	boolean	Jeśli to prawda, nie można używać wszystkich urządzeń (w tym urządzeń brzegowych, ale z wyłączeniem modułów) kluczy SAS w zakresie.
disableLocalAuth	boolean	Jeśli to prawda, tokeny SAS z kluczami sygnatur dostępu współdzielonego o zakresie usługi Iot Hub nie mogą być używane do uwierzytelniania.
disableModuleSAS	boolean	Jeśli to prawda, nie można użyć wszystkich kluczy SAS o zakresie modułu do uwierzytelniania.
enableDataResidency	boolean	Ta właściwość po ustawieniu wartości true włączy rezydencję danych, co spowoduje wyłączenie odzyskiwania po awarii.
enableFileUploadNotifications	boolean	Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone.
eventHubEndpoints	<string,  EventHubProperties>	Właściwości punktu końcowego zgodnego z centrum zdarzeń. Jedynymi możliwymi kluczami do tego słownika są zdarzenia. Ten klucz musi być obecny w słowniku podczas tworzenia lub aktualizowania wywołań dla centrum IoT.
features	Capabilities	Możliwości i funkcje włączone dla centrum IoT.
hostName	string	Nazwa hosta.
ipFilterRules	IpFilterRule[]	Reguły filtrowania adresów IP.
locations	IotHubLocationDescription[]	Lokalizacja podstawowa i pomocnicza dla centrum iot
messagingEndpoints	<string,  MessagingEndpointProperties>	Właściwości punktu końcowego obsługi komunikatów dla kolejki powiadomień przekazywania plików.
minTlsVersion	string	Określa minimalną wersję protokołu TLS do obsługi dla tego centrum. Można ustawić wartość "1.2", aby klienci korzystający z protokołu TLS w wersji starszej niż 1.2 zostali odrzuceni.
networkRuleSets	NetworkRuleSetProperties	Właściwości zestawu reguł sieciowych usługi IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub
provisioningState	string	Stan aprowizacji.
publicNetworkAccess	PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
restrictOutboundNetworkAccess	boolean	W przypadku wartości true ruch wychodzący z usługi IotHub będzie ograniczony tylko do dozwolonych nazw FQDN skonfigurowanych za pośrednictwem listy allowedFqdnList.
routing	RoutingProperties	Właściwości powiązane z routingiem centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Stan centrum.
storageEndpoints	<string,  StorageEndpointProperties>	Lista punktów końcowych usługi Azure Storage, w których można przekazywać pliki. Obecnie można skonfigurować tylko jedno konto usługi Azure Storage i musi mieć jego klucz jako $default. Określenie więcej niż jednego konta magazynu powoduje zgłoszenie błędu. Nie określono wartości dla tej właściwości, gdy właściwość enableFileUploadNotifications jest ustawiona na wartość True, powoduje zgłoszenie błędu.

IotHubReplicaRoleType

Rola regionu może być podstawowa lub pomocnicza. Region podstawowy to miejsce, w którym jest obecnie aprowizowane centrum IoT. Region pomocniczy to sparowany region odzyskiwania po awarii platformy Azure, a także region, w którym centrum IoT może przejść w tryb failover.

Nazwa	Typ	Opis
primary	string
secondary	string

IotHubSku

Nazwa jednostki SKU.

Nazwa	Typ	Opis
B1	string
B2	string
B3	string
F1	string
S1	string
S2	string
S3	string

IotHubSkuInfo

Informacje o jednostce SKU centrum IoT.

Nazwa	Typ	Opis
capacity	integer	Liczba aprowizowania jednostek IoT Hub. Zobacz: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Nazwa jednostki SKU.
tier	IotHubSkuTier	Warstwa rozliczeń dla centrum IoT.

IotHubSkuTier

Warstwa rozliczeń centrum IoT.

Nazwa	Typ	Opis
Basic	string
Free	string
Standard	string

IpFilterActionType

Żądana akcja żądań przechwyconych przez tę regułę.

Nazwa	Typ	Opis
Accept	string
Reject	string

IpFilterRule

Reguły filtrowania adresów IP dla centrum IoT.

Nazwa	Typ	Opis
action	IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
filterName	string	Nazwa reguły filtrowania adresów IP.
ipMask	string	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.

ManagedIdentity

Właściwości tożsamości zarządzanej.

Nazwa	Typ	Opis
userAssignedIdentity	string	Tożsamość przypisana przez użytkownika.

MessagingEndpointProperties

Właściwości punktów końcowych obsługi komunikatów używanych przez to centrum IoT.

Nazwa	Typ	Opis
lockDurationAsIso8601	string	Czas trwania blokady. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer	Liczba prób dostarczenia komunikatu przez centrum IoT Hub. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string	Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Akcja filtru IP

Nazwa	Typ	Opis
Allow	string

NetworkRuleSetIpRule

Reguła adresu IP, która ma być stosowana w ramach zestawu reguł sieciowych

Nazwa	Typ	Domyślna wartość	Opis
action	NetworkRuleIPAction	Allow	Akcja filtru IP
filterName	string		Nazwa reguły filtrowania adresów IP.
ipMask	string		Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.

NetworkRuleSetProperties

Właściwości zestawu reguł sieciowych usługi IotHub

Nazwa	Typ	Domyślna wartość	Opis
applyToBuiltInEventHubEndpoint	boolean		Jeśli wartość True, zestaw reguł sieci jest również stosowany do aplikacji BuiltIn EventHub EndPoint of IotHub
defaultAction	DefaultAction	Deny	Domyślna akcja dla zestawu reguł sieci
ipRules	NetworkRuleSetIpRule[]		Lista reguł adresów IP

PrivateEndpoint

Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego usługi IotHub

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties	PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
type	string	Typ zasobu.

PrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
privateEndpoint	PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionState

Bieżący stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
actionsRequired	string	Akcje wymagane dla połączenia prywatnego punktu końcowego
description	string	Opis bieżącego stanu połączenia prywatnego punktu końcowego
status	PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

Nazwa	Typ	Opis
Disabled	string
Enabled	string

ResourceIdentityType

Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie tożsamości z usługi.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RouteProperties

Właściwości reguły routingu używanej przez centrum IoT do kierowania komunikatów do punktów końcowych.

Nazwa	Typ	Opis
condition	string	Warunek, który jest oceniany w celu zastosowania reguły routingu. Jeśli nie podano warunku, wartość jest domyślnie obliczana na wartość true. Aby uzyskać gramatykę, zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko jeden punkt końcowy.
isEnabled	boolean	Służy do określania, czy trasa jest włączona.
name	string	Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa.
source	RoutingSource	Źródłem, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages.

RoutingCosmosDBSqlApiProperties

Właściwości związane z punktem końcowym kontenera sql usługi Cosmos DB.

Nazwa	Typ	Opis
authenticationType	authenticationType	Metoda używana do uwierzytelniania względem punktu końcowego kontenera sql usługi Cosmos DB
containerName	string	Nazwa kontenera sql usługi Cosmos DB w bazie danych cosmos DB.
databaseName	string	Nazwa bazy danych cosmos DB na koncie usługi Cosmos DB.
endpointUri	string	Adres URL konta usługi Cosmos DB. Musi zawierać protokół https://
id	string	Identyfikator punktu końcowego kontenera sql usługi Cosmos DB
identity	ManagedIdentity	Właściwości tożsamości zarządzanej dotyczące routingu punktu końcowego kontenera usługi Cosmos DB.
name	string	Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych.
partitionKeyName	string	Nazwa klucza partycji skojarzonego z tym kontenerem sql usługi Cosmos DB, jeśli istnieje. Jest to opcjonalny parametr.
partitionKeyTemplate	string	Szablon służący do generowania syntetycznej wartości klucza partycji do użycia z tym kontenerem sql usługi Cosmos DB. Szablon musi zawierać co najmniej jeden z następujących symboli zastępczych: {iothub}, {deviceid}, {DD}, {MM}i {RRRR}. Każdy symbol zastępczy może być określony co najwyżej raz, ale składniki kolejności i symboli zastępczych są dowolne. Ten parametr jest wymagany tylko wtedy, gdy określono parametr PartitionKeyName.
primaryKey	string	Klucz podstawowy konta usługi Cosmos DB.
resourceGroup	string	Nazwa grupy zasobów konta usługi Cosmos DB.
secondaryKey	string	Klucz pomocniczy konta usługi Cosmos DB.
subscriptionId	string	Identyfikator subskrypcji konta usługi Cosmos DB.

RoutingEndpoints

Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów.

Nazwa	Typ	Opis
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Lista punktów końcowych kontenera usługi Cosmos DB, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu.
eventHubs	RoutingEventHubProperties[]	Lista punktów końcowych usługi Event Hubs, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. Ta lista nie zawiera wbudowanego punktu końcowego usługi Event Hubs.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Lista punktów końcowych kolejki usługi Service Bus, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Lista punktów końcowych tematu usługi Service Bus, do których centrum IoT kieruje komunikaty na podstawie reguł routingu.
storageContainers	RoutingStorageContainerProperties[]	Lista punktów końcowych kontenera magazynu, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu.

RoutingEventHubProperties

Właściwości związane z punktem końcowym centrum zdarzeń.

Nazwa	Typ	Opis
authenticationType	authenticationType	Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń
connectionString	string	Parametry połączenia punktu końcowego centrum zdarzeń.
endpointUri	string	Adres URL punktu końcowego centrum zdarzeń. Musi zawierać protokół sb://
entityPath	string	Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń
id	string	Identyfikator punktu końcowego centrum zdarzeń
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń routingu.
name	string	Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych.
resourceGroup	string	Nazwa grupy zasobów punktu końcowego centrum zdarzeń.
subscriptionId	string	Identyfikator subskrypcji punktu końcowego centrum zdarzeń.

RoutingProperties

Właściwości powiązane z routingiem centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Nazwa	Typ	Opis
endpoints	RoutingEndpoints	Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów.
enrichments	EnrichmentProperties[]	Lista wzbogacenia udostępnianych przez użytkownika, które centrum IoT ma zastosowanie do komunikatów dostarczanych do wbudowanych i niestandardowych punktów końcowych. Zobacz: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Właściwości trasy, która jest używana jako trasa rezerwowa, gdy żaden z warunków określonych w sekcji "trasy" nie jest spełniony. Jest to opcjonalny parametr. Jeśli ta właściwość nie jest obecna w szablonie, trasa rezerwowa jest domyślnie wyłączona.
routes	RouteProperties[]	Lista reguł routingu udostępnianych przez użytkownika używanych przez centrum IoT do kierowania komunikatów do wbudowanych i niestandardowych punktów końcowych. Dla płatnych centrów dozwolone jest maksymalnie 100 reguł routingu, a dla bezpłatnych centrów dozwolone jest maksymalnie 5 reguł routingu.

RoutingServiceBusQueueEndpointProperties

Właściwości związane z typami punktów końcowych kolejki usługi Service Bus.

Nazwa	Typ	Opis
authenticationType	authenticationType	Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus
connectionString	string	Parametry połączenia punktu końcowego kolejki usługi Service Bus.
endpointUri	string	Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać protokół sb://
entityPath	string	Nazwa kolejki w przestrzeni nazw usługi Service Bus
id	string	Identyfikator punktu końcowego kolejki usługi Service Bus
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus.
name	string	Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa kolejki.
resourceGroup	string	Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus.
subscriptionId	string	Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus.

RoutingServiceBusTopicEndpointProperties

Właściwości związane z typami punktów końcowych tematu usługi Service Bus.

Nazwa	Typ	Opis
authenticationType	authenticationType	Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus
connectionString	string	Parametry połączenia punktu końcowego tematu usługi Service Bus.
endpointUri	string	Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać protokół sb://
entityPath	string	Nazwa kolejki w temacie usługi Service Bus
id	string	Identyfikator punktu końcowego tematu usługi Service Bus
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus routingu.
name	string	Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa tematu.
resourceGroup	string	Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus.
subscriptionId	string	Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus.

RoutingSource

Źródłem, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages.

Nazwa	Typ	Opis
DeviceConnectionStateEvents	string
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingStorageContainerProperties

Właściwości związane z punktem końcowym kontenera magazynu.

Nazwa	Typ	Opis
authenticationType	authenticationType	Metoda używana do uwierzytelniania w punkcie końcowym magazynu
batchFrequencyInSeconds	integer	Interwał czasu, w którym obiekty blob są zapisywane w magazynie. Wartość powinna wynosić od 60 do 720 sekund. Wartość domyślna to 300 sekund.
connectionString	string	Parametry połączenia konta magazynu.
containerName	string	Nazwa kontenera magazynu na koncie magazynu.
encoding	enum: Avro AvroDeflate JSON	Kodowanie używane do serializacji komunikatów do obiektów blob. Obsługiwane wartości to "avro", "avrodeflate" i "JSON". Wartość domyślna to "avro".
endpointUri	string	Adres URL punktu końcowego magazynu. Musi zawierać protokół https://
fileNameFormat	string	Format nazwy pliku dla obiektu blob. Domyślny format to {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}.{mm}. Wszystkie parametry są obowiązkowe, ale można zmienić kolejność.
id	string	Identyfikator punktu końcowego kontenera magazynu
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego magazynu routingu.
maxChunkSizeInBytes	integer	Maksymalna liczba bajtów dla każdego obiektu blob zapisanego w magazynie. Wartość powinna należeć do 10485760 (10 MB) i 524288000(500 MB). Wartość domyślna to 314572800 (300 MB).
name	string	Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych.
resourceGroup	string	Nazwa grupy zasobów konta magazynu.
subscriptionId	string	Identyfikator subskrypcji konta magazynu.

SharedAccessSignatureAuthorizationRule

Właściwości zasad dostępu współdzielonego centrum IoT.

Nazwa	Typ	Opis
keyName	string	Nazwa zasad dostępu współdzielonego.
primaryKey	string	Klucz podstawowy.
rights	AccessRights	Uprawnienia przypisane do zasad dostępu współdzielonego.
secondaryKey	string	Klucz pomocniczy.

StorageEndpointProperties

Właściwości punktu końcowego usługi Azure Storage na potrzeby przekazywania plików.

Nazwa	Typ	Opis
authenticationType	AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
connectionString	string	Parametry połączenia dla konta usługi Azure Storage, do którego są przekazywane pliki.
containerName	string	Nazwa kontenera głównego, w którym są przekazywane pliki. Kontener nie musi istnieć, ale powinien być creatable przy użyciu określonego parametru connectionString.
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego magazynu na potrzeby przekazywania plików.
sasTtlAsIso8601	string	Okres, dla którego identyfikator URI sygnatury dostępu współdzielonego wygenerowany przez IoT Hub przekazywania plików jest prawidłowy. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.