Iot Hub Resource - Get Event Hub Consumer Group

Tjänst:: IoT Hub

API-version:: 2023-06-30

Hämta en konsumentgrupp från den Event Hub-kompatibla slutpunkten från enhet till moln för en IoT-hubb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
eventHubEndpointName	path	True	string	Namnet på den Event Hub-kompatibla slutpunkten i IoT-hubben.
name	path	True	string	Namnet på den konsumentgrupp som ska hämtas.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller IoT-hubben.
resourceName	path	True	string	Namnet på IoT-hubben.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Typ	Description
200 OK	EventHubConsumerGroupInfo	Det här är en synkron åtgärd. Brödtexten innehåller en JSON-serialiserad konsumentgrupp.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

IotHubResource_ListEventHubConsumerGroups

Exempelbegäran

HTTP

GET 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

Exempelsvar

Statuskod:: 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="
}

Definitioner

Name	Description
ErrorDetails	Felinformation.
EventHubConsumerGroupInfo	Egenskaperna för EventHubConsumerGroupInfo-objektet.

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

EventHubConsumerGroupInfo