Condividi tramite


Iot Hub Resource - Get Event Hub Consumer Group

Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con Hub eventi per un hub IoT.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
eventHubEndpointName
path True

string

Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT.

name
path True

string

Nome del gruppo di consumer da recuperare.

resourceGroupName
path True

string

Nome del gruppo di risorse che contiene 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

EventHubConsumerGroupInfo

Si tratta di un'operazione sincrona. Il corpo contiene un gruppo di consumer serializzato JSON.

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/test?api-version=2023-06-30

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorDetails

Dettagli errore.

EventHubConsumerGroupInfo

Proprietà dell'oggetto EventHubConsumerGroupInfo.

ErrorDetails

Dettagli errore.

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 di consumer compatibile con Hub eventi.

properties

Tag.

type

string

tipo di risorsa.