Instances interface

Package:

@azure/arm-deviceupdate

Interface representing a Instances.

Methods

beginCreate(string, string, string, Instance, InstancesCreateOptionalParams)	Creates or updates instance.
beginCreateAndWait(string, string, string, Instance, InstancesCreateOptionalParams)	Creates or updates instance.
beginDelete(string, string, string, InstancesDeleteOptionalParams)	Deletes instance.
beginDeleteAndWait(string, string, string, InstancesDeleteOptionalParams)	Deletes instance.
get(string, string, string, InstancesGetOptionalParams)	Returns instance details for the given instance and account name.
head(string, string, string, InstancesHeadOptionalParams)	Checks whether instance exists.
listByAccount(string, string, InstancesListByAccountOptionalParams)	Returns instances for the given account name.
update(string, string, string, TagUpdate, InstancesUpdateOptionalParams)	Updates instance's tags.

Method Details

beginCreate(string, string, string, Instance, InstancesCreateOptionalParams)

Creates or updates instance.

function beginCreate(resourceGroupName: string, accountName: string, instanceName: string, instance: Instance, options?: InstancesCreateOptionalParams): Promise<PollerLike<PollOperationState<Instance>, Instance>>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

instance

Instance

Instance details.

options

InstancesCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Instance>, Instance>>

beginCreateAndWait(string, string, string, Instance, InstancesCreateOptionalParams)

Creates or updates instance.

function beginCreateAndWait(resourceGroupName: string, accountName: string, instanceName: string, instance: Instance, options?: InstancesCreateOptionalParams): Promise<Instance>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

instance

Instance

Instance details.

options

InstancesCreateOptionalParams

The options parameters.

Returns

Promise<Instance>

beginDelete(string, string, string, InstancesDeleteOptionalParams)

Deletes instance.

function beginDelete(resourceGroupName: string, accountName: string, instanceName: string, options?: InstancesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

options

InstancesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, InstancesDeleteOptionalParams)

Deletes instance.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, instanceName: string, options?: InstancesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

options

InstancesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, InstancesGetOptionalParams)

Returns instance details for the given instance and account name.

function get(resourceGroupName: string, accountName: string, instanceName: string, options?: InstancesGetOptionalParams): Promise<Instance>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

options

InstancesGetOptionalParams

The options parameters.

Returns

Promise<Instance>

head(string, string, string, InstancesHeadOptionalParams)

Checks whether instance exists.

function head(resourceGroupName: string, accountName: string, instanceName: string, options?: InstancesHeadOptionalParams): Promise<InstancesHeadResponse>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

options

InstancesHeadOptionalParams

The options parameters.

Returns

Promise<InstancesHeadResponse>

listByAccount(string, string, InstancesListByAccountOptionalParams)

Returns instances for the given account name.

function listByAccount(resourceGroupName: string, accountName: string, options?: InstancesListByAccountOptionalParams): PagedAsyncIterableIterator<Instance, Instance[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

options

InstancesListByAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Instance, Instance[], PageSettings>

update(string, string, string, TagUpdate, InstancesUpdateOptionalParams)

Updates instance's tags.

function update(resourceGroupName: string, accountName: string, instanceName: string, tagUpdatePayload: TagUpdate, options?: InstancesUpdateOptionalParams): Promise<Instance>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

instanceName

string

Instance name.

tagUpdatePayload

TagUpdate

Updated tags.

options

InstancesUpdateOptionalParams

The options parameters.

Returns

Promise<Instance>