Freigeben über


Iot Hub Resource - List Event Hub Consumer Groups

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Device-to-Cloud-Endpunkt in einem IoT Hub ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
eventHubEndpointName
path True

string

Der Name des Event Hub-kompatiblen Endpunkts.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.

resourceName
path True

string

Der Name des IoT-Hubs.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

EventHubConsumerGroupsListResult

Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte Liste der Consumergruppen im Event Hub-kompatiblen Endpunkt in diesem IoT Hub.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_ListEventHubConsumerGroups

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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="
    }
  ]
}

Definitionen

Name Beschreibung
ErrorDetails

Fehlerdetails.

EventHubConsumerGroupInfo

Die Eigenschaften des EventHubConsumerGroupInfo-Objekts.

EventHubConsumerGroupsListResult

Das JSON-serialisierte Array von Event Hub-kompatiblen Consumergruppennamen mit einem nächsten Link.

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

EventHubConsumerGroupInfo

Die Eigenschaften des EventHubConsumerGroupInfo-Objekts.

Name Typ Beschreibung
etag

string

Das Etag.

id

string

Der Event Hub-kompatible Consumergruppenbezeichner.

name

string

Der Name der Event Hub-kompatiblen Consumergruppe.

properties

Die Tags.

type

string

der Ressourcentyp.

EventHubConsumerGroupsListResult

Das JSON-serialisierte Array von Event Hub-kompatiblen Consumergruppennamen mit einem nächsten Link.

Name Typ Beschreibung
nextLink

string

Der nächste Link.

value

EventHubConsumerGroupInfo[]

Liste der Consumergruppenobjekte