InstancesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DeviceUpdateMgmtClient's

<xref:instances> attribute.

Inheritance

builtins.object

InstancesOperations

Constructor

InstancesOperations(*args, **kwargs)

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.

begin_create(resource_group_name: str, account_name: str, instance_name: str, instance: _models.Instance, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Instance]

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.
instance_name Required	str Instance name. Required.
instance Required	Instance or IO Instance details. Is either a Instance type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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 PollingMethod By default, your polling method will be ARMPolling. 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

Type	Description
LROPoller[Instance]	An instance of LROPoller that returns either Instance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes instance.

begin_delete(resource_group_name: str, account_name: str, instance_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.
instance_name Required	str Instance name. Required.

Keyword-Only Parameters

Name	Description
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 PollingMethod By default, your polling method will be ARMPolling. 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

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Returns instance details for the given instance and account name.

get(resource_group_name: str, account_name: str, instance_name: str, **kwargs: Any) -> Instance

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.
instance_name Required	str Instance name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Instance	Instance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

head

Checks whether instance exists.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.
instance_name Required	str Instance name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
bool	bool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_account

Returns instances for the given account name.

list_by_account(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[Instance]

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Instance]	An iterator like instance of either Instance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates instance's tags.

update(resource_group_name: str, account_name: str, instance_name: str, tag_update_payload: _models.TagUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Instance

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
account_name Required	str Account name. Required.
instance_name Required	str Instance name. Required.
tag_update_payload Required	TagUpdate or IO Updated tags. Is either a TagUpdate type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Instance	Instance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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