ConfigurationOperations クラス

ConfigurationOperations 操作。

継承
builtins.object
ConfigurationOperations

コンストラクター

ConfigurationOperations(client, config, serializer, deserializer)

パラメーター

client
必須

サービス要求のクライアント。

config
必須

サービス クライアントの構成。

serializer
必須

オブジェクト モデル シリアライザー。

deserializer
必須

オブジェクト モデル逆シリアライザー。

変数

api_version

Api のバージョン。 定数値: "2021-04-12"

メソッド

apply_on_edge_device

エッジ デバイスに構成コンテンツを適用します。

create_or_update

デバイス/モジュールの自動管理のために、IoT Hubの構成を作成または更新します。 構成識別子とコンテンツを更新できません。

delete

デバイス/モジュールの自動管理のために、IoT Hubの構成を削除します。

get

デバイス/モジュールの自動管理のIoT Hubの構成を取得します。

get_configurations

デバイス/モジュールの自動管理のIoT Hubの構成を取得します。 改ページ位置の設定はサポートされていません。

test_queries

IoT Hubの構成のターゲット条件とカスタム メトリック クエリを検証します。

apply_on_edge_device

エッジ デバイスに構成コンテンツを適用します。

apply_on_edge_device(id, content, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

エッジ デバイスの一意識別子。

content
ConfigurationContent
必須

構成コンテンツ。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

create_or_update

デバイス/モジュールの自動管理のために、IoT Hubの構成を作成または更新します。 構成識別子とコンテンツを更新できません。

create_or_update(id, configuration, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

構成の一意識別子。

configuration
Configuration
必須

作成または更新する構成。

if_match
str
既定値: None

RFC7232 に従って、構成の弱い ETag を表す文字列。 これは、構成の作成時には設定しないでくださいが、構成を更新するときに設定される場合があります。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

raw=true の場合は構成または ClientRawResponse

の戻り値の型 :

例外

delete

デバイス/モジュールの自動管理のために、IoT Hubの構成を削除します。

delete(id, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

構成の一意識別子。

if_match
str
既定値: None

RFC7232 に従って、構成の弱い ETag を表す文字列。 削除操作は、この ETag がサーバーによって管理されている値と一致する場合にのみ実行されます。これは、構成が最後に取得されてから変更されていないことを示します。 無条件削除を強制するには、If-Matchをワイルドカード文字 (*) に設定します。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

get

デバイス/モジュールの自動管理のIoT Hubの構成を取得します。

get(id, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

構成の一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

raw=true の場合は構成または ClientRawResponse

の戻り値の型 :

例外

get_configurations

デバイス/モジュールの自動管理のIoT Hubの構成を取得します。 改ページ位置の設定はサポートされていません。

get_configurations(top=None, custom_headers=None, raw=False, **operation_config)

パラメーター

top
int
既定値: None

取得する構成の数。 IoT Hubの最大デプロイ数を超える場合、値はオーバーライドされます。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

test_queries

IoT Hubの構成のターゲット条件とカスタム メトリック クエリを検証します。

test_queries(input, custom_headers=None, raw=False, **operation_config)

パラメーター

input
ConfigurationQueriesTestInput
必須

ターゲット条件とカスタム メトリック クエリの構成。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

ConfigurationQueriesTestResponse または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

属性

models

models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>