Iot Hub Resource - Get

Referencia

Szolgáltatás:: IoT Hub

API-verzió:: 2023-06-30

IoT Hub nem biztonsággal kapcsolatos metaadatainak lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az IoT Hubot tartalmazó erőforráscsoport neve.
resourceName	path	True	string	Az IoT Hub neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Válaszok

Name	Típus	Description
200 OK	IotHubDescription	A törzs tartalmazza az IoT Hub összes nem biztonsági tulajdonságát. A biztonsággal kapcsolatos tulajdonságok értéke null.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

IotHubResource_Get

Mintakérelem

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


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.iothub import IotHubClient

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

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


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

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


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

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

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.json
func ExampleResourceClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceClient().Get(ctx, "myResourceGroup", "testHub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Description = armiothub.Description{
	// 	Name: to.Ptr("testHub"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 	ID: to.Ptr("/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("AAAAAAFD6M4="),
	// 	Properties: &armiothub.Properties{
	// 		CloudToDevice: &armiothub.CloudToDeviceProperties{
	// 			DefaultTTLAsIso8601: to.Ptr("PT1H"),
	// 			Feedback: &armiothub.FeedbackProperties{
	// 				LockDurationAsIso8601: to.Ptr("PT1M"),
	// 				MaxDeliveryCount: to.Ptr[int32](10),
	// 				TTLAsIso8601: to.Ptr("PT1H"),
	// 			},
	// 			MaxDeliveryCount: to.Ptr[int32](10),
	// 		},
	// 		EnableFileUploadNotifications: to.Ptr(false),
	// 		EventHubEndpoints: map[string]*armiothub.EventHubProperties{
	// 			"events": &armiothub.EventHubProperties{
	// 				Path: to.Ptr("iot-dps-cit-hub-1"),
	// 				Endpoint: to.Ptr("sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"),
	// 				PartitionCount: to.Ptr[int32](2),
	// 				PartitionIDs: []*string{
	// 					to.Ptr("0"),
	// 					to.Ptr("1")},
	// 					RetentionTimeInDays: to.Ptr[int64](1),
	// 				},
	// 			},
	// 			Features: to.Ptr(armiothub.CapabilitiesNone),
	// 			HostName: to.Ptr("iot-dps-cit-hub-1.azure-devices.net"),
	// 			IPFilterRules: []*armiothub.IPFilterRule{
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule1"),
	// 					IPMask: to.Ptr("131.117.159.53"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armiothub.IPFilterActionTypeAccept),
	// 					FilterName: to.Ptr("rule2"),
	// 					IPMask: to.Ptr("157.55.59.128/25"),
	// 			}},
	// 			Locations: []*armiothub.LocationDescription{
	// 				{
	// 					Location: to.Ptr("West US"),
	// 					Role: to.Ptr(armiothub.IotHubReplicaRoleTypePrimary),
	// 				},
	// 				{
	// 					Location: to.Ptr("East US"),
	// 					Role: to.Ptr(armiothub.IotHubReplicaRoleTypeSecondary),
	// 			}},
	// 			MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
	// 				"fileNotifications": &armiothub.MessagingEndpointProperties{
	// 					LockDurationAsIso8601: to.Ptr("PT1M"),
	// 					MaxDeliveryCount: to.Ptr[int32](10),
	// 					TTLAsIso8601: to.Ptr("PT1H"),
	// 				},
	// 			},
	// 			MinTLSVersion: to.Ptr("1.2"),
	// 			NetworkRuleSets: &armiothub.NetworkRuleSetProperties{
	// 				ApplyToBuiltInEventHubEndpoint: to.Ptr(true),
	// 				DefaultAction: to.Ptr(armiothub.DefaultActionDeny),
	// 				IPRules: []*armiothub.NetworkRuleSetIPRule{
	// 					{
	// 						Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
	// 						FilterName: to.Ptr("rule1"),
	// 						IPMask: to.Ptr("131.117.159.53"),
	// 					},
	// 					{
	// 						Action: to.Ptr(armiothub.NetworkRuleIPActionAllow),
	// 						FilterName: to.Ptr("rule2"),
	// 						IPMask: to.Ptr("157.55.59.128/25"),
	// 				}},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			Routing: &armiothub.RoutingProperties{
	// 				Endpoints: &armiothub.RoutingEndpoints{
	// 					EventHubs: []*armiothub.RoutingEventHubProperties{
	// 					},
	// 					ServiceBusQueues: []*armiothub.RoutingServiceBusQueueEndpointProperties{
	// 					},
	// 					ServiceBusTopics: []*armiothub.RoutingServiceBusTopicEndpointProperties{
	// 					},
	// 					StorageContainers: []*armiothub.RoutingStorageContainerProperties{
	// 					},
	// 				},
	// 				FallbackRoute: &armiothub.FallbackRouteProperties{
	// 					Condition: to.Ptr("true"),
	// 					EndpointNames: []*string{
	// 						to.Ptr("events")},
	// 						IsEnabled: to.Ptr(true),
	// 						Source: to.Ptr(armiothub.RoutingSourceDeviceMessages),
	// 					},
	// 					Routes: []*armiothub.RouteProperties{
	// 					},
	// 				},
	// 				State: to.Ptr("Active"),
	// 				StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
	// 					"$default": &armiothub.StorageEndpointProperties{
	// 						ConnectionString: to.Ptr(""),
	// 						ContainerName: to.Ptr(""),
	// 						SasTTLAsIso8601: to.Ptr("PT1H"),
	// 					},
	// 				},
	// 			},
	// 			SKU: &armiothub.SKUInfo{
	// 				Name: to.Ptr(armiothub.IotHubSKUS1),
	// 				Capacity: to.Ptr[int64](1),
	// 				Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
	// 			},
	// 			SystemData: &armiothub.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:28:38.963Z"); return t}()),
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Get the non-security related metadata of an IoT hub.
 *
 * @summary Get the non-security related metadata of an IoT hub.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.json
 */
async function iotHubResourceGet() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.get(resourceGroupName, resourceName);
  console.log(result);
}

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

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_get.json
// this example is just showing the usage of "IotHubResource_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this IotHubDescriptionResource
IotHubDescriptionCollection collection = resourceGroupResource.GetIotHubDescriptions();

// invoke the operation
string resourceName = "testHub";
NullableResponse<IotHubDescriptionResource> response = await collection.GetIfExistsAsync(resourceName);
IotHubDescriptionResource result = response.HasValue ? response.Value : null;

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

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

Mintaválasz

Állapotkód:: 200

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "locations": [
      {
        "location": "West US",
        "role": "primary"
      },
      {
        "location": "East US",
        "role": "secondary"
      }
    ],
    "minTlsVersion": "1.2"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definíciók

Name	Description
AccessRights	A megosztott hozzáférési szabályzathoz rendelt engedélyek.
ArmIdentity
ArmUserIdentity
AuthenticationType	Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust.
authenticationType	A service bus-üzenetsorvégponton történő hitelesítéshez használt módszer
Capabilities	Az IoT Hubhoz engedélyezett képességek és funkciók.
CloudToDeviceProperties	Az IoT Hub felhőalapú üzenetkezelési tulajdonságai.
createdByType	Az erőforrást létrehozó identitás típusa.
DefaultAction	Hálózati szabálykészlet alapértelmezett művelete
EnrichmentProperties	Az IoT Hub által a végpontokra küldött üzenetekre vonatkozó bővítés tulajdonságai.
ErrorDetails	Hiba részletei.
EventHubProperties	Az IoT Hub által használt kiépített Event Hub-kompatibilis végpont tulajdonságai.
FallbackRouteProperties	A tartalék útvonal tulajdonságai. Az IoT Hub ezeket a tulajdonságokat használja, amikor az üzeneteket a tartalék végpontra irányítja.
FeedbackProperties	A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.
IotHubDescription	Az IoT Hub leírása.
IotHubLocationDescription	Az erőforrás üzembe helyezésének egyik helyének nyilvános ábrázolása.
IotHubProperties	Az IoT Hub tulajdonságai.
IotHubReplicaRoleType	A régió szerepe lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure Vészhelyreállítás (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet.
IotHubSku	Az termékváltozat neve.
IotHubSkuInfo	Információk az IoT Hub termékváltozatáról.
IotHubSkuTier	Az IoT Hub számlázási szintje.
IpFilterActionType	A szabály által rögzített kérések kívánt művelete.
IpFilterRule	Az IoT Hub IP-szűrési szabályai.
ManagedIdentity	A felügyelt identitás tulajdonságai.
MessagingEndpointProperties	Az IoT Hub által használt üzenetkezelési végpontok tulajdonságai.
NetworkRuleIPAction	IP-szűrési művelet
NetworkRuleSetIpRule	A hálózati szabálykészlet részeként alkalmazandó IP-szabály
NetworkRuleSetProperties	Az IotHub hálózati szabálykészletének tulajdonságai
PrivateEndpoint	A privát végpontkapcsolat privát végponttulajdonsága
PrivateEndpointConnection	Egy IotHub privát végpontkapcsolata
PrivateEndpointConnectionProperties	A privát végpontkapcsolat tulajdonságai
PrivateLinkServiceConnectionState	Privát végpontkapcsolat aktuális állapota
PrivateLinkServiceConnectionStatus	Privát végpontkapcsolat állapota
PublicNetworkAccess	A nyilvános hálózatról érkező kérések engedélyezése
ResourceIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
RouteProperties	Az IoT Hub által használt útválasztási szabály tulajdonságai az üzenetek végpontokhoz való átirányításához.
RoutingCosmosDBSqlApiProperties	A cosmos DB SQL-tárolóvégponthoz kapcsolódó tulajdonságok.
RoutingEndpoints	Azokhoz az egyéni végpontokhoz kapcsolódó tulajdonságok, amelyekhez az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok összes végponttípusában legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípuson.
RoutingEventHubProperties	Az eseményközpont végpontjaihoz kapcsolódó tulajdonságok.
RoutingProperties	Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	A Service Bus-üzenetsor végponttípusaihoz kapcsolódó tulajdonságok.
RoutingServiceBusTopicEndpointProperties	A Service Bus-témakör végponttípusaihoz kapcsolódó tulajdonságok.
RoutingSource	Az útválasztási szabályt alkalmazni kívánt forrás, például a DeviceMessages.
RoutingStorageContainerProperties	A tárolóvégponthoz kapcsolódó tulajdonságok.
SharedAccessSignatureAuthorizationRule	Az IoT Hub megosztott hozzáférési szabályzatának tulajdonságai.
StorageEndpointProperties	Az Azure Storage-végpont tulajdonságai a fájlfeltöltéshez.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AccessRights

Enumerálás

A megosztott hozzáférési szabályzathoz rendelt engedélyek.

Érték	Description
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ArmIdentity

Objektum

Name	Típus	Description
principalId	string	Egyszerű azonosító
tenantId	string	Bérlőazonosító
type	ResourceIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Objektum

Name	Típus	Description
clientId	string
principalId	string

AuthenticationType

Enumerálás

Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust.

Érték	Description
identityBased
keyBased

authenticationType

Enumerálás

A service bus-üzenetsorvégponton történő hitelesítéshez használt módszer

Érték	Description
identityBased
keyBased

Capabilities

Enumerálás

Az IoT Hubhoz engedélyezett képességek és funkciók.

Érték	Description
DeviceManagement
None

CloudToDeviceProperties

Objektum

Az IoT Hub felhőalapú üzenetkezelési tulajdonságai.

Name	Típus	Description
defaultTtlAsIso8601	string (duration)	A felhőből az eszközre irányuló üzenetek alapértelmezett élettartama az eszközsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	A felhőből az eszközre irányuló üzenetek maximális kézbesítési száma az eszközsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

DefaultAction

Enumerálás

Hálózati szabálykészlet alapértelmezett művelete

Érték	Description
Allow
Deny

EnrichmentProperties

Objektum

Az IoT Hub által a végpontokra küldött üzenetekre vonatkozó bővítés tulajdonságai.

Name	Típus	Description
endpointNames	string[]	Azon végpontok listája, amelyekre a bővítés vonatkozik az üzenetre.
key	string	A bővítési tulajdonság kulcsa vagy neve.
value	string	A bővítési tulajdonság értéke.

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

EventHubProperties

Objektum

Az IoT Hub által használt kiépített Event Hub-kompatibilis végpont tulajdonságai.

Name	Típus	Description
endpoint	string	Az Event Hub-kompatibilis végpont.
partitionCount	integer (int32)	Az Event Hub-kompatibilis végponton az eszközről a felhőbe irányuló üzenetek fogadására szolgáló partíciók száma. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Az Event Hub-kompatibilis végpont partícióazonosítói.
path	string	Az Event Hub-kompatibilis név.
retentionTimeInDays	integer (int64)	Az eszközről a felhőbe irányuló üzenetek megőrzési ideje napokban. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Objektum

A tartalék útvonal tulajdonságai. Az IoT Hub ezeket a tulajdonságokat használja, amikor az üzeneteket a tartalék végpontra irányítja.

Name	Típus	Description
condition	string	A tartalék útvonal alkalmazásához kiértékelt feltétel. Ha a feltétel nincs megadva, alapértelmezés szerint igaz értékre lesz kiértékelve. A nyelvhelyességről lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Azon végpontok listája, amelyekhez a feltételnek megfelelő üzeneteket irányítja a rendszer. Jelenleg csak 1 végpont engedélyezett.
isEnabled	boolean	Annak megadására szolgál, hogy a tartalék útvonal engedélyezve van-e.
name	string	Az útvonal neve. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie.
source	RoutingSource	Az a forrás, amelyre az útválasztási szabályt alkalmazni kell. Például: DeviceMessages

FeedbackProperties

Objektum

A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.

Name	Típus	Description
lockDurationAsIso8601	string (duration)	A visszajelzési üzenetsor zárolási időtartama. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Az IoT Hub hányszor kísérel meg üzenetet küldeni a visszajelzési üzenetsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Az az időtartam, amelyre egy üzenet felhasználható, mielőtt az IoT Hub lejárt volna. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Objektum

Az IoT Hub leírása.

Name	Típus	Description
etag	string	Az Etag mező nem kötelező. Ha a válasz törzsében meg van adva, akkor fejlécként is meg kell adni a normál ETag-konvencióban.
id	string	Az erőforrás azonosítója.
identity	ArmIdentity	Az IotHub felügyelt identitásai.
location	string	Az erőforrás helye.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Az erőforrás neve.
properties	IotHubProperties	IotHub-tulajdonságok
sku	IotHubSkuInfo	IotHub termékváltozat adatai
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
tags	object	Az erőforráscímkék.
type	string	Az erőforrás típusa.

IotHubLocationDescription

Objektum

Az erőforrás üzembe helyezésének egyik helyének nyilvános ábrázolása.

Name	Típus	Description
location	string	Az Azure-régió neve
role	IotHubReplicaRoleType	A régió szerepe lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure Vészhelyreállítás (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet.

IotHubProperties

Objektum

Az IoT Hub tulajdonságai.

Name	Típus	Description
allowedFqdnList	string[]	Az Iot Hubról történő kimenő forgalomhoz engedélyezett teljes tartománynevek (teljes tartománynév) listája.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Az IoT Hubhoz való csatlakozás biztonságossá tételéhez használható közös hozzáférési szabályzatok.
cloudToDevice	CloudToDeviceProperties	Az IoT Hub felhőalapú üzenetkezelési tulajdonságai.
comments	string	IoT Hub-megjegyzések.
disableDeviceSAS	boolean	Ha igaz, az összes eszköz (beleértve az Edge-eszközöket is, de a modulok kivételével) hatókörébe tartozó SAS-kulcsok nem használhatók a hitelesítéshez.
disableLocalAuth	boolean	Ha igaz, az Iot Hub hatókörű SAS-kulcsokkal rendelkező SAS-jogkivonatok nem használhatók hitelesítésre.
disableModuleSAS	boolean	Ha igaz, a modul hatókörébe tartozó SAS-kulcsok nem használhatók hitelesítéshez.
enableDataResidency	boolean	Ez a tulajdonság, ha igaz értékre van állítva, engedélyezi az adattárolást, így letiltja a vészhelyreállítást.
enableFileUploadNotifications	boolean	Ha igaz, a fájlfeltöltési értesítések engedélyezve vannak.
eventHubEndpoints	<string, EventHubProperties>	Az Event Hub-kompatibilis végpont tulajdonságai. A szótár egyetlen lehetséges kulcsa az események. Ennek a kulcsnak szerepelnie kell a szótárban az IoT Hub hívásainak létrehozása vagy frissítése során.
features	Capabilities	Az IoT Hubhoz engedélyezett képességek és funkciók.
hostName	string	A gazdagép neve.
ipFilterRules	IpFilterRule[]	Az IP-szűrési szabályok.
locations	IotHubLocationDescription[]	Az iot hub elsődleges és másodlagos helye
messagingEndpoints	<string, MessagingEndpointProperties>	A fájlfeltöltési értesítési üzenetsor üzenetkezelési végpontjának tulajdonságai.
minTlsVersion	string	Megadja a központ számára támogatott minimális TLS-verziót. Az "1.2" értékre állítható be, hogy az 1.2-esnél kisebb TLS-verziót használó ügyfelek elutasíthatók legyenek.
networkRuleSets	NetworkRuleSetProperties	Az IotHub hálózati szabálykészletének tulajdonságai
privateEndpointConnections	PrivateEndpointConnection[]	Ezen az IotHubon létrehozott privát végpontkapcsolatok
provisioningState	string	A kiépítési állapot.
publicNetworkAccess	PublicNetworkAccess	A nyilvános hálózatról érkező kérések engedélyezése
restrictOutboundNetworkAccess	boolean	Ha igaz, az IotHubról való kimenő forgalom csak az engedélyezett teljes tartománynevekre lesz korlátozva, amelyek az allowedFqdnList használatával vannak konfigurálva.
routing	RoutingProperties	Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	A központi állapot.
storageEndpoints	<string, StorageEndpointProperties>	Az Azure Storage-végpontok listája, ahol fájlokat tölthet fel. Jelenleg csak egy Azure Storage-fiókot konfigurálhat, és a kulcsának $default kell lennie. Ha egynél több tárfiókot ad meg, hiba történik. Ha nem ad meg értéket ennek a tulajdonságnak, ha az enableFileUploadNotifications tulajdonság értéke True( Igaz) értékre van állítva, a rendszer hibát jelez.

IotHubReplicaRoleType

Enumerálás

A régió szerepe lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure Vészhelyreállítás (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet.

Érték	Description
primary
secondary

IotHubSku

Enumerálás

Az termékváltozat neve.

Érték	Description
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Objektum

Információk az IoT Hub termékváltozatáról.

Name	Típus	Description
capacity	integer (int64)	A kiépített IoT Hub-egységek száma. Lásd: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Az termékváltozat neve.
tier	IotHubSkuTier	Az IoT Hub számlázási szintje.

IotHubSkuTier

Enumerálás

Az IoT Hub számlázási szintje.

Érték	Description
Basic
Free
Standard

IpFilterActionType

Enumerálás

A szabály által rögzített kérések kívánt művelete.

Érték	Description
Accept
Reject

IpFilterRule

Objektum

Az IoT Hub IP-szűrési szabályai.

Name	Típus	Description
action	IpFilterActionType	A szabály által rögzített kérések kívánt művelete.
filterName	string	Az IP-szűrőszabály neve.
ipMask	string	A szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazó sztring.

ManagedIdentity

Objektum

A felügyelt identitás tulajdonságai.

Name	Típus	Description
userAssignedIdentity	string	A felhasználó által hozzárendelt identitás.

MessagingEndpointProperties

Objektum

Az IoT Hub által használt üzenetkezelési végpontok tulajdonságai.

Name	Típus	Description
lockDurationAsIso8601	string (duration)	A zárolás időtartama. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Az IoT Hub hányszor kísérel meg üzenetet kézbesíteni. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Az az időtartam, amelyre egy üzenet felhasználható, mielőtt az IoT Hub lejárt volna. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Enumerálás

IP-szűrési művelet

Érték	Description
Allow

NetworkRuleSetIpRule

Objektum

A hálózati szabálykészlet részeként alkalmazandó IP-szabály

Name	Típus	Alapértelmezett érték	Description
action	NetworkRuleIPAction	Allow	IP-szűrési művelet
filterName	string		Az IP-szűrőszabály neve.
ipMask	string		A szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazó sztring.

NetworkRuleSetProperties

Objektum

Az IotHub hálózati szabálykészletének tulajdonságai

Name	Típus	Alapértelmezett érték	Description
applyToBuiltInEventHubEndpoint	boolean		Ha igaz, akkor a rendszer a hálózati szabálykészletet is alkalmazza az IotHub BuiltIn EventHub EndPointjára
defaultAction	DefaultAction	Deny	Hálózati szabálykészlet alapértelmezett művelete
ipRules	NetworkRuleSetIpRule[]		IP-szabályok listája

PrivateEndpoint

Objektum

A privát végpontkapcsolat privát végponttulajdonsága

Name	Típus	Description
id	string	Az erőforrás azonosítója.

PrivateEndpointConnection

Objektum

Egy IotHub privát végpontkapcsolata

Name	Típus	Description
id	string	Az erőforrás azonosítója.
name	string	Az erőforrás neve.
properties	PrivateEndpointConnectionProperties	A privát végpontkapcsolat tulajdonságai
type	string	Az erőforrás típusa.

PrivateEndpointConnectionProperties

Objektum

A privát végpontkapcsolat tulajdonságai

Name	Típus	Description
privateEndpoint	PrivateEndpoint	A privát végpontkapcsolat privát végponttulajdonsága
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionState

Objektum

Privát végpontkapcsolat aktuális állapota

Name	Típus	Description
actionsRequired	string	Privát végpontkapcsolathoz szükséges műveletek
description	string	A privát végpontkapcsolat aktuális állapotának leírása
status	PrivateLinkServiceConnectionStatus	Privát végpontkapcsolat állapota

PrivateLinkServiceConnectionStatus

Enumerálás

Privát végpontkapcsolat állapota

Érték	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumerálás

A nyilvános hálózatról érkező kérések engedélyezése

Érték	Description
Disabled
Enabled

ResourceIdentityType

Enumerálás

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

Érték	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Objektum

Az IoT Hub által használt útválasztási szabály tulajdonságai az üzenetek végpontokhoz való átirányításához.

Name	Típus	Description
condition	string	Az útválasztási szabály alkalmazásához kiértékelt feltétel. Ha nincs megadva feltétel, alapértelmezés szerint igaz értéket ad vissza. A nyelvhelyességről lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Azoknak a végpontoknak a listája, amelyekhez a feltételnek megfelelő üzenetek vannak átirányítva. Jelenleg csak egy végpont engedélyezett.
isEnabled	boolean	Az útvonal engedélyezésének megadására szolgál.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Az útvonal neve. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie.
source	RoutingSource	Az útválasztási szabályt alkalmazni kívánt forrás, például a DeviceMessages.

RoutingCosmosDBSqlApiProperties

Objektum

A cosmos DB SQL-tárolóvégponthoz kapcsolódó tulajdonságok.

Name	Típus	Description
authenticationType	authenticationType	A Cosmos DB SQL-tárolóvégponton történő hitelesítéshez használt módszer
containerName	string	A cosmos DB sql-tároló neve a Cosmos DB-adatbázisban.
databaseName	string	A cosmos DB-adatbázis neve a cosmos DB-fiókban.
endpointUri	string (uri)	A cosmos DB-fiók URL-címe. Tartalmaznia kell a protokoll https://
id	string	A Cosmos DB SQL-tárolóvégpont azonosítója
identity	ManagedIdentity	Az útválasztási Cosmos DB-tárolóvégpont felügyelt identitástulajdonságai.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között.
partitionKeyName	string	A cosmos DB SQL-tárolóhoz társított partíciókulcs neve, ha van ilyen. Ez egy nem kötelező paraméter.
partitionKeyTemplate	string	A cosmos DB SQL-tárolóhoz használható szintetikus partíciókulcs-érték létrehozására szolgáló sablon. A sablonnak tartalmaznia kell legalább egy helyőrzőt: {iothub}, {deviceid}, {DD}, {MM} és {YYYY}. Egy helyőrző legfeljebb egyszer adható meg, de a sorrend és a nem helyőrző összetevők tetszőlegesek. Ez a paraméter csak akkor szükséges, ha a PartitionKeyName meg van adva.
primaryKey	string	A cosmos DB-fiók elsődleges kulcsa.
resourceGroup	string	A cosmos DB-fiók erőforráscsoportjának neve.
secondaryKey	string	A cosmos DB-fiók másodlagos kulcsa.
subscriptionId	string	A cosmos DB-fiók előfizetés-azonosítója.

RoutingEndpoints

Objektum

Azokhoz az egyéni végpontokhoz kapcsolódó tulajdonságok, amelyekhez az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok összes végponttípusában legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípuson.

Name	Típus	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Azoknak a Cosmos DB-tárolóvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.
eventHubs	RoutingEventHubProperties[]	Azoknak az Event Hubs-végpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. Ez a lista nem tartalmazza a beépített Event Hubs-végpontot.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Azoknak a Service Bus-üzenetsorvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Azoknak a Service Bus-témakörvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.
storageContainers	RoutingStorageContainerProperties[]	Azon tárolóvégpontok listája, amelyekre az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.

RoutingEventHubProperties

Objektum

Az eseményközpont végpontjaihoz kapcsolódó tulajdonságok.

Name	Típus	Description
authenticationType	authenticationType	Az eseményközpont végpontja felé történő hitelesítéshez használt módszer
connectionString	string	Az eseményközpont végpontjának kapcsolati sztringje.
endpointUri	string	Az eseményközpont végpontjának URL-címe. Tartalmaznia kell a protokoll sb://
entityPath	string	Eseményközpont neve az eseményközpont névterében
id	string	Az eseményközpont végpontjának azonosítója
identity	ManagedIdentity	Az útválasztási eseményközpont végpontjának felügyelt identitástulajdonságai.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között.
resourceGroup	string	Az eseményközpont-végpont erőforráscsoportjának neve.
subscriptionId	string	Az eseményközpont végpontjának előfizetés-azonosítója.

RoutingProperties

Objektum

Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Típus	Description
endpoints	RoutingEndpoints	Azokhoz az egyéni végpontokhoz kapcsolódó tulajdonságok, amelyekhez az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok összes végponttípusában legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípuson.
enrichments	EnrichmentProperties[]	Az IoT Hub által a beépített és egyéni végpontokra kézbesítendő üzenetekre vonatkozó, felhasználó által biztosított bővítések listája. Lásd: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	A visszaeső útvonalként használt útvonal tulajdonságai, ha az "útvonalak" szakaszban megadott feltételek egyike sem teljesül. Ez egy nem kötelező paraméter. Ha ez a tulajdonság nincs jelen a sablonban, a tartalék útvonal alapértelmezés szerint le van tiltva.
routes	RouteProperties[]	A felhasználó által biztosított útválasztási szabályok listája, amelyeket az IoT Hub az üzenetek beépített és egyéni végpontokra való átirányítására használ. A fizetős központok esetében legfeljebb 100 útválasztási szabály engedélyezett, az ingyenes központok esetében pedig legfeljebb 5 útválasztási szabály engedélyezett.

RoutingServiceBusQueueEndpointProperties

Objektum

A Service Bus-üzenetsor végponttípusaihoz kapcsolódó tulajdonságok.

Name	Típus	Description
authenticationType	authenticationType	A service bus-üzenetsorvégponton történő hitelesítéshez használt módszer
connectionString	string	A service bus-üzenetsor végpontjának kapcsolati sztringje.
endpointUri	string	A service bus-üzenetsor végpontjának URL-címe. Tartalmaznia kell a protokoll sb://
entityPath	string	Üzenetsor neve a service bus névtérben
id	string	A service bus-üzenetsor végpontjának azonosítója
identity	ManagedIdentity	Az útválasztási szolgáltatásbusz-üzenetsorvégpont felügyelt identitástulajdonságai.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. A névnek nem kell megegyeznie a tényleges üzenetsor nevével.
resourceGroup	string	A service bus-üzenetsor-végpont erőforráscsoportjának neve.
subscriptionId	string	A service bus-üzenetsor végpontjának előfizetés-azonosítója.

RoutingServiceBusTopicEndpointProperties

Objektum

A Service Bus-témakör végponttípusaihoz kapcsolódó tulajdonságok.

Name	Típus	Description
authenticationType	authenticationType	A service bus-témakör végpontjának hitelesítéséhez használt módszer
connectionString	string	A service bus-témakör végpontjának kapcsolati sztringje.
endpointUri	string	A service bus-témakör végpontjának URL-címe. Tartalmaznia kell a protokoll sb://
entityPath	string	Üzenetsor neve a service bus-témakörben
id	string	A service bus-témakör végpontjának azonosítója
identity	ManagedIdentity	A Service Bus-témakör végpontjának felügyelt identitástulajdonságai.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. A névnek nem kell megegyeznie a tényleges témakör nevével.
resourceGroup	string	A service bus-témakör végpontjának erőforráscsoportjának neve.
subscriptionId	string	A service bus-témakör végpontjának előfizetés-azonosítója.

RoutingSource

Enumerálás

Az útválasztási szabályt alkalmazni kívánt forrás, például a DeviceMessages.

Érték	Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Objektum

A tárolóvégponthoz kapcsolódó tulajdonságok.

Name	Típus	Description
authenticationType	authenticationType	A tárvégponton történő hitelesítéshez használt módszer
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	A blobok tárolóba való írásának időintervalluma. Az értéknek 60 és 720 másodperc között kell lennie. Az alapértelmezett érték 300 másodperc.
connectionString	string	A tárfiók kapcsolati sztringje.
containerName	string	A tárfiókban található tároló neve.
encoding	enum: Avro AvroDeflate JSON	Kódolás, amely az üzenetek blobok szerializálására szolgál. A támogatott értékek a következők: "avro", "avrodeflate" és "JSON". Az alapértelmezett érték az "avro".
endpointUri	string	A tárvégpont URL-címe. Tartalmaznia kell a protokoll https://
fileNameFormat	string	A blob fájlnévformátuma. Alapértelmezett formátum: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Minden paraméter kötelező, de átrendezhető.
id	string	A tárolóvégpont azonosítója
identity	ManagedIdentity	Az útválasztási tárvégpont felügyelt identitástulajdonságai.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Tárba írt blobok maximális bájtszáma. Az értéknek 10485760(10 MB) és 524288000(500 MB) között kell lennie. Az alapértelmezett érték 314572800(300 MB).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között.
resourceGroup	string	A tárfiók erőforráscsoportjának neve.
subscriptionId	string	A tárfiók előfizetés-azonosítója.

SharedAccessSignatureAuthorizationRule

Objektum

Az IoT Hub megosztott hozzáférési szabályzatának tulajdonságai.

Name	Típus	Description
keyName	string	A megosztott hozzáférési szabályzat neve.
primaryKey	string	Az elsődleges kulcs.
rights	AccessRights	A megosztott hozzáférési szabályzathoz rendelt engedélyek.
secondaryKey	string	A másodlagos kulcs.

StorageEndpointProperties

Objektum

Az Azure Storage-végpont tulajdonságai a fájlfeltöltéshez.

Name	Típus	Description
authenticationType	AuthenticationType	Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust.
connectionString	string	Annak az Azure Storage-fióknak a kapcsolati sztringje, amelyre a fájlokat feltölti.
containerName	string	Annak a gyökértárolónak a neve, amelyben fájlokat tölt fel. A tárolónak nem kell léteznie, de a megadott connectionString használatával creatable-nek kell lennie.
identity	ManagedIdentity	A fájlfeltöltéshez használt tárolási végpont felügyelt identitástulajdonságai.
sasTtlAsIso8601	string (duration)	Az az időtartam, amelyre az IoT Hub által a fájlfeltöltéshez létrehozott SAS URI érvényes. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.