Instances | @azure/arm-deviceupdate

Interface representing a Instances.

Hierarchy

Instances

Implemented by

InstancesImpl

Index

Methods

beginCreate

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

- Defined in operationsInterfaces/instances.ts:74
Creates or updates instance.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- instance: Instance
  
  Instance details.
- Optional options: InstancesCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<InstancesCreateResponse>, InstancesCreateResponse>>

beginCreateAndWait

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

- Defined in operationsInterfaces/instances.ts:94
Creates or updates instance.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- instance: Instance
  
  Instance details.
- Optional options: InstancesCreateOptionalParams
  
  The options parameters.
Returns Promise<InstancesCreateResponse>

beginDelete

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

- Defined in operationsInterfaces/instances.ts:108
Deletes instance.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- Optional options: InstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/instances.ts:121
Deletes instance.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- Optional options: InstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/instances.ts:47
Returns instance details for the given instance and account name.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- Optional options: InstancesGetOptionalParams
  
  The options parameters.
Returns Promise<InstancesGetResponse>

head

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

- Defined in operationsInterfaces/instances.ts:60
Checks whether instance exists.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- Optional options: InstancesHeadOptionalParams
  
  The options parameters.
Returns Promise<InstancesHeadResponse>

listByAccount

listByAccount(resourceGroupName: string, accountName: string, options?: InstancesListByAccountOptionalParams): PagedAsyncIterableIterator<Instance>

- Defined in operationsInterfaces/instances.ts:35
Returns instances for the given account name.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- Optional options: InstancesListByAccountOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Instance>

update

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

- Defined in operationsInterfaces/instances.ts:135
Updates instance's tags.

Parameters
- resourceGroupName: string
  
  The resource group name.
- accountName: string
  
  Account name.
- instanceName: string
  
  Instance name.
- tagUpdatePayload: TagUpdate
  
  Updated tags.
- Optional options: InstancesUpdateOptionalParams
  
  The options parameters.
Returns Promise<InstancesUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

accountName: string

instanceName: string

instance: Instance

Optional options: InstancesCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<InstancesCreateResponse>, InstancesCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

accountName: string

instanceName: string

instance: Instance

Optional options: InstancesCreateOptionalParams

Returns Promise<InstancesCreateResponse>

beginDelete

Parameters

resourceGroupName: string

accountName: string

instanceName: string

Optional options: InstancesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

accountName: string

instanceName: string

Optional options: InstancesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

instanceName: string

Optional options: InstancesGetOptionalParams

Returns Promise<InstancesGetResponse>

head

Parameters

resourceGroupName: string

accountName: string

instanceName: string

Optional options: InstancesHeadOptionalParams

Returns Promise<InstancesHeadResponse>

listByAccount

Parameters

resourceGroupName: string

accountName: string

Optional options: InstancesListByAccountOptionalParams

Returns PagedAsyncIterableIterator<Instance>

update

Parameters

resourceGroupName: string

accountName: string

instanceName: string

tagUpdatePayload: TagUpdate

Optional options: InstancesUpdateOptionalParams

Returns Promise<InstancesUpdateResponse>