azure.core.polling¶

class azure.core.polling.AsyncLROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: azure.core.polling._async_poller.AsyncPollingMethod[PollingReturnType_co])[source]¶

Async poller for long running operations.

Parameters

client (PipelineClient) – A pipeline service client
initial_response (PipelineResponse) – The initial call response
deserialization_callback (callable or msrest.serialization.Model) – A callback that takes a Response and return a deserialized object. If a subclass of Model is given, this passes “deserialize” as callback.
polling_method (AsyncPollingMethod) – The polling strategy to adopt

continuation_token() → str [source]¶

Return a continuation token that allows to restart the poller later.

Returns: An opaque continuation token
Return type: str

done() → bool [source]¶

Check status of the long running operation.

Returns: ‘True’ if the process has completed, else ‘False’.
Return type: bool

classmethod from_continuation_token(polling_method: azure.core.polling._async_poller.AsyncPollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[PollingReturnType_co][source]¶

polling_method() → azure.core.polling._async_poller.AsyncPollingMethod[PollingReturnType_co][source]¶

Return the polling method associated to this poller.

Returns: The polling method associated to this poller.
Return type: AsyncPollingMethod

async result() → PollingReturnType_co[source]¶

Return the result of the long running operation.

Returns: The deserialized resource of the long running operation, if one is available.
Return type: any or None
Raises: HttpResponseError – Server problem with the query.

status() → str [source]¶

Returns the current status string.

Returns: The current status string
Return type: str

async wait() → None [source]¶

Wait on the long running operation.

Raises: HttpResponseError – Server problem with the query.

class azure.core.polling.AsyncNoPolling[source]¶

An empty async poller that returns the deserialized initial response.

finished() → bool ¶

Is this polling finished?

Return type: bool
Returns: Whether this polling is finished

classmethod from_continuation_token(continuation_token: str, **kwargs: Any) → Tuple[Any, Any, Callable[[Any], PollingReturnType_co]]¶

get_continuation_token() → str ¶

initialize(_: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co]) → None ¶

resource() → PollingReturnType_co¶

async run() → None [source]¶: Empty run, no polling. Just override initial run to add “async”

status() → str ¶

Return the current status.

Return type: str
Returns: The current status

class azure.core.polling.AsyncPollingMethod[source]¶

ABC class for polling method.

finished() → bool [source]¶

classmethod from_continuation_token(continuation_token: str, **kwargs: Any) → Tuple[Any, Any, Any][source]¶

get_continuation_token() → str [source]¶

initialize(client: Any, initial_response: Any, deserialization_callback: Any) → None [source]¶

resource() → PollingReturnType_co[source]¶

async run() → None [source]¶

status() → str [source]¶

class azure.core.polling.LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: azure.core.polling._poller.PollingMethod[PollingReturnType_co])[source]¶

Poller for long running operations.

Parameters

client (PipelineClient) – A pipeline service client
initial_response (PipelineResponse) – The initial call response
deserialization_callback (callable or msrest.serialization.Model) – A callback that takes a Response and return a deserialized object. If a subclass of Model is given, this passes “deserialize” as callback.
polling_method (PollingMethod) – The polling strategy to adopt

add_done_callback(func: Callable) → None [source]¶

Add callback function to be run once the long running operation has completed - regardless of the status of the operation.

Parameters: func (callable) – Callback function that takes at least one argument, a completed LongRunningOperation.

continuation_token() → str [source]¶

Return a continuation token that allows to restart the poller later.

Returns: An opaque continuation token
Return type: str

done() → bool [source]¶

Check status of the long running operation.

Returns: ‘True’ if the process has completed, else ‘False’.
Return type: bool

classmethod from_continuation_token(polling_method: azure.core.polling._poller.PollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[PollingReturnType_co][source]¶

polling_method() → azure.core.polling._poller.PollingMethod[PollingReturnType_co][source]¶

Return the polling method associated to this poller.

Returns: The polling method
Return type: PollingMethod

remove_done_callback(func: Callable) → None [source]¶

Remove a callback from the long running operation.

Parameters: func (callable) – The function to be removed from the callbacks.
Raises: ValueError – if the long running operation has already completed.

result(timeout: Optional[float] = None) → PollingReturnType_co[source]¶

Return the result of the long running operation, or the result available after the specified timeout.

Parameters: timeout (float) – Period of time to wait before getting back control.
Returns: The deserialized resource of the long running operation, if one is available.
Return type: any or None
Raises: HttpResponseError – Server problem with the query.

status() → str [source]¶

Returns the current status string.

Returns: The current status string
Return type: str

wait(timeout: Optional[float] = None) → None [source]¶

Wait on the long running operation for a specified length of time. You can check if this call as ended with timeout with the “done()” method.

Parameters: timeout (float) – Period of time to wait for the long running operation to complete (in seconds).
Raises: HttpResponseError – Server problem with the query.

class azure.core.polling.NoPolling[source]¶

An empty poller that returns the deserialized initial response.

finished() → bool ¶

Is this polling finished?

Return type: bool
Returns: Whether this polling is finished

classmethod from_continuation_token(continuation_token: str, **kwargs: Any) → Tuple[Any, Any, Callable[[Any], PollingReturnType_co]]¶

get_continuation_token() → str ¶

initialize(_: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co]) → None ¶

resource() → PollingReturnType_co¶

run() → None [source]¶: Empty run, no polling.

status() → str ¶

Return the current status.

Return type: str
Returns: The current status

class azure.core.polling.PollingMethod[source]¶

ABC class for polling method.

finished() → bool [source]¶

classmethod from_continuation_token(continuation_token: str, **kwargs: Any) → Tuple[Any, Any, Any][source]¶

get_continuation_token() → str [source]¶

initialize(client: Any, initial_response: Any, deserialization_callback: Any) → None [source]¶

resource() → PollingReturnType_co[source]¶

run() → None [source]¶

status() → str [source]¶

async azure.core.polling.async_poller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: azure.core.polling._async_poller.AsyncPollingMethod[PollingReturnType_co]) → PollingReturnType_co[source]¶

Async Poller for long running operations.

Deprecated since version 1.5.0: Use AsyncLROPoller instead.

Parameters

client (PipelineClient) – A pipeline service client.
initial_response (PipelineResponse) – The initial call response
deserialization_callback (callable or msrest.serialization.Model) – A callback that takes a Response and return a deserialized object. If a subclass of Model is given, this passes “deserialize” as callback.
polling_method (PollingMethod) – The polling strategy to adopt

Returns

The final resource at the end of the polling.

Return type

any or None