Reject Cloud Events - Reject Cloud Events

Serviço:: Event Grid

Versão da API:: 2024-06-01

Rejeite um lote de eventos de nuvem. A resposta incluirá o conjunto de tokens de bloqueio rejeitados com êxito, juntamente com outros tokens de bloqueio com falha com suas informações de erro correspondentes. Os eventos rejeitados com êxito serão enviados em mensagens mortas e não poderão mais ser recebidos por um consumidor.

POST {endpoint}/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:reject?api-version=2024-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	Nome da Assinatura do Evento.
topicName	path	True	string	Nome do tópico.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
lockTokens	True	string[]	Matriz de tokens de bloqueio.

Respostas

Nome

Tipo

Description

200 OK

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

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

Escopos

Nome	Description
https://eventgrid.azure.net/.default

Exemplos

Reject Cloud Event

Solicitação de exemplo

HTTP

POST myNamespaceName.westus-1.eventgrid.azure.net/topics/myTopic/eventsubscriptions/myEventSubscription:reject?api-version=2024-06-01

Resposta de exemplo

Código de status:: 200

{
  "failedLockTokens": [],
  "succeededLockTokens": [
    "CgMKATESCQoHdG9rZW4tMQ=="
  ]
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	Falha nas informações do LockToken.
RejectResult	O resultado da operação Rejeitar.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

FailedLockToken

Objeto

Falha nas informações do LockToken.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	Informações de erro do resultado da operação com falha para o token de bloqueio na solicitação.
lockToken	string	O token de bloqueio de uma entrada na solicitação.

RejectResult

Objeto

O resultado da operação Rejeitar.

Nome	Tipo	Description
failedLockTokens	FailedLockToken[]	Matriz de FailedLockToken para eventos de nuvem com falha. Cada FailedLockToken inclui o token de bloqueio junto com as informações de erro relacionadas (ou seja, o código de erro e a descrição).
succeededLockTokens	string[]	Matriz de tokens de bloqueio para os eventos de nuvem rejeitados com êxito.