Iot Hub Resource - Create Event Hub Consumer Group

Služba:: IoT Hub

Verze rozhraní API:: 2023-06-30

Přidejte skupinu příjemců do koncového bodu kompatibilního s centrem událostí v centru IoT.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
eventHubEndpointName	path	True	string	Název koncového bodu kompatibilního s centrem událostí v centru IoT.
name	path	True	string	Název skupiny příjemců, která se má přidat.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje centrum IoT.
resourceName	path	True	string	Název ioT Hubu.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	EventHubConsumerGroupName	Název skupiny příjemců EventHubu.

Odpovědi

Name	Typ	Description
200 OK	EventHubConsumerGroupInfo	Jedná se o synchronní operaci.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

IotHubResource_CreateEventHubConsumerGroup

Ukázkový požadavek

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"
  }
}

Ukázková odpověď

Stavový kó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="
}

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě
EventHubConsumerGroupBodyDescription	Skupina příjemců EventHubu.
EventHubConsumerGroupInfo	Vlastnosti EventHubConsumerGroupInfo objektu.
EventHubConsumerGroupName	Název skupiny příjemců EventHubu.

ErrorDetails

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Kód chyby.
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP.
message	string	Chybová zpráva.

EventHubConsumerGroupBodyDescription

Objekt

Skupina příjemců EventHubu.

Name	Typ	Description
properties	EventHubConsumerGroupName	Název skupiny příjemců EventHubu.

EventHubConsumerGroupInfo

Objekt

Vlastnosti EventHubConsumerGroupInfo objektu.

Name	Typ	Description
etag	string	Ta jmenovka.
id	string	Identifikátor skupiny příjemců kompatibilní s centrem událostí.
name	string	Název skupiny příjemců kompatibilní s centrem událostí.
properties		Značky.
type	string	typ prostředku.

EventHubConsumerGroupName

Objekt

Název skupiny příjemců EventHubu.

Name	Typ	Description
name	string	Název skupiny příjemců EventHubu