ConsumerGroupsOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

EventHubManagementClient's

<xref:consumer_groups> 属性を使用する。

継承

builtins.object

ConsumerGroupsOperations

コンストラクター

ConsumerGroupsOperations(*args, **kwargs)

メソッド

create_or_update	Event Hubs コンシューマー グループを名前空間内の入れ子になったリソースとして作成または更新します。
delete	指定したイベント ハブとリソース グループからコンシューマー グループを削除します。
get	指定したコンシューマー グループの説明を取得します。
list_by_event_hub	名前空間内のすべてのコンシューマー グループを取得します。 名前空間にコンシューマー グループが存在しない場合は、空のフィードが返されます。

create_or_update

Event Hubs コンシューマー グループを名前空間内の入れ子になったリソースとして作成または更新します。

async create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, parameters: _models.ConsumerGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConsumerGroup

パラメーター

resource_group_name

str

必須

Azure サブスクリプション内のリソース グループの名前。 必須。

namespace_name

str

必須

名前空間名。 必須。

event_hub_name

str

必須

イベント ハブ名。 必須。

consumer_group_name

str

必須

コンシューマー グループ名。 必須。

parameters

ConsumerGroup または IO

必須

コンシューマー グループ リソースを作成または更新するために指定されたパラメーター。 ConsumerGroup 型または IO 型です。 必須。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

ConsumerGroup または cls(response) の結果

の戻り値の型 :

ConsumerGroup

例外

HttpResponseError

delete

指定したイベント ハブとリソース グループからコンシューマー グループを削除します。

async delete(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> None

パラメーター

resource_group_name

str

必須

Azure サブスクリプション内のリソース グループの名前。 必須。

namespace_name

str

必須

名前空間名。 必須。

event_hub_name

str

必須

イベント ハブ名。 必須。

consumer_group_name

str

必須

コンシューマー グループ名。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

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

の戻り値の型 :

None

例外

HttpResponseError

get

指定したコンシューマー グループの説明を取得します。

async get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> ConsumerGroup

パラメーター

resource_group_name

str

必須

Azure サブスクリプション内のリソース グループの名前。 必須。

namespace_name

str

必須

名前空間名。 必須。

event_hub_name

str

必須

イベント ハブ名。 必須。

consumer_group_name

str

必須

コンシューマー グループ名。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

ConsumerGroup または cls(response) の結果

の戻り値の型 :

ConsumerGroup

例外

HttpResponseError

list_by_event_hub

名前空間内のすべてのコンシューマー グループを取得します。 名前空間にコンシューマー グループが存在しない場合は、空のフィードが返されます。

list_by_event_hub(resource_group_name: str, namespace_name: str, event_hub_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[ConsumerGroup]

パラメーター

resource_group_name

str

必須

Azure サブスクリプション内のリソース グループの名前。 必須。

namespace_name

str

必須

名前空間名。 必須。

event_hub_name

str

必須

イベント ハブ名。 必須。

skip

int

必須

Skip は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skip パラメーターが含まれます。 既定値は [なし] です。

top

int

必須

結果の数を最新の N usageDetails に制限するために使用できます。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

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

の戻り値の型 :

AsyncItemPaged[ConsumerGroup]

例外

HttpResponseError

属性

models

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