Partilhar via


Iot Hub Resource - Create Event Hub Consumer Group

Adicione um grupo de consumidores a um ponto final compatível com o Hub de Eventos num 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 do URI

Name Em Necessário Tipo Description
eventHubEndpointName
path True

string

O nome do ponto final compatível com o Hub de Eventos no hub IoT.

name
path True

string

O nome do grupo de consumidores a adicionar.

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 subscrição.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Necessário Tipo Description
properties True

EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

Respostas

Name 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

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IotHubResource_CreateEventHubConsumerGroup

Sample Request

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

Sample Response

{
  "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

Name 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

Detalhes do erro.

Name Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de estado HTTP.

message

string

A mensagem de erro.

EventHubConsumerGroupBodyDescription

O grupo de consumidores do EventHub.

Name Tipo Description
properties

EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

EventHubConsumerGroupInfo

As propriedades do objeto EventHubConsumerGroupInfo.

Name Tipo Description
etag

string

O 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 etiquetas.

type

string

o tipo de recurso.

EventHubConsumerGroupName

O nome do grupo de consumidores do EventHub.

Name Tipo Description
name

string

Nome do grupo de consumidores do EventHub