Iot Hub Resource - Create Event Hub Consumer Group

Szolgáltatás:: IoT Hub

API-verzió:: 2023-06-30

Adjon hozzá egy fogyasztói csoportot egy Event Hub-kompatibilis végponthoz egy IoT Hubban.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
eventHubEndpointName	path	True	string	Az Event Hub-kompatibilis végpont neve az IoT Hubban.
name	path	True	string	A hozzáadni kívánt fogyasztói csoport neve.
resourceGroupName	path	True	string	Az IoT Hubot tartalmazó erőforráscsoport neve.
resourceName	path	True	string	Az IoT Hub neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
properties	True	EventHubConsumerGroupName	Az EventHub fogyasztói csoport neve.

Válaszok

Name	Típus	Description
200 OK	EventHubConsumerGroupInfo	Ez egy szinkron művelet.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

IotHubResource_CreateEventHubConsumerGroup

Mintakérelem

HTTP

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

{
  "properties": {
    "name": "test"
  }
}

Mintaválasz

Állapotkód:: 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="
}

Definíciók

Name	Description
ErrorDetails	Hiba részletei.
EventHubConsumerGroupBodyDescription	Az EventHub fogyasztói csoportja.
EventHubConsumerGroupInfo	Az EventHubConsumerGroupInfo objektum tulajdonságai.
EventHubConsumerGroupName	Az EventHub fogyasztói csoport neve.

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

EventHubConsumerGroupBodyDescription

Objektum

Az EventHub fogyasztói csoportja.

Name	Típus	Description
properties	EventHubConsumerGroupName	Az EventHub fogyasztói csoport neve.

EventHubConsumerGroupInfo

Objektum

Az EventHubConsumerGroupInfo objektum tulajdonságai.

Name	Típus	Description
etag	string	Az etag.
id	string	Az Event Hub-kompatibilis fogyasztói csoport azonosítója.
name	string	Az Event Hub-kompatibilis fogyasztói csoport neve.
properties		A címkék.
type	string	erőforrástípust.

EventHubConsumerGroupName

Objektum

Az EventHub fogyasztói csoport neve.

Name	Típus	Description
name	string	EventHub fogyasztói csoport neve