Method GetAdminStatusAsync
GetAdminStatusAsync(AdminResult, GetAdminStatusOptions, CancellationToken)
On-premise only. Gets the status of the operation performed by
ExecuteAdminAsync.
Declaration
public Task<AdminResult> GetAdminStatusAsync(AdminResult adminResult, GetAdminStatusOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AdminResult | adminResult | Result returned by ExecuteAdminAsync. |
GetAdminStatusOptions | options | (Optional) Options for this operation.
If not specified or null , appropriate defaults
will be used. See GetAdminStatusOptions. |
CancellationToken | cancellationToken | (Optional) Cancellation token. |
Returns
Type | Description |
---|---|
Task<AdminResult> | Task returning AdminResult that reflects the current state of the operation. |
Remarks
This API is used to get information about the current state of the
admin DDL operation that was issued by
ExecuteAdminAsync
and is performed by the service
asynchronously. You do not need to use this API for the immediate
operations or after calling
ExecuteAdminWithCompletionAsync
because the the returned AdminResult will already
reflect the final completed state.
Exceptions
Type | Condition |
---|---|
ArgumentException | If
adminResult is null or
options contains invalid values. |
TimeoutException | Operation has timed out. |
InvalidOperationException | The service is not in a valid state to perform this operation. |
NoSQLException | NoSQLException or one of its subclasses is thrown if operation cannot be performed for any other reason. See documentation for corresponding subclass of NoSQLException. |