Iot Hub Resource - Get

サービス:

IoT Hub

API バージョン:

2023-06-30

IoT ハブのセキュリティ関連以外のメタデータを取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	IoT ハブを含むリソース グループの名前。
resourceName	path	True	string	IoT ハブの名前。
subscriptionId	path	True	string	サブスクリプションの識別子です。
api-version	query	True	string	API のバージョン。

応答

名前	型	説明
200 OK	IotHubDescription	本文には、IoT ハブのすべてのセキュリティ以外のプロパティが含まれています。 セキュリティ関連のプロパティは null に設定されます。
Other Status Codes	ErrorDetails	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

IotHubResource_Get

要求のサンプル

HTTP

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

Java

/** Samples for IotHubResource 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

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_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

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_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

JavaScript

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

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
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_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

応答のサンプル

状態コード:

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

定義

名前	説明
AccessRights	共有アクセス ポリシーに割り当てられたアクセス許可。
ArmIdentity
ArmUserIdentity
AuthenticationType	ストレージ アカウントへの接続に使用される認証の種類を指定します。
authenticationType	Service Bus キュー エンドポイントに対する認証に使用されるメソッド
Capabilities	IoT ハブで有効になっている機能と機能。
CloudToDeviceProperties	IoT ハブのクラウドからデバイスへのメッセージング プロパティ。
createdByType	リソースを作成した ID の種類。
DefaultAction	ネットワーク ルール セットの既定のアクション
EnrichmentProperties	IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。
ErrorDetails	エラーの詳細。
EventHubProperties	IoT ハブで使用されるプロビジョニングされた Event Hub 互換エンドポイントのプロパティ。
FallbackRouteProperties	フォールバック ルートのプロパティ。 IoT Hubは、フォールバック エンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。
FeedbackProperties	cloud-to-device メッセージのフィードバック キューのプロパティ。
IotHubDescription	IoT ハブの説明。
IotHubLocationDescription	リソースがプロビジョニングされている場所の 1 つをパブリックに表現します。
IotHubProperties	IoT ハブのプロパティ。
IotHubReplicaRoleType	リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアリージョンであり、IoT ハブがフェールオーバーできるリージョンでもあります。
IotHubSku	SKU の名前。
IotHubSkuInfo	IoT ハブの SKU に関する情報。
IotHubSkuTier	IoT ハブの課金レベル。
IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
IpFilterRule	IoT ハブの IP フィルター規則。
ManagedIdentity	マネージド ID のプロパティ。
MessagingEndpointProperties	この IoT ハブで使用されるメッセージング エンドポイントのプロパティ。
NetworkRuleIPAction	IP フィルター アクション
NetworkRuleSetIpRule	ネットワーク 規則セットの一部として適用される IP 規則
NetworkRuleSetProperties	IotHub のネットワーク ルール セットのプロパティ
PrivateEndpoint	プライベート エンドポイント接続のプライベート エンドポイント プロパティ
PrivateEndpointConnection	IotHub のプライベート エンドポイント接続
PrivateEndpointConnectionProperties	プライベート エンドポイント接続のプロパティ
PrivateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態
PrivateLinkServiceConnectionStatus	プライベート エンドポイント接続の状態
PublicNetworkAccess	パブリック ネットワークからの要求が許可されるかどうか
ResourceIdentityType	リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。
RouteProperties	IoT ハブがエンドポイントへのメッセージのルーティングに使用するルーティング規則のプロパティ。
RoutingCosmosDBSqlApiProperties	Cosmos DB SQL コンテナー エンドポイントに関連するプロパティ。
RoutingEndpoints	IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。
RoutingEventHubProperties	イベント ハブ エンドポイントに関連するプロパティ。
RoutingProperties	IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照
RoutingServiceBusQueueEndpointProperties	Service Bus キュー エンドポイントの種類に関連するプロパティ。
RoutingServiceBusTopicEndpointProperties	Service Bus トピック エンドポイントの種類に関連するプロパティ。
RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。
RoutingStorageContainerProperties	ストレージ コンテナー エンドポイントに関連するプロパティ。
SharedAccessSignatureAuthorizationRule	IoT ハブの共有アクセス ポリシーのプロパティ。
StorageEndpointProperties	ファイルアップロード用の Azure Storage エンドポイントのプロパティ。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AccessRights

共有アクセス ポリシーに割り当てられたアクセス許可。

名前	型	説明
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

名前	型	説明
principalId	string	プリンシパル ID
tenantId	string	テナント ID
type	ResourceIdentityType	リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities	<string,  ArmUserIdentity>

ArmUserIdentity

名前	型	説明
clientId	string
principalId	string

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

名前	型	説明
identityBased	string
keyBased	string

authenticationType

Service Bus キュー エンドポイントに対する認証に使用されるメソッド

名前	型	説明
identityBased	string
keyBased	string

Capabilities

IoT ハブで有効になっている機能と機能。

名前	型	説明
DeviceManagement	string
None	string

CloudToDeviceProperties

IoT ハブのクラウドからデバイスへのメッセージング プロパティ。

名前	型	説明
defaultTtlAsIso8601	string	デバイス キュー内のクラウドからデバイスへのメッセージの既定の有効期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
feedback	FeedbackProperties	cloud-to-device メッセージのフィードバック キューのプロパティ。
maxDeliveryCount	integer	デバイス キュー内のクラウドからデバイスへのメッセージの最大配信数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

ネットワーク ルール セットの既定のアクション

名前	型	説明
Allow	string
Deny	string

EnrichmentProperties

IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。

名前	型	説明
endpointNames	string[]	エンリッチメントがメッセージに適用されるエンドポイントの一覧。
key	string	エンリッチメント プロパティのキーまたは名前。
value	string	エンリッチメント プロパティの値。

ErrorDetails

エラーの詳細。

名前	型	説明
code	string	エラー コード。
details	string	エラーの詳細です。
httpStatusCode	string	HTTP 状態コード。
message	string	エラー メッセージ。

EventHubProperties

IoT ハブで使用されるプロビジョニングされた Event Hub 互換エンドポイントのプロパティ。

名前	型	説明
endpoint	string	Event Hub 互換エンドポイント。
partitionCount	integer	Event Hub 互換エンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages をご覧ください。
partitionIds	string[]	Event Hub 互換エンドポイントのパーティション ID。
path	string	イベント ハブ互換の名前。
retentionTimeInDays	integer	デバイスからクラウドへのメッセージの保持時間 (日数)。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照

FallbackRouteProperties

フォールバック ルートのプロパティ。 IoT Hubは、フォールバック エンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。

名前	型	説明
condition	string	フォールバック ルートを適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、以下を参照してください。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	条件を満たすメッセージのルーティング先となるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。
isEnabled	boolean	フォールバック ルートを有効にするかどうかを指定するために使用します。
name	string	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source	RoutingSource	ルーティング規則を適用するソース。 たとえば、DeviceMessages

FeedbackProperties

cloud-to-device メッセージのフィードバック キューのプロパティ。

名前	型	説明
lockDurationAsIso8601	string	フィードバック キューのロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
maxDeliveryCount	integer	IoT ハブがフィードバック キューでメッセージの配信を試みる回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
ttlAsIso8601	string	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。

IotHubDescription

IoT ハブの説明。

名前	型	説明
etag	string	Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id	string	リソース識別子。
identity	ArmIdentity	IotHub のマネージド ID。
location	string	リソースの場所。
name	string	リソースの名前。
properties	IotHubProperties	IotHub プロパティ
sku	IotHubSkuInfo	IotHub SKU 情報
systemData	systemData	このリソースに関連するシステム メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。

IotHubLocationDescription

リソースがプロビジョニングされている場所の 1 つをパブリックに表現します。

名前	型	説明
location	string	Azure リージョンの名前
role	IotHubReplicaRoleType	リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアリージョンであり、IoT ハブがフェールオーバーできるリージョンでもあります。

IotHubProperties

IoT ハブのプロパティ。

名前	型	説明
allowedFqdnList	string[]	Iot Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。
cloudToDevice	CloudToDeviceProperties	IoT ハブのクラウドからデバイスへのメッセージング プロパティ。
comments	string	IoT ハブのコメント。
disableDeviceSAS	boolean	true の場合、すべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープの SAS キーは認証に使用できません。
disableLocalAuth	boolean	true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンを認証に使用できません。
disableModuleSAS	boolean	true の場合、モジュール スコープのすべての SAS キーを認証に使用できません。
enableDataResidency	boolean	このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。
enableFileUploadNotifications	boolean	True の場合、ファイルのアップロード通知が有効になります。
eventHubEndpoints	<string,  EventHubProperties>	Event Hub 互換エンドポイントのプロパティ。 このディクショナリに使用できるキーはイベントのみです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。
features	Capabilities	IoT ハブで有効になっている機能。
hostName	string	ホストの名前。
ipFilterRules	IpFilterRule[]	IP フィルター規則。
locations	IotHubLocationDescription[]	IoT ハブのプライマリとセカンダリの場所
messagingEndpoints	<string,  MessagingEndpointProperties>	ファイル アップロード通知キューのメッセージング エンドポイント プロパティ。
minTlsVersion	string	このハブでサポートする TLS の最小バージョンを指定します。 1.2 未満の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。
networkRuleSets	NetworkRuleSetProperties	IotHub のネットワーク ルール セットのプロパティ
privateEndpointConnections	PrivateEndpointConnection[]	この IotHub で作成されたプライベート エンドポイント接続
provisioningState	string	プロビジョニングの状態。
publicNetworkAccess	PublicNetworkAccess	パブリック ネットワークからの要求が許可されるかどうか
restrictOutboundNetworkAccess	boolean	true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。
routing	RoutingProperties	IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照
state	string	ハブの状態。
storageEndpoints	<string,  StorageEndpointProperties>	ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけで、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。

IotHubReplicaRoleType

リージョンのロールには、プライマリまたはセカンダリのいずれかを指定できます。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアリージョンであり、IoT ハブがフェールオーバーできるリージョンでもあります。

名前	型	説明
primary	string
secondary	string

IotHubSku

SKU の名前。

名前	型	説明
B1	string
B2	string
B3	string
F1	string
S1	string
S2	string
S3	string

IotHubSkuInfo

IoT ハブの SKU に関する情報。

名前	型	説明
capacity	integer	プロビジョニングされたIoT Hubユニットの数。 https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits をご覧ください。
name	IotHubSku	SKU の名前。
tier	IotHubSkuTier	IoT ハブの課金レベル。

IotHubSkuTier

IoT ハブの課金レベル。

名前	型	説明
Basic	string
Free	string
Standard	string

IpFilterActionType

このルールによってキャプチャされた要求に対して必要なアクション。

名前	型	説明
Accept	string
Reject	string

IpFilterRule

IoT ハブの IP フィルター規則。

名前	型	説明
action	IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
filterName	string	IP フィルター規則の名前。
ipMask	string	ルールの CIDR 表記の IP アドレス範囲を含む文字列。

ManagedIdentity

マネージド ID のプロパティ。

名前	型	説明
userAssignedIdentity	string	ユーザー割り当て ID。

MessagingEndpointProperties

この IoT ハブで使用されるメッセージング エンドポイントのプロパティ。

名前	型	説明
lockDurationAsIso8601	string	ロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。
maxDeliveryCount	integer	IoT ハブがメッセージの配信を試行する回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。
ttlAsIso8601	string	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。

NetworkRuleIPAction

IP フィルター アクション

名前	型	説明
Allow	string

NetworkRuleSetIpRule

ネットワーク 規則セットの一部として適用される IP 規則

名前	型	規定値	説明
action	NetworkRuleIPAction	Allow	IP フィルター アクション
filterName	string		IP フィルター規則の名前。
ipMask	string		規則の IP アドレス範囲を CIDR 表記で含む文字列。

NetworkRuleSetProperties

IotHub のネットワーク ルール セットのプロパティ

名前	型	規定値	説明
applyToBuiltInEventHubEndpoint	boolean		True の場合、ネットワーク ルール セットは IotHub の BuiltIn EventHub EndPoint にも適用されます
defaultAction	DefaultAction	Deny	ネットワーク ルール セットの既定のアクション
ipRules	NetworkRuleSetIpRule[]		IP ルールの一覧

PrivateEndpoint

プライベート エンドポイント接続のプライベート エンドポイント プロパティ

名前	型	説明
id	string	リソース識別子。

PrivateEndpointConnection

IotHub のプライベート エンドポイント接続

名前	型	説明
id	string	リソース識別子。
name	string	リソースの名前。
properties	PrivateEndpointConnectionProperties	プライベート エンドポイント接続のプロパティ
type	string	リソースの種類。

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ

名前	型	説明
privateEndpoint	PrivateEndpoint	プライベート エンドポイント接続のプライベート エンドポイント プロパティ
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態

PrivateLinkServiceConnectionState

プライベート エンドポイント接続の現在の状態

名前	型	説明
actionsRequired	string	プライベート エンドポイント接続に必要なアクション
description	string	プライベート エンドポイント接続の現在の状態の説明
status	PrivateLinkServiceConnectionStatus	プライベート エンドポイント接続の状態

PrivateLinkServiceConnectionStatus

プライベート エンドポイント接続の状態

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

パブリック ネットワークからの要求が許可されるかどうか

名前	型	説明
Disabled	string
Enabled	string

ResourceIdentityType

リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RouteProperties

IoT ハブがエンドポイントへのメッセージのルーティングに使用するルーティング規則のプロパティ。

名前	型	説明
condition	string	ルーティング規則を適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、次を参照してください。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。
isEnabled	boolean	ルートが有効かどうかを指定するために使用します。
name	string	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source	RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。

RoutingCosmosDBSqlApiProperties

Cosmos DB SQL コンテナー エンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Cosmos DB SQL コンテナー エンドポイントに対する認証に使用されるメソッド
containerName	string	cosmos DB データベース内の cosmos DB SQL コンテナーの名前。
databaseName	string	Cosmos DB アカウント内の Cosmos DB データベースの名前。
endpointUri	string	Cosmos DB アカウントの URL。 プロトコル https:// を含める必要があります
id	string	cosmos DB sql コンテナー エンドポイントの ID
identity	ManagedIdentity	Cosmos DB コンテナー エンドポイントのルーティングのマネージド ID プロパティ。
name	string	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
partitionKeyName	string	この cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。
partitionKeyTemplate	string	この cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが含まれている必要があります。 プレースホルダーは 1 つでも 1 回だけ指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。
primaryKey	string	Cosmos DB アカウントの主キー。
resourceGroup	string	Cosmos DB アカウントのリソース グループの名前。
secondaryKey	string	Cosmos DB アカウントのセカンダリ キー。
subscriptionId	string	Cosmos DB アカウントのサブスクリプション識別子。

RoutingEndpoints

IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。

名前	型	説明
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Cosmos DB コンテナー エンドポイントの一覧。
eventHubs	RoutingEventHubProperties[]	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングする Event Hubs エンドポイントの一覧。 この一覧には、組み込みの Event Hubs エンドポイントは含まれません。
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キュー エンドポイントの一覧。
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピック エンドポイントの一覧。
storageContainers	RoutingStorageContainerProperties[]	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングするストレージ コンテナー エンドポイントの一覧。

RoutingEventHubProperties

イベント ハブ エンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	イベント ハブ エンドポイントに対する認証に使用されるメソッド
connectionString	string	イベント ハブ エンドポイントの接続文字列。
endpointUri	string	イベント ハブ エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath	string	イベント ハブ名前空間のイベント ハブ名
id	string	イベント ハブ エンドポイントの ID
identity	ManagedIdentity	ルーティング イベント ハブ エンドポイントのマネージド ID プロパティ。
name	string	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup	string	イベント ハブ エンドポイントのリソース グループの名前。
subscriptionId	string	イベント ハブ エンドポイントのサブスクリプション識別子。

RoutingProperties

IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照

名前	型	説明
endpoints	RoutingEndpoints	IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。
enrichments	EnrichmentProperties[]	組み込みエンドポイントとカスタム エンドポイントに配信されるメッセージに IoT ハブが適用するユーザー指定のエンリッチメントの一覧。 https://aka.ms/telemetryoneventgrid を参照
fallbackRoute	FallbackRouteProperties	[ルート] セクションで指定された条件が満たされていない場合にフォールバック ルートとして使用されるルートのプロパティ。 これは省略可能なパラメーターです。 このプロパティがテンプレートに存在しない場合、フォールバック ルートは既定で無効になります。
routes	RouteProperties[]	IoT ハブが組み込みエンドポイントとカスタム エンドポイントにメッセージをルーティングするために使用するユーザー指定のルーティング規則の一覧。 有料ハブでは最大 100 個のルーティング規則が許可され、無料ハブでは最大 5 つのルーティング規則が許可されます。

RoutingServiceBusQueueEndpointProperties

Service Bus キュー エンドポイントの種類に関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Service Bus キュー エンドポイントに対する認証に使用されるメソッド
connectionString	string	Service Bus キュー エンドポイントの接続文字列。
endpointUri	string	Service Bus キュー エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath	string	Service Bus 名前空間のキュー名
id	string	Service Bus キュー エンドポイントの ID
identity	ManagedIdentity	ルーティング サービス バス キュー エンドポイントのマネージド ID プロパティ。
name	string	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 この名前は、実際のキュー名と同じである必要はありません。
resourceGroup	string	Service Bus キュー エンドポイントのリソース グループの名前。
subscriptionId	string	Service Bus キュー エンドポイントのサブスクリプション識別子。

RoutingServiceBusTopicEndpointProperties

Service Bus トピック エンドポイントの種類に関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	Service Bus トピック エンドポイントに対する認証に使用されるメソッド
connectionString	string	Service Bus トピック エンドポイントの接続文字列。
endpointUri	string	Service Bus トピック エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath	string	Service Bus トピックのキュー名
id	string	Service Bus トピック エンドポイントの ID
identity	ManagedIdentity	ルーティング サービス バス トピック エンドポイントのマネージド ID プロパティ。
name	string	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 名前は、実際のトピック名と同じである必要はありません。
resourceGroup	string	Service Bus トピック エンドポイントのリソース グループの名前。
subscriptionId	string	Service Bus トピック エンドポイントのサブスクリプション識別子。

RoutingSource

ルーティング規則を適用するソース (DeviceMessages など)。

名前	型	説明
DeviceConnectionStateEvents	string
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingStorageContainerProperties

ストレージ コンテナー エンドポイントに関連するプロパティ。

名前	型	説明
authenticationType	authenticationType	ストレージ エンドポイントに対する認証に使用されるメソッド
batchFrequencyInSeconds	integer	BLOB がストレージに書き込まれる時間間隔。 値は 60 から 720 秒の間である必要があります。 既定値は 300 秒です。
connectionString	string	ストレージ アカウントの接続文字列。
containerName	string	ストレージ アカウント内のストレージ コンテナーの名前。
encoding	enum: Avro AvroDeflate JSON	メッセージを BLOB にシリアル化するために使用されるエンコード。 サポートされている値は、"avro"、"avrodeflate"、および "JSON" です。 既定値は "avro" です。
endpointUri	string	ストレージ エンドポイントの URL。 プロトコル https:// を含める必要があります
fileNameFormat	string	BLOB のファイル名の形式。 既定の形式は {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} です。 すべてのパラメーターは必須ですが、順序を変更できます。
id	string	ストレージ コンテナー エンドポイントの ID
identity	ManagedIdentity	ルーティング ストレージ エンドポイントのマネージド ID プロパティ。
maxChunkSizeInBytes	integer	ストレージに書き込まれる各 BLOB の最大バイト数。 値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。 既定値は 314572800(300 MB) です。
name	string	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup	string	ストレージ アカウントのリソース グループの名前。
subscriptionId	string	ストレージ アカウントのサブスクリプション識別子。

SharedAccessSignatureAuthorizationRule

IoT ハブの共有アクセス ポリシーのプロパティ。

名前	型	説明
keyName	string	共有アクセス ポリシーの名前。
primaryKey	string	主キー。
rights	AccessRights	共有アクセス ポリシーに割り当てられたアクセス許可。
secondaryKey	string	セカンダリ キー。

StorageEndpointProperties

ファイルアップロード用の Azure Storage エンドポイントのプロパティ。

名前	型	説明
authenticationType	AuthenticationType	ストレージ アカウントへの接続に使用される認証の種類を指定します。
connectionString	string	ファイルがアップロードされる Azure Storage アカウントの接続文字列。
containerName	string	ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。
identity	ManagedIdentity	ファイルアップロード用のストレージ エンドポイントのマネージド ID プロパティ。
sasTtlAsIso8601	string	ファイルのアップロードにIoT Hubによって生成された SAS URI が有効な期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options をご覧ください。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。