OperationDetails Class

The current status of an async operation.

Readonly variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

OperationDetails(*args: Any, **kwargs: Any)

Variables

Name	Description
id	str Fully qualified ID for the operation status. Required.
name	str The operation id name. Required.
status	str or OperationStatus Provisioning state of the resource. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
resource_id	str The id of the resource.
start_time	datetime The start time of the operation.
end_time	datetime The end time of the operation.
percent_complete	float Percent of the operation that is complete.
properties	any Custom operation properties, populated only for a successful operation.
error	Error Operation Error message.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

end_time

The end time of the operation.

end_time: datetime | None

error

Operation Error message.

error: _models.Error | None

id

Fully qualified ID for the operation status. Required.

id: str

name

The operation id name. Required.

name: str

percent_complete

Percent of the operation that is complete.

percent_complete: float | None

properties

Custom operation properties, populated only for a successful operation.

properties: Any | None

resource_id

The id of the resource.

resource_id: str | None

start_time

The start time of the operation.

start_time: datetime | None

status

"NotStarted", "Running", "Succeeded", "Failed", and "Canceled".

status: str | _models.OperationStatus