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

2024/12/09 • 5 deleted methods

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

⚼ Request

POST:  /topics/{topicName}:publish
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
topicName:
{
Description: Topic Name. ,
Required: True ,
}
string ,
event:
{
Description: Single Cloud Event being published. ,
Required: True ,
}
{
id:
{
Description: An identifier for the event. The combination of id and source must be unique for each distinct event. ,
Required: True ,
}
string ,
source:
{
Description: Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event. ,
Required: True ,
}
string ,
data:
{
Description: Event data specific to the event type. ,
Required: False ,
}
string ,
data_base64:
{
Description: Event data specific to the event type, encoded as a base64 string. ,
Format: byte ,
Required: False ,
}
string ,
type:
{
Description: Type of event related to the originating occurrence. ,
Required: True ,
}
string ,
time:
{
Description: The time (in UTC) the event was generated, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
specversion:
{
Description: The version of the CloudEvents specification which the event uses. ,
Required: True ,
}
string ,
dataschema:
{
Description: Identifies the schema that data adheres to. ,
Required: False ,
}
string ,
datacontenttype:
{
Description: Content type of data value. ,
Required: False ,
}
string ,
subject:
{
Description: This describes the subject of the event in the context of the event producer (identified by source). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: The result of the Publish operation. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ReceiveCloudEvents (removed)
Description :  Receive a batch of Cloud Events from a subscription.
Reference :  Link ¶

⚼ Request

POST:  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
topicName:
{
Description: Topic Name. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Event Subscription Name. ,
Required: True ,
}
string ,
maxEvents:
{
Description: Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxWaitTime:
{
Description: Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Array of receive responses, one per cloud event. ,
Required: True ,
}
[
{
brokerProperties:
{
Description: The Event Broker details. ,
Required: True ,
}
{
lockToken:
{
Description: The token of the lock on the event. ,
Required: True ,
}
string ,
deliveryCount:
{
Description: The attempt count for delivering the event. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
event:
{
Description: Cloud Event details. ,
Required: True ,
}
{
id:
{
Description: An identifier for the event. The combination of id and source must be unique for each distinct event. ,
Required: True ,
}
string ,
source:
{
Description: Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event. ,
Required: True ,
}
string ,
data:
{
Description: Event data specific to the event type. ,
Required: False ,
}
string ,
data_base64:
{
Description: Event data specific to the event type, encoded as a base64 string. ,
Format: byte ,
Required: False ,
}
string ,
type:
{
Description: Type of event related to the originating occurrence. ,
Required: True ,
}
string ,
time:
{
Description: The time (in UTC) the event was generated, in RFC3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
specversion:
{
Description: The version of the CloudEvents specification which the event uses. ,
Required: True ,
}
string ,
dataschema:
{
Description: Identifies the schema that data adheres to. ,
Required: False ,
}
string ,
datacontenttype:
{
Description: Content type of data value. ,
Required: False ,
}
string ,
subject:
{
Description: This describes the subject of the event in the context of the event producer (identified by source). ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
topicName:
{
Description: Topic Name. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Event Subscription Name. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
lockTokens:
{
Description: Array of lock tokens. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
{
Description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). ,
Required: True ,
}
[
{
lockToken:
{
Description: The lock token of an entry in the request. ,
Required: True ,
}
string ,
error:
{
Description: Error information of the failed operation result for the lock token in the request. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
{
Description: Array of lock tokens for the successfully acknowledged cloud events. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
topicName:
{
Description: Topic Name. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Event Subscription Name. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
lockTokens:
{
Description: Array of lock tokens. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
{
Description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). ,
Required: True ,
}
[
{
lockToken:
{
Description: The lock token of an entry in the request. ,
Required: True ,
}
string ,
error:
{
Description: Error information of the failed operation result for the lock token in the request. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
{
Description: Array of lock tokens for the successfully released cloud events. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
topicName:
{
Description: Topic Name. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Event Subscription Name. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
lockTokens:
{
Description: Array of lock tokens. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
failedLockTokens:
{
Description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). ,
Required: True ,
}
[
{
lockToken:
{
Description: The lock token of an entry in the request. ,
Required: True ,
}
string ,
error:
{
Description: Error information of the failed operation result for the lock token in the request. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
succeededLockTokens:
{
Description: Array of lock tokens for the successfully rejected cloud events. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}