Consumer Groups - List By Event Hub

Recebe todos os grupos de consumidores num espaço namespace. Um feed vazio é devolvido se não existir nenhum grupo de consumidores no Espaço Nome.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups?api-version=2017-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups?api-version=2017-04-01&$skip={$skip}&$top={$top}

Parâmetros do URI

Name In Required Type Description
eventHubName
path True
  • string

O nome do Centro de Eventos

namespaceName
path True
  • string

O nome Namespace

resourceGroupName
path True
  • string

Nome do grupo de recursos dentro da subscrição azul.

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão API do cliente.

$skip
query
  • integer

O skip só é utilizado se uma operação anterior devolver um resultado parcial. Se uma resposta anterior contiver um elemento NextLink, o valor do elemento NextLink incluirá um parâmetro de salto que especifica um ponto de partida para utilizar para chamadas posteriores.

$top
query
  • integer

Pode ser usado para limitar o número de resultados aos mais recentes N useDetails.

Respostas

Name Type Description
200 OK

Recuperou com sucesso a lista de grupos de consumidores.

Other Status Codes

Resposta de erro do Eventhub descrevendo por que a operação falhou

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ConsumerGroupsListAll

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups?api-version=2017-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/$Default",
      "name": "$Default",
      "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups",
      "properties": {
        "createdAt": "2017-05-25T03:42:52.287Z",
        "updatedAt": "2017-05-25T03:42:52.287Z"
      }
    },
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-consumergroup-5563",
      "name": "sdk-consumergroup-5563",
      "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups",
      "properties": {
        "createdAt": "2017-05-25T03:43:09.314Z",
        "updatedAt": "2017-05-25T03:43:09.314Z"
      }
    }
  ]
}

Definições

ConsumerGroup

Item único na operação de grupo de consumidores list ou get

ConsumerGroupListResult

O resultado da operação do Grupo de Consumidores lista.

ErrorResponse

A resposta de erro indica que o serviço Event Hub não é capaz de processar o pedido de entrada. A razão está na mensagem de erro.

ConsumerGroup

Item único na operação de grupo de consumidores list ou get

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.createdAt
  • string

Hora exata em que a mensagem foi criada.

properties.updatedAt
  • string

A hora exata em que a mensagem foi atualizada.

properties.userMetadata
  • string

Os Metadados do Utilizador são um espaço reservado para armazenar dados de cadeia definidos pelo utilizador com comprimento máximo de 1024. por exemplo, pode ser utilizado para armazenar dados descritivos, como a lista de equipas e as suas informações de contacto, bem como as definições de configuração definidas pelo utilizador.

type
  • string

Tipo de recurso.

ConsumerGroupListResult

O resultado da operação do Grupo de Consumidores lista.

Name Type Description
nextLink
  • string

Ligue para o próximo conjunto de resultados. Não está vazio se o Valor contiver lista incompleta do Grupo de Consumidores

value

Resultado da operação do Grupo de Consumidores lista.

ErrorResponse

A resposta de erro indica que o serviço Event Hub não é capaz de processar o pedido de entrada. A razão está na mensagem de erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.