Compartilhar via

Iot Hub Resource - Create Event Hub Consumer Group

Serviço:
IoT Hub
Versão da API:
2023-06-30

Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um hub IoT.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}?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 no Hub IoT.
name
 path True

string

O nome do grupo de consumidores a ser adicionado.
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.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties True

EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

Respostas

Nome Tipo Description
200 OK

EventHubConsumerGroupInfo

Esta é uma operação síncrona.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo 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_CreateEventHubConsumerGroup

Solicitação de exemplo

PUT 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

{
  "properties": {
    "name": "test"
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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="
}

Definições

Nome Description
ErrorDetails

Detalhes do erro.
EventHubConsumerGroupBodyDescription

O grupo de consumidores do EventHub.
EventHubConsumerGroupInfo

As propriedades do objeto EventHubConsumerGroupInfo.
EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

ErrorDetails

Objeto

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 HTTP.
message

string

A mensagem de erro.

EventHubConsumerGroupBodyDescription

Objeto

O grupo de consumidores do EventHub.

Nome Tipo Description
properties

EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

EventHubConsumerGroupInfo

Objeto

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.

EventHubConsumerGroupName

Objeto

O nome do grupo de consumidores do EventHub.

Nome Tipo Description
name

string

Nome do grupo de consumidores do EventHub