IotHubResourceOperations クラス

IoT ハブのメタデータを作成または更新します。

IoT ハブのメタデータを作成または更新します。 プロパティを変更する通常のパターンは、IoT ハブのメタデータとセキュリティ メタデータを取得し、それらを新しい本文で変更された値と組み合わせて IoT ハブを更新することです。 JSON に特定のプロパティがない場合、IoT Hubを更新すると、これらの値が既定値にフォールバックし、予期しない動作が発生する可能性があります。

begin_create_or_update(resource_group_name: str, resource_name: str, iot_hub_description: _models.IotHubDescription, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

パラメーター

戻り値

IotHubDescription または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

IoT ハブを削除します。

IoT ハブを削除します。

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]

パラメーター

戻り値

IotHubDescription または ErrorDetails または cls(response) の結果を返す LROPoller のインスタンス。

の戻り値の型 :

例外

既存の IoT Hubs タグを更新します。

既存のIoT Hub タグを更新します。 他のフィールドを更新するには、CreateOrUpdate メソッドを使用します。

begin_update(resource_group_name: str, resource_name: str, iot_hub_tags: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

パラメーター

戻り値

IotHubDescription または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

IoT ハブ名が使用可能かどうかを確認します。

IoT ハブ名が使用可能かどうかを確認します。

check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IotHubNameAvailabilityInfo

パラメーター

戻り値

IotHubNameAvailabilityInfo または cls(response) の結果

の戻り値の型 :

例外

IoT ハブ内の Event Hub 互換エンドポイントにコンシューマー グループを追加します。

IoT ハブ内の Event Hub 互換エンドポイントにコンシューマー グループを追加します。

create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, consumer_group_body: _models.EventHubConsumerGroupBodyDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventHubConsumerGroupInfo

パラメーター

戻り値

EventHubConsumerGroupInfo または cls(response) の結果

の戻り値の型 :

例外

IoT ハブの Event Hub 互換エンドポイントからコンシューマー グループを削除します。

IoT ハブの Event Hub 互換エンドポイントからコンシューマー グループを削除します。

delete_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> None

パラメーター

戻り値

なし、または cls(response) の結果

の戻り値の型 :

例外

IoT ハブ ID レジストリ内のすべてのデバイス ID を Azure Storage BLOB コンテナーにエクスポートします。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities」を参照してください。

IoT ハブ ID レジストリ内のすべてのデバイス ID を Azure Storage BLOB コンテナーにエクスポートします。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities」を参照してください。

export_devices(resource_group_name: str, resource_name: str, export_devices_parameters: _models.ExportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

パラメーター

戻り値

JobResponse または cls(response) の結果

の戻り値の型 :

例外

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

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

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription

パラメーター

戻り値

IotHubDescription または cls(response) の結果

の戻り値の型 :

例外

ルーティング エンドポイントの正常性を取得します。

ルーティング エンドポイントの正常性を取得します。

get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> Iterable[EndpointHealthData]

パラメーター

戻り値

EndpointHealthData のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

例外

IoT ハブの Event Hub 互換デバイスからクラウドへのエンドポイントからコンシューマー グループを取得します。

IoT ハブの Event Hub 互換デバイスからクラウドへのエンドポイントからコンシューマー グループを取得します。

get_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo

パラメーター

戻り値

EventHubConsumerGroupInfo または cls(response) の結果

の戻り値の型 :

例外

IoT ハブからジョブの詳細を取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry」を参照してください。

IoT ハブからジョブの詳細を取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry」を参照してください。

get_job(resource_group_name: str, resource_name: str, job_id: str, **kwargs: Any) -> JobResponse

パラメーター

戻り値

JobResponse または cls(response) の結果

の戻り値の型 :

例外

IoT ハブから名前で共有アクセス ポリシーを取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security」を参照してください。

IoT ハブから名前で共有アクセス ポリシーを取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security」を参照してください。

get_keys_for_key_name(resource_group_name: str, resource_name: str, key_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRule

パラメーター

戻り値

SharedAccessSignatureAuthorizationRule または cls(response) の結果

の戻り値の型 :

例外

IoT ハブのクォータ メトリックを取得します。

IoT ハブのクォータ メトリックを取得します。

get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]

パラメーター

戻り値

IotHubQuotaMetricInfo または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

IoT ハブから統計を取得します。

IoT ハブから統計を取得します。

get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatistics

パラメーター

戻り値

RegistryStatistics または cls(response) の結果

の戻り値の型 :

例外

IoT ハブの有効な SKU の一覧を取得します。

IoT ハブの有効な SKU の一覧を取得します。

get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]

パラメーター

戻り値

IotHubSkuDescription または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

IOT ハブ ID レジストリ内のデバイス ID を BLOB からインポート、更新、または削除します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities」を参照してください。

IOT ハブ ID レジストリ内のデバイス ID を BLOB からインポート、更新、または削除します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities」を参照してください。

import_devices(resource_group_name: str, resource_name: str, import_devices_parameters: _models.ImportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

パラメーター

戻り値

JobResponse または cls(response) の結果

の戻り値の型 :

例外

リソース グループ内のすべての IoT ハブを取得します。

リソース グループ内のすべての IoT ハブを取得します。

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]

パラメーター

戻り値

IotHubDescription のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

例外

サブスクリプション内のすべての IoT ハブを取得します。

サブスクリプション内のすべての IoT ハブを取得します。

list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]

パラメーター

戻り値

IotHubDescription のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

例外

IoT ハブの Event Hub と互換性のあるデバイスからクラウドへのエンドポイント内のコンシューマー グループの一覧を取得します。

IoT ハブの Event Hub と互換性のあるデバイスからクラウドへのエンドポイント内のコンシューマー グループの一覧を取得します。

list_event_hub_consumer_groups(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[EventHubConsumerGroupInfo]

パラメーター

戻り値

EventHubConsumerGroupInfo または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

IoT ハブ内のすべてのジョブの一覧を取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry」を参照してください。

IoT ハブ内のすべてのジョブの一覧を取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry」を参照してください。

list_jobs(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[JobResponse]

パラメーター

戻り値

JobResponse または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

IoT ハブのセキュリティ メタデータを取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security」を参照してください。

IoT ハブのセキュリティ メタデータを取得します。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security」を参照してください。

list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[SharedAccessSignatureAuthorizationRule]

パラメーター

戻り値

SharedAccessSignatureAuthorizationRule または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

すべてのルートをテストします。

この IoT Hub で構成されているすべてのルートをテストします。

test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResult

パラメーター

戻り値

TestAllRoutesResult または cls(response) の結果

の戻り値の型 :

例外

新しいルートをテストします。

この IoT Hub の新しいルートをテストします。

test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResult

パラメーター

戻り値

TestRouteResult または cls(response) の結果

の戻り値の型 :

例外

models = <module 'azure.mgmt.iothub.v2023_06_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30\\models\\__init__.py'>