IotHubResource interface
IotHubResource を表すインターフェイス。
メソッド
メソッドの詳細
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT ハブのメタデータを作成または更新します。 プロパティを変更する通常のパターンは、IoT ハブのメタデータとセキュリティ メタデータを取得し、それらを新しい本文で変更された値と組み合わせて IoT ハブを更新することです。 JSON に特定のプロパティがない場合、IoT Hub を更新すると、これらの値が既定にフォールバックし、予期しない動作が発生する可能性があります。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- iotHubDescription
- IotHubDescription
IoT ハブのメタデータとセキュリティ メタデータ。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT ハブのメタデータを作成または更新します。 プロパティを変更する通常のパターンは、IoT ハブのメタデータとセキュリティ メタデータを取得し、それらを新しい本文で変更された値と組み合わせて IoT ハブを更新することです。 JSON に特定のプロパティがない場合、IoT Hub を更新すると、これらの値が既定にフォールバックし、予期しない動作が発生する可能性があります。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- iotHubDescription
- IotHubDescription
IoT ハブのメタデータとセキュリティ メタデータ。
オプション パラメーター。
戻り値
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
IoT ハブを削除します。
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
IoT ハブを削除します。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
既存の IoT Hub タグを更新します。 他のフィールドを更新するには、CreateOrUpdate メソッドを使用します
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>パラメーター
- resourceGroupName
-
string
リソース グループ識別子。
- resourceName
-
string
更新する IoT ハブの名前。
- iotHubTags
- TagsResource
IoT ハブ インスタンスに設定するようにタグ情報を更新しました。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
既存の IoT Hub タグを更新します。 他のフィールドを更新するには、CreateOrUpdate メソッドを使用します
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>パラメーター
- resourceGroupName
-
string
リソース グループ識別子。
- resourceName
-
string
更新する IoT ハブの名前。
- iotHubTags
- TagsResource
IoT ハブ インスタンスに設定するようにタグ情報を更新しました。
オプション パラメーター。
戻り値
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
IoT ハブ名が使用可能かどうかを確認します。
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>パラメーター
- operationInputs
- OperationInputs
OperationInputs 構造体の name パラメーターを、確認する IoT ハブの名前に設定します。
オプション パラメーター。
戻り値
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
IoT ハブ内のイベント ハブと互換性のあるエンドポイントにコンシューマー グループを追加します。
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- eventHubEndpointName
-
string
IoT ハブ内のイベント ハブと互換性のあるエンドポイントの名前。
- name
-
string
追加するコンシューマー グループの名前。
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
追加するコンシューマー グループ。
オプション パラメーター。
戻り値
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
IoT ハブ内のイベント ハブと互換性のあるエンドポイントからコンシューマー グループを削除します。
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- eventHubEndpointName
-
string
IoT ハブ内のイベント ハブと互換性のあるエンドポイントの名前。
- name
-
string
削除するコンシューマー グループの名前。
オプション パラメーター。
戻り値
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
IoT ハブ ID レジストリ内のすべてのデバイス ID を Azure Storage BLOB コンテナーにエクスポートします。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identitiesを参照してください。
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- exportDevicesParameters
- ExportDevicesRequest
エクスポート デバイス操作を指定するパラメーター。
オプション パラメーター。
戻り値
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
IoT ハブのセキュリティ関連以外のメタデータを取得します。
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- options
- IotHubResourceGetOptionalParams
オプション パラメーター。
戻り値
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
IoT ハブの Event Hub と互換性のあるデバイスからクラウドへのエンドポイントからコンシューマー グループを取得します。
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- eventHubEndpointName
-
string
IoT ハブ内のイベント ハブと互換性のあるエンドポイントの名前。
- name
-
string
取得するコンシューマー グループの名前。
オプション パラメーター。
戻り値
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
IoT ハブからジョブの詳細を取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registryを参照してください。
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- jobId
-
string
ジョブ識別子。
オプション パラメーター。
戻り値
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
IoT ハブから名前で共有アクセス ポリシーを取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-securityを参照してください。
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- keyName
-
string
共有アクセス ポリシーの名前。
オプション パラメーター。
戻り値
getStats(string, string, IotHubResourceGetStatsOptionalParams)
IoT ハブから統計を取得します。
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
IOT ハブ ID レジストリ内のデバイス ID を BLOB からインポート、更新、または削除します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identitiesを参照してください。
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- importDevicesParameters
- ImportDevicesRequest
デバイスのインポート操作を指定するパラメーター。
オプション パラメーター。
戻り値
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
リソース グループ内のすべての IoT ハブを取得します。
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
オプション パラメーター。
戻り値
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
サブスクリプション内のすべての IoT ハブを取得します。
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>パラメーター
オプション パラメーター。
戻り値
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
ルーティング エンドポイントの正常性を取得します。
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>パラメーター
- resourceGroupName
-
string
- iotHubName
-
string
オプション パラメーター。
戻り値
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
IoT ハブの Event Hub と互換性のあるデバイスからクラウドへのエンドポイントのコンシューマー グループの一覧を取得します。
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
- eventHubEndpointName
-
string
Event Hub と互換性のあるエンドポイントの名前。
オプション パラメーター。
戻り値
listJobs(string, string, IotHubResourceListJobsOptionalParams)
IoT ハブ内のすべてのジョブの一覧を取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registryを参照してください。
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
listKeys(string, string, IotHubResourceListKeysOptionalParams)
IoT ハブのセキュリティ メタデータを取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-securityを参照してください。
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
IoT ハブのクォータ メトリックを取得します。
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
IoT ハブの有効な SKU の一覧を取得します。
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
オプション パラメーター。
戻り値
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
この IoT ハブで構成されているすべてのルートをテストする
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>パラメーター
- iotHubName
-
string
テストする IotHub
- resourceGroupName
-
string
IoT Hub が属するリソース グループ
- input
- TestAllRoutesInput
すべてのルートをテストするための入力
オプション パラメーター。
戻り値
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
この IoT Hub の新しいルートをテストする
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>パラメーター
- iotHubName
-
string
テストする IotHub
- resourceGroupName
-
string
IoT Hub が属するリソース グループ
- input
- TestRouteInput
テストする必要があるルート
オプション パラメーター。
戻り値
Promise<TestRouteResult>