receives
Creates, updates, deletes, gets or lists a receives resource.
Overview
| Name | receives |
| Type | Resource |
| Id | azure.event_grid_dataplane.receives |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
receive | exec | topic_name, event_subscription_name, endpoint | maxEvents, maxWaitTime | Receive a batch of Cloud Events from a subscription. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
event_subscription_name | string | Event Subscription Name. Required. |
topic_name | string | Topic Name. Required. |
maxEvents | integer | Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1. Default value is None. |
maxWaitTime | integer | 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. Default value is None. |
Lifecycle Methods
- receive
Receive a batch of Cloud Events from a subscription.
EXEC azure.event_grid_dataplane.receives.receive
@topic_name='{{ topic_name }}' --required,
@event_subscription_name='{{ event_subscription_name }}' --required,
@endpoint='{{ endpoint }}' --required,
@maxEvents='{{ maxEvents }}',
@maxWaitTime='{{ maxWaitTime }}'
;