Iot Hub Resource - List Event Hub Consumer Groups

Obtenha uma lista dos grupos de consumidores no ponto de extremidade do dispositivo para nuvem compatível com o Hub de Eventos em um hub IoT.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
eventHubEndpointName
path True

string

O nome do ponto de extremidade compatível com o Hub de Eventos.

resourceGroupName
path True

string

O nome do grupo de recursos que contém o hub IoT.

resourceName
path True

string

O nome do Hub IoT.

subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Respostas

Nome Tipo Description
200 OK

EventHubConsumerGroupsListResult

Essa é uma operação síncrona. O corpo contém uma lista serializada em JSON dos grupos de consumidores no ponto de extremidade compatível com o Hub de Eventos neste Hub IoT

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

IotHubResource_ListEventHubConsumerGroups

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ErrorDetails

Detalhes do erro.

EventHubConsumerGroupInfo

As propriedades do objeto EventHubConsumerGroupInfo.

EventHubConsumerGroupsListResult

A matriz serializada em JSON de nomes de grupo de consumidores compatíveis com o Hub de Eventos com um próximo link.

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status do HTTP.

message

string

A mensagem de erro.

EventHubConsumerGroupInfo

As propriedades do objeto EventHubConsumerGroupInfo.

Nome Tipo Description
etag

string

A etag.

id

string

O identificador do grupo de consumidores compatível com o Hub de Eventos.

name

string

O nome do grupo de consumidores compatível com o Hub de Eventos.

properties

As marcas.

type

string

o tipo de recurso.

EventHubConsumerGroupsListResult

A matriz serializada em JSON de nomes de grupo de consumidores compatíveis com o Hub de Eventos com um próximo link.

Nome Tipo Description
nextLink

string

O próximo link.

value

EventHubConsumerGroupInfo[]

Lista de objetos de grupos de consumidores