Condividi tramite


Iot Hub Resource - List Event Hub Consumer Groups

Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con hub eventi in un hub IoT.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
eventHubEndpointName
path True

string

Nome dell'endpoint compatibile con Hub eventi.

resourceGroupName
path True

string

Nome del gruppo di risorse contenente l'hub IoT.

resourceName
path True

string

Nome dell'hub IoT.

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

EventHubConsumerGroupsListResult

Si tratta di un'operazione sincrona. Il corpo contiene un elenco serializzato JSON dei gruppi di consumer nell'endpoint compatibile con hub eventi in questo hub IoT

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

IotHubResource_ListEventHubConsumerGroups

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorDetails

Dettagli degli errori.

EventHubConsumerGroupInfo

Proprietà dell'oggetto EventHubConsumerGroupInfo.

EventHubConsumerGroupsListResult

Matrice serializzata JSON dei nomi dei gruppi di consumer compatibili con Hub eventi con un collegamento successivo.

ErrorDetails

Dettagli degli errori.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

EventHubConsumerGroupInfo

Proprietà dell'oggetto EventHubConsumerGroupInfo.

Nome Tipo Descrizione
etag

string

ETag.

id

string

Identificatore del gruppo di consumer compatibile con Hub eventi.

name

string

Nome del gruppo consumer compatibile con Hub eventi.

properties

Tag.

type

string

tipo di risorsa.

EventHubConsumerGroupsListResult

Matrice serializzata JSON dei nomi dei gruppi di consumer compatibili con Hub eventi con un collegamento successivo.

Nome Tipo Descrizione
nextLink

string

Collegamento successivo.

value

EventHubConsumerGroupInfo[]

Elenco degli oggetti gruppi di consumer