LROBasePolling Class

A base LRO poller.

This assumes a basic flow:

  • I analyze the response to decide the polling approach
  • I poll
  • I ask the final resource depending of the polling approach

If your polling need are more specific, you could implement a PollingMethod directly

Inheritance
azure.core.polling._poller.PollingMethod
LROBasePolling

Constructor

LROBasePolling(timeout=30, lro_algorithms=None, lro_options=None, path_format_arguments=None, **operation_config)

Parameters

timeout
default value: 30
lro_algorithms
default value: None
lro_options
default value: None
path_format_arguments
default value: None

Methods

finished

Is this polling finished? :rtype: bool

from_continuation_token
get_continuation_token
initialize

Set the initial status of this LRO.

request_status

Do a simple GET to this status link.

This method re-inject 'x-ms-client-request-id'.

resource

Return the built resource.

run
status

Return the current status as a string. :rtype: str

update_status

Update the current status of the LRO.

finished

Is this polling finished? :rtype: bool

finished()

from_continuation_token

from_continuation_token(continuation_token, **kwargs)

Parameters

cls
Required
continuation_token
Required

get_continuation_token

get_continuation_token()

initialize

Set the initial status of this LRO.

initialize(client, initial_response, deserialization_callback)

Parameters

initial_response
Required

The initial response of the poller

initial_response
Required
deserialization_callback
Required

Exceptions

HttpResponseError if initial status is incorrect LRO state

request_status

Do a simple GET to this status link.

This method re-inject 'x-ms-client-request-id'.

request_status(status_link)

Parameters

status_link
Required

Return type

resource

Return the built resource.

resource()

run

run()

status

Return the current status as a string. :rtype: str

status()

update_status

Update the current status of the LRO.

update_status()