InstancesOperations Class

InstancesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

InstancesOperations

Constructor

InstancesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create	Creates or updates instance.
begin_delete	Deletes instance.
get	Returns instance details for the given instance and account name.
head	Checks whether instance exists.
list_by_account	Returns instances for the given account name.
update	Updates instance's tags.

begin_create

Creates or updates instance.

async begin_create(resource_group_name: str, account_name: str, instance_name: str, instance: azure.mgmt.deviceupdate.models._models_py3.Instance, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.deviceupdate.models._models_py3.Instance]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

instance_name

str

Required

Instance name.

instance

<xref:device_update.models.Instance>

Required

Instance details.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Instance or the result of cls(response)

Return type

AsyncLROPoller[<xref:device_update.models.Instance>]

Exceptions

HttpResponseError

begin_delete

Deletes instance.

async begin_delete(resource_group_name: str, account_name: str, instance_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

instance_name

str

Required

Instance name.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Returns instance details for the given instance and account name.

async get(resource_group_name: str, account_name: str, instance_name: str, **kwargs: Any) -> azure.mgmt.deviceupdate.models._models_py3.Instance

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

instance_name

str

Required

Instance name.

cls

callable

A custom type or function that will be passed the direct response

Returns

Instance, or the result of cls(response)

Return type

<xref:device_update.models.Instance>

Exceptions

HttpResponseError

head

Checks whether instance exists.

async head(resource_group_name: str, account_name: str, instance_name: str, **kwargs: Any) -> bool

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

instance_name

str

Required

Instance name.

cls

callable

A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Exceptions

HttpResponseError

list_by_account

Returns instances for the given account name.

list_by_account(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.deviceupdate.models._models_py3.InstanceList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either InstanceList or the result of cls(response)

Return type

AsyncItemPaged[<xref:device_update.models.InstanceList>]

Exceptions

HttpResponseError

update

Updates instance's tags.

async update(resource_group_name: str, account_name: str, instance_name: str, tag_update_payload: azure.mgmt.deviceupdate.models._models_py3.TagUpdate, **kwargs: Any) -> azure.mgmt.deviceupdate.models._models_py3.Instance

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

Account name.

instance_name

str

Required

Instance name.

tag_update_payload

<xref:device_update.models.TagUpdate>

Required

Updated tags.

cls

callable

A custom type or function that will be passed the direct response

Returns

Instance, or the result of cls(response)

Return type

<xref:device_update.models.Instance>

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.deviceupdate.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\deviceupdate\\models\\__init__.py'>