Reject Cloud Events - Reject Cloud Events

서비스:

Event Grid

API 버전:

2024-06-01

Cloud 이벤트 배치를 거부합니다. 응답에는 성공적으로 거부된 잠금 토큰 집합과 해당 오류 정보와 함께 실패한 다른 잠금 토큰이 포함됩니다. 성공적으로 거부된 이벤트는 배달 못한 편지가 되며 소비자는 더 이상 수신할 수 없습니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)	네임스페이스의 호스트 이름(예: namespaceName1.westus-1.eventgrid.azure.net
eventSubscriptionName	path	True	string	이벤트 구독 이름.
topicName	path	True	string	주제 이름.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
lockTokens	True	string[]	잠금 토큰의 배열입니다.

응답

Name	형식	Description
200 OK	RejectResult	요청이 성공했습니다.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

예제

Reject Cloud Event

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

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

정의

Name	Description
Azure.Core.Foundations.Error	오류 개체입니다.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.
FailedLockToken	실패한 LockToken 정보입니다.
RejectResult	거부 작업의 결과입니다.

Azure.Core.Foundations.Error

Object

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

Object

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	오류 개체입니다.

Azure.Core.Foundations.InnerError

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.

FailedLockToken

Object

실패한 LockToken 정보입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	요청의 잠금 토큰에 대한 실패한 조작 결과의 오류 정보입니다.
lockToken	string	요청에 있는 항목의 잠금 토큰입니다.

RejectResult

Object

거부 작업의 결과입니다.

Name	형식	Description
failedLockTokens	FailedLockToken[]	실패한 클라우드 이벤트에 대한 FailedLockToken의 배열입니다. 각 FailedLockToken에는 관련 오류 정보(즉, 오류 코드 및 설명)와 함께 잠금 토큰이 포함됩니다.
succeededLockTokens	string[]	성공적으로 거부된 클라우드 이벤트에 대한 잠금 토큰의 배열입니다.