Partager via


Iot Hub Resource - List Event Hub Consumer Groups

Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible Event Hub dans 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

Paramètres URI

Nom Dans Obligatoire Type Description
eventHubEndpointName
path True

string

Nom du point de terminaison compatible avec Event Hub.

resourceGroupName
path True

string

Nom du groupe de ressources qui contient le hub IoT.

resourceName
path True

string

Nom du hub IoT.

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Réponses

Nom Type Description
200 OK

EventHubConsumerGroupsListResult

Il s’agit d’une opération synchrone. Le corps contient une liste sérialisée JSON des groupes de consommateurs dans le point de terminaison compatible Event Hub dans ce hub IoT

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_ListEventHubConsumerGroups

Sample Request

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

Sample Response

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

Définitions

Nom Description
ErrorDetails

Détails de l’erreur.

EventHubConsumerGroupInfo

Propriétés de l’objet EventHubConsumerGroupInfo.

EventHubConsumerGroupsListResult

Tableau sérialisé JSON de noms de groupes de consommateurs compatibles avec Event Hub avec un lien suivant.

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

EventHubConsumerGroupInfo

Propriétés de l’objet EventHubConsumerGroupInfo.

Nom Type Description
etag

string

etag.

id

string

Identificateur du groupe de consommateurs compatible avec Event Hub.

name

string

Nom du groupe de consommateurs compatible avec Event Hub.

properties

Balises.

type

string

type de ressource.

EventHubConsumerGroupsListResult

Tableau sérialisé JSON de noms de groupes de consommateurs compatibles avec Event Hub avec un lien suivant.

Nom Type Description
nextLink

string

Lien suivant.

value

EventHubConsumerGroupInfo[]

Liste des objets de groupes de consommateurs