renew_locks
Creates, updates, deletes, gets or lists a renew_locks resource.
Overview
| Name | renew_locks |
| Type | Resource |
| Id | azure.event_grid_dataplane.renew_locks |
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 |
|---|---|---|---|---|
renew_locks | exec | topic_name, event_subscription_name, endpoint | 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. |
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. |
Lifecycle Methods
- renew_locks
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.
EXEC azure.event_grid_dataplane.renew_locks.renew_locks
@topic_name='{{ topic_name }}' --required,
@event_subscription_name='{{ event_subscription_name }}' --required,
@endpoint='{{ endpoint }}' --required
;