Iot Hub Resource - Create Event Hub Consumer Group

  • リファレンス
Service:
IoT Hub
API Version:
2018-04-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}?api-version=2018-04-01

URI パラメーター

名前 / 必須 型 説明
eventHubEndpointName
 path True

string

IoT ハブ内の Event Hub 互換エンドポイントの名前。
name
 path True

string

追加するコンシューマー グループの名前。
resourceGroupName
 path True

string

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

string

IoT ハブの名前。
subscriptionId
 path True

string

サブスクリプションの識別子です。
api-version
 query True

string

API のバージョン。

応答

名前 型 説明
200 OK

EventHubConsumerGroupInfo

これは同期操作です。
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_CreateEventHubConsumerGroup

Sample Request

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/eventHubEndpoints/events/ConsumerGroups/test?api-version=2018-04-01

Sample Response

Status code:
200 
{
  "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": "test",
  "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups",
  "etag": "AAAAAAFD6M4="
}

定義

名前 説明
ErrorDetails

エラーの詳細。
EventHubConsumerGroupInfo

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

ErrorDetails

エラーの詳細。

名前 型 説明
code

string

エラー コード。
details

string

エラーの詳細です。
httpStatusCode

string

HTTP 状態コード。
message

string

エラー メッセージ。

EventHubConsumerGroupInfo

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

名前 型 説明
etag

string

etag です。
id

string

Event Hub と互換性のあるコンシューマー グループ識別子。
name

string

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

object

タグ。
type

string

リソースの種類。