AzureLargeInstanceOperations interface

Package:

@azure/arm-largeinstance

Interface representing a AzureLargeInstanceOperations.

Methods

beginRestart(string, string, AzureLargeInstanceRestartOptionalParams)	The operation to restart an Azure Large Instance (only for compute instances)
beginRestartAndWait(string, string, AzureLargeInstanceRestartOptionalParams)	The operation to restart an Azure Large Instance (only for compute instances)
beginShutdown(string, string, AzureLargeInstanceShutdownOptionalParams)	The operation to shutdown an Azure Large Instance (only for compute instances)
beginShutdownAndWait(string, string, AzureLargeInstanceShutdownOptionalParams)	The operation to shutdown an Azure Large Instance (only for compute instances)
beginStart(string, string, AzureLargeInstanceStartOptionalParams)	The operation to start an Azure Large Instance (only for compute instances)
beginStartAndWait(string, string, AzureLargeInstanceStartOptionalParams)	The operation to start an Azure Large Instance (only for compute instances)
get(string, string, AzureLargeInstanceGetOptionalParams)	Gets an Azure Large Instance for the specified subscription, resource group, and instance name.
listByResourceGroup(string, AzureLargeInstanceListByResourceGroupOptionalParams)	Gets a list of Azure Large Instances in the specified subscription and resource group. The operations returns various properties of each Azure Large Instance.
listBySubscription(AzureLargeInstanceListBySubscriptionOptionalParams)	Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance.
update(string, string, AzureLargeInstanceTagsUpdate, AzureLargeInstanceUpdateOptionalParams)	Patches the Tags field of an Azure Large Instance for the specified subscription, resource group, and instance name.

Method Details

beginRestart(string, string, AzureLargeInstanceRestartOptionalParams)

The operation to restart an Azure Large Instance (only for compute instances)

function beginRestart(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceRestartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginRestartAndWait(string, string, AzureLargeInstanceRestartOptionalParams)

The operation to restart an Azure Large Instance (only for compute instances)

function beginRestartAndWait(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceRestartOptionalParams): Promise<OperationStatusResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceRestartOptionalParams

The options parameters.

Returns

Promise<OperationStatusResult>

beginShutdown(string, string, AzureLargeInstanceShutdownOptionalParams)

The operation to shutdown an Azure Large Instance (only for compute instances)

function beginShutdown(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceShutdownOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceShutdownOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginShutdownAndWait(string, string, AzureLargeInstanceShutdownOptionalParams)

The operation to shutdown an Azure Large Instance (only for compute instances)

function beginShutdownAndWait(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceShutdownOptionalParams): Promise<OperationStatusResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceShutdownOptionalParams

The options parameters.

Returns

Promise<OperationStatusResult>

beginStart(string, string, AzureLargeInstanceStartOptionalParams)

The operation to start an Azure Large Instance (only for compute instances)

function beginStart(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceStartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginStartAndWait(string, string, AzureLargeInstanceStartOptionalParams)

The operation to start an Azure Large Instance (only for compute instances)

function beginStartAndWait(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceStartOptionalParams): Promise<OperationStatusResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceStartOptionalParams

The options parameters.

Returns

Promise<OperationStatusResult>

get(string, string, AzureLargeInstanceGetOptionalParams)

Gets an Azure Large Instance for the specified subscription, resource group, and instance name.

function get(resourceGroupName: string, azureLargeInstanceName: string, options?: AzureLargeInstanceGetOptionalParams): Promise<AzureLargeInstance>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

options

AzureLargeInstanceGetOptionalParams

The options parameters.

Returns

Promise<AzureLargeInstance>

listByResourceGroup(string, AzureLargeInstanceListByResourceGroupOptionalParams)

Gets a list of Azure Large Instances in the specified subscription and resource group. The operations returns various properties of each Azure Large Instance.

function listByResourceGroup(resourceGroupName: string, options?: AzureLargeInstanceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AzureLargeInstance, AzureLargeInstance[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

AzureLargeInstanceListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AzureLargeInstance, AzureLargeInstance[], PageSettings>

listBySubscription(AzureLargeInstanceListBySubscriptionOptionalParams)

Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance.

function listBySubscription(options?: AzureLargeInstanceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<AzureLargeInstance, AzureLargeInstance[], PageSettings>

Parameters

options

AzureLargeInstanceListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AzureLargeInstance, AzureLargeInstance[], PageSettings>

update(string, string, AzureLargeInstanceTagsUpdate, AzureLargeInstanceUpdateOptionalParams)

Patches the Tags field of an Azure Large Instance for the specified subscription, resource group, and instance name.

function update(resourceGroupName: string, azureLargeInstanceName: string, tagsParameter: AzureLargeInstanceTagsUpdate, options?: AzureLargeInstanceUpdateOptionalParams): Promise<AzureLargeInstance>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

azureLargeInstanceName

string

Name of the AzureLargeInstance.

tagsParameter

AzureLargeInstanceTagsUpdate

The resource properties to be updated.

options

AzureLargeInstanceUpdateOptionalParams

The options parameters.

Returns

Promise<AzureLargeInstance>