Microsoft.EventGrid (preview:2023-10-01)

2024/12/09 • 6 deleted methods

PublishCloudEvent (removed)
Description Publish a single Cloud Event to a namespace topic.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}:publish
{
api-version: string ,
topicName: string ,
event:
{
id: string ,
source: string ,
data: string ,
data_base64: string ,
type: string ,
time: string ,
specversion: string ,
dataschema: string ,
datacontenttype: string ,
subject: string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ReceiveCloudEvents (removed)
Description Receive a batch of Cloud Events from a subscription.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive
{
api-version: string ,
topicName: string ,
eventSubscriptionName: string ,
maxEvents: integer ,
maxWaitTime: integer ,
}

⚐ Response (200)

{
value:
[
{
brokerProperties:
{
lockToken: string ,
deliveryCount: integer ,
}
,
event:
{
id: string ,
source: string ,
data: string ,
data_base64: string ,
type: string ,
time: string ,
specversion: string ,
dataschema: string ,
datacontenttype: string ,
subject: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
AcknowledgeCloudEvents (removed)
Description Acknowledge a batch of Cloud Events. The response will include the set of successfully acknowledged lock tokens, along with other failed lock tokens with their corresponding error information. Successfully acknowledged events will no longer be available to be received by any consumer.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge
{
api-version: string ,
topicName: string ,
eventSubscriptionName: string ,
body:
{
lockTokens:
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
[
{
lockToken: string ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ReleaseCloudEvents (removed)
Description Release a batch of Cloud Events. The response will include the set of successfully released lock tokens, along with other failed lock tokens with their corresponding error information. Successfully released events can be received by consumers.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release
{
api-version: string ,
topicName: string ,
eventSubscriptionName: string ,
releaseDelayInSeconds: string ,
body:
{
lockTokens:
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
[
{
lockToken: string ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
RejectCloudEvents (removed)
Description Reject a batch of Cloud Events. The response will include the set of successfully rejected lock tokens, along with other failed lock tokens with their corresponding error information. Successfully rejected events will be dead-lettered and can no longer be received by a consumer.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:reject
{
api-version: string ,
topicName: string ,
eventSubscriptionName: string ,
body:
{
lockTokens:
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
[
{
lockToken: string ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
RenewCloudEventLocks (removed)
Description Renew locks for a batch of Cloud Events. The response will include the set of successfully renewed lock tokens, along with other failed lock tokens with their corresponding error information. Successfully renewed locks will ensure that the associated event is only available to the consumer that holds the renewed lock.
Reference Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:renewLock
{
api-version: string ,
topicName: string ,
eventSubscriptionName: string ,
body:
{
lockTokens:
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
[
{
lockToken: string ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}