Dela via


Iot Hub Resource - List Event Hub Consumer Groups

Hämta en lista över konsumentgrupper i den Event Hub-kompatibla slutpunkten från enhet till moln i en IoT-hubb.

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

URI-parametrar

Name I Obligatorisk Typ Description
eventHubEndpointName
path True

string

Namnet på den Event Hub-kompatibla slutpunkten.

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

EventHubConsumerGroupsListResult

Det här är en synkron åtgärd. Brödtexten innehåller en JSON-serialiserad lista över konsumentgrupperna i den Event Hub-kompatibla slutpunkten i den här IoT-hubben

Other Status Codes

ErrorDetails

DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
ErrorDetails

Felinformation.

EventHubConsumerGroupInfo

Egenskaperna för EventHubConsumerGroupInfo-objektet.

EventHubConsumerGroupsListResult

Den JSON-serialiserade matrisen med Event Hub-kompatibla konsumentgruppnamn med en nästa länk.

ErrorDetails

Felinformation.

Name Typ Description
code

string

Felkoden.

details

string

Felinformationen.

httpStatusCode

string

HTTP-statuskoden.

message

string

Felmeddelandet.

EventHubConsumerGroupInfo

Egenskaperna för EventHubConsumerGroupInfo-objektet.

Name Typ Description
etag

string

Etag.

id

string

Händelsehubbens kompatibla identifierare för konsumentgrupper.

name

string

Det Event Hub-kompatibla konsumentgruppnamnet.

properties

Taggarna.

type

string

resurstypen.

EventHubConsumerGroupsListResult

Den JSON-serialiserade matrisen med Event Hub-kompatibla konsumentgruppnamn med en nästa länk.

Name Typ Description
nextLink

string

Nästa länk.

value

EventHubConsumerGroupInfo[]

Lista över objekt för konsumentgrupper