Iot Hub Resource - List Event Hub Consumer Groups

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

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

URI パラメーター

名前 / 必須 説明
eventHubEndpointName
path True

string

Event Hub 互換エンドポイントの名前。

resourceGroupName
path True

string

IoT ハブを含むリソース グループの名前。

resourceName
path True

string

IoT ハブの名前。

subscriptionId
path True

string

サブスクリプションの識別子です。

api-version
query True

string

API のバージョン。

応答

名前 説明
200 OK

EventHubConsumerGroupsListResult

これは同期操作です。 本文には、この IoT ハブの Event Hub 互換エンドポイント内のコンシューマー グループの JSON シリアル化された一覧が含まれています

Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

IotHubResource_ListEventHubConsumerGroups

Sample Request

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

Sample Response

{
  "value": [
    {
      "properties": {
        "created": "Thu, 15 Jun 2017 19:20:58 GMT"
      },
      "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default",
      "name": "$Default",
      "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups",
      "etag": "AAAAAAFD6M4="
    }
  ]
}

定義

名前 説明
ErrorDetails

エラーの詳細。

EventHubConsumerGroupInfo

EventHubConsumerGroupInfo オブジェクトのプロパティ。

EventHubConsumerGroupsListResult

次のリンクを含む Event Hub 互換コンシューマー グループ名の JSON シリアル化された配列。

ErrorDetails

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。

EventHubConsumerGroupInfo

EventHubConsumerGroupInfo オブジェクトのプロパティ。

名前 説明
etag

string

etag です。

id

string

Event Hub 互換のコンシューマー グループ識別子。

name

string

Event Hub 互換のコンシューマー グループ名。

properties

タグ。

type

string

リソースの種類。

EventHubConsumerGroupsListResult

次のリンクを含む Event Hub 互換コンシューマー グループ名の JSON シリアル化された配列。

名前 説明
nextLink

string

次のリンク。

value

EventHubConsumerGroupInfo[]

コンシューマー グループ オブジェクトの一覧