@azure/arm-largeinstance package

Classes

LargeInstanceManagementClient

Interfaces

AzureLargeInstance

Azure Large Instance info on Azure (ARM properties and AzureLargeInstance properties)

AzureLargeInstanceGetOptionalParams

Optional parameters.

AzureLargeInstanceListByResourceGroupNextOptionalParams

Optional parameters.

AzureLargeInstanceListByResourceGroupOptionalParams

Optional parameters.

AzureLargeInstanceListBySubscriptionNextOptionalParams

Optional parameters.

AzureLargeInstanceListBySubscriptionOptionalParams

Optional parameters.

AzureLargeInstanceListResult

The response of a AzureLargeInstance list operation.

AzureLargeInstanceOperations

Interface representing a AzureLargeInstanceOperations.

AzureLargeInstanceProperties

Describes the properties of an Azure Large Instance.

AzureLargeInstanceRestartHeaders

Defines headers for AzureLargeInstance_restart operation.

AzureLargeInstanceRestartOptionalParams

Optional parameters.

AzureLargeInstanceShutdownHeaders

Defines headers for AzureLargeInstance_shutdown operation.

AzureLargeInstanceShutdownOptionalParams

Optional parameters.

AzureLargeInstanceStartHeaders

Defines headers for AzureLargeInstance_start operation.

AzureLargeInstanceStartOptionalParams

Optional parameters.

AzureLargeInstanceTagsUpdate

The type used for updating tags in AzureLargeInstance resources.

AzureLargeInstanceUpdateOptionalParams

Optional parameters.

AzureLargeStorageInstance

AzureLargeStorageInstance info on Azure (ARM properties and AzureLargeStorageInstance properties)

AzureLargeStorageInstanceGetOptionalParams

Optional parameters.

AzureLargeStorageInstanceListByResourceGroupNextOptionalParams

Optional parameters.

AzureLargeStorageInstanceListByResourceGroupOptionalParams

Optional parameters.

AzureLargeStorageInstanceListBySubscriptionNextOptionalParams

Optional parameters.

AzureLargeStorageInstanceListBySubscriptionOptionalParams

Optional parameters.

AzureLargeStorageInstanceListResult

The response of a AzureLargeStorageInstance list operation.

AzureLargeStorageInstanceOperations

Interface representing a AzureLargeStorageInstanceOperations.

AzureLargeStorageInstanceProperties

Describes the properties of an AzureLargeStorageInstance.

AzureLargeStorageInstanceTagsUpdate

The type used for updating tags in AzureLargeStorageInstance resources.

AzureLargeStorageInstanceUpdateOptionalParams

Optional parameters.

Disk

Specifies the disk information fo the Azure Large Instance

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ForceState

The active state empowers the server with the ability to forcefully terminate and halt any existing processes that may be running on the server

HardwareProfile

Specifies the hardware settings for the Azure Large Instance.

IpAddress

Specifies the IP address of the network interface.

LargeInstanceManagementClientOptionalParams

Optional parameters.

NetworkProfile

Specifies the network settings for the Azure Large Instance disks.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

OperationStatusResult

The current status of an async operation.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OsProfile

Specifies the operating system settings for the Azure Large Instance.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

StorageBillingProperties

Describes the billing related details of the AzureLargeStorageInstance.

StorageProfile

Specifies the storage settings for the Azure Large Instance disks.

StorageProperties

described the storage properties of the azure large storage instance

SystemData

Metadata pertaining to creation and last modification of the resource.

Tags

Tags field of the AzureLargeInstance instance.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

AzureLargeInstanceForcePowerState

Defines values for AzureLargeInstanceForcePowerState.
KnownAzureLargeInstanceForcePowerState can be used interchangeably with AzureLargeInstanceForcePowerState, this enum contains the known values that the service supports.

Known values supported by the service

active: Active means that the restart operation will terminate and halt existing processes that may be running on the server
inactive: Inactive means that the restart operation will not terminate and halt existing processes that may be running on the server

AzureLargeInstanceGetResponse

Contains response data for the get operation.

AzureLargeInstanceHardwareTypeNamesEnum

Defines values for AzureLargeInstanceHardwareTypeNamesEnum.
KnownAzureLargeInstanceHardwareTypeNamesEnum can be used interchangeably with AzureLargeInstanceHardwareTypeNamesEnum, this enum contains the known values that the service supports.

Known values supported by the service

Cisco_UCS: Hardware type of UCS from vendor Cisco
HPE: Hardware type of HPE from vendor Hewlett Packard Enterprise
SDFLEX: Hardware type of SDFLEX

AzureLargeInstanceListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AzureLargeInstanceListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AzureLargeInstanceListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AzureLargeInstanceListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AzureLargeInstancePowerStateEnum

Defines values for AzureLargeInstancePowerStateEnum.
KnownAzureLargeInstancePowerStateEnum can be used interchangeably with AzureLargeInstancePowerStateEnum, this enum contains the known values that the service supports.

Known values supported by the service

starting: Starting means that the Azure Large Instance resource is turning on.
started: Started means that the Azure Large Instance resource has been powered on.
stopping: Stopping means that the Azure Large Instance resource is shutting down.
stopped: Stopped means that the Azure Large Instance resource has shut down.
restarting: Restarting means that the Azure Large Instance resource is restarting.
unknown: Unknown means that the state of the Azure Large Instance is unknown.

AzureLargeInstanceProvisioningStatesEnum

Defines values for AzureLargeInstanceProvisioningStatesEnum.
KnownAzureLargeInstanceProvisioningStatesEnum can be used interchangeably with AzureLargeInstanceProvisioningStatesEnum, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: Accepted means Azure Large Instance resource provisioning has been accepted.
Creating: Creating means Azure Large Instance resource is being created.
Updating: Updating means an existing Azure Large Instance resource is being updated
Failed: Failed means Azure Large Instance resource is in failed state
Succeeded: Succeeded means Azure Large Instance resource creation succeeded during last create/update
Deleting: Deleting means Azure Large Instance resource is in the process of being deleted
Migrating: Migrating means Azure Large Instance resource is being migrated from one subscription or resource group to another
Canceled: Cancelled Azure Large Instance resource operation has been cancelled

AzureLargeInstanceRestartResponse

Contains response data for the restart operation.

AzureLargeInstanceShutdownResponse

Contains response data for the shutdown operation.

AzureLargeInstanceSizeNamesEnum

Defines values for AzureLargeInstanceSizeNamesEnum.
KnownAzureLargeInstanceSizeNamesEnum can be used interchangeably with AzureLargeInstanceSizeNamesEnum, this enum contains the known values that the service supports.

Known values supported by the service

S72m: Type I class SKU that can't be purchased anymore
S144m: Type I class SKU that can't be purchased anymore
S72: Type I class SKU that can't be purchased anymore
S144: Type I class SKU that can't be purchased anymore
S192: Type I class SKU that can't be purchased anymore
S192m: Type I class SKU that can't be purchased anymore
S192xm: Type I class SKU that can't be purchased anymore
S96: 2 sockets, 96 CPU threads, 48 CPU cores, 768 GB total memory, 768 GB DRAM, 3.0 TB storage, Cisco_UCS hardware type
S112: No longer offered or used.
S224: 4 sockets, 224 CPU threads, 112 CPU cores, 3 TB total memory, 3 TB DRAM, 6.3 TB storage, Cisco_UCS hardware type
S224m: 4 sockets, 224 CPU threads, 112 CPU cores, 6 TB total memory, 6 TB DRAM, 10.5 TB storage, Cisco_UCS hardware type
S224om: 4 sockets, 224 CPU threads, 112 CPU cores, 6 TB total memory, 3 TB DRAM, 3 TB memory optane, 10.5 TB storage, Cisco_UCS hardware type
S224oo: 4 sockets, 224 CPU threads, 112 CPU cores, 4.5 TB total memory, 1.5 TB DRAM, 3 TB memory optane, 8.4 TB storage, Cisco_UCS hardware type
S224oom: 4 sockets, 224 CPU threads, 112 CPU cores, 9 TB total memory, 3 TB DRAM, 6 TB memory optane, 14.8 TB storage, Cisco_UCS hardware type
S224ooo: 4 sockets, 224 CPU threads, 112 CPU cores, 7.5TB total memory, 1.5 TB DRAM, 6 TB memory optane, 12.7 TB storage, Cisco_UCS hardware type
S224se: 4 sockets, 448 CPU threads, 6 TB total memory, SDFLEX hardware type
S384: 8 sockets, 384 CPU threads, 192 CPU cores, 4 TB total memory, 4 TB DRAM, 16 TB storage, HPEMc990x hardware type
S384m: 8 sockets, 384 CPU threads, 192 CPU cores, 6 TB total memory, 6 TB DRAM, 18 TB storage, HPEMc990x hardware type
S384xm: 8 sockets, 384 CPU threads, 192 CPU cores, 8 TB total memory, 8 TB DRAM, 22 TB storage, HPEMc990x hardware type
S384xxm: 8 sockets, 384 CPU threads, 12 TB total memory, HPEMc990x hardware type
S448: 8 sockets, 448 CPU threads, 224 CPU cores, 6 TB total memory, 6 TB DRAM, 10.5 TB storage, SDFLEX hardware type
S448m: 8 sockets, 448 CPU threads, 224 CPU cores, 12 TB total memory, 12 TB DRAM, 18.9 TB storage, SDFLEX hardware type
S448om: 8 sockets, 448 CPU threads, 224 CPU cores, 12 TB total memory, 6 TB DRAM, 6 TB memory optane, 18.9 TB storage, SDFLEX hardware type
S448oo: 8 sockets, 448 CPU threads, 224 CPU cores, 9 TB total memory, 3 TB DRAM, 6 TB memory optane, 14.8 TB storage, SDFLEX hardware type
S448oom: 8 sockets, 448 CPU threads, 224 CPU cores, 18 TB total memory, 6 TB DRAM, 12 memory optane, 27.4 TB storage, SDFLEX hardware type
S448ooo: 8 sockets, 448 CPU threads, 224 CPU cores, 15 TB total memory, 3 TB DRAM, 12 memory optane, 23.2 TB storage, SDFLEX hardware type
S448se: 8 sockets, 448 CPU threads, 12 TB total memory, SDFLEX hardware type
S576m: 12 sockets, 576 CPU threads, 288 CPU cores, 12 TB total memory, 12 TB DRAM, 28 TB storage, HPEMc990x hardware type
S576xm: 12 sockets, 576 CPU threads, 288 CPU cores, 18 TB total memory, HPEMc990x hardware type
S672: 12 sockets, 672 CPU threads, 336 CPU cores, 9 TB total memory, 9 TB DRAM, 14.7 TB storage, SDFLEX hardware type
S672m: 12 sockets, 672 CPU threads, 336 CPU cores, 18 TB total memory, 18 TB DRAM, 27.4 TB storage, SDFLEX hardware type
S672om: 12 sockets, 672 CPU threads, 336 CPU cores, 18 TB total memory, 9 TB DRAM, 9 TB memory optane, 27.4 TB storage, SDFLEX hardware type
S672oo: 12 sockets, 672 CPU threads, 336 CPU cores, 13.5 TB total memory, 4.5 TB DRAM, 9 TB memory optane, 21.1 TB storage, SDFLEX hardware type
S672oom: 12 sockets, 672 CPU threads, 336 CPU cores, 27 TB total memory, 9 TB DRAM, 18 TB memory optane, 40 TB storage, SDFLEX hardware type
S672ooo: 12 sockets, 672 CPU threads, 336 CPU cores, 22.5 TB total memory, 4.5 TB DRAM, 18 TB memory optane, 33.7 TB storage, SDFLEX hardware type
S768: No longer offered or used.
S768m: 16 sockets, 768 CPU threads, 384 CPU cores, 16 TB total memory, 16 TB DRAM, 36 TB storage, HPEMc990x hardware type
S768xm: 16 sockets, 768 CPU threads, 384 CPU cores, 24 TB total memory, 24 TB DRAM, 56 TB storage, HPEMc990x hardware type
S896: 16 sockets, 896 CPU threads, 448 CPU cores, 12 TB total memory, 12 TB DRAM, 18.9 TB storage, SDFLEX hardware type
S896m: 16 sockets, 896 CPU threads, 448 CPU cores, 24 TB total memory, 24 TB DRAM, 35.8 TB storage, SDFLEX hardware type
S896om: 16 sockets, 896 CPU threads, 448 CPU cores, 24 TB total memory, 12 TB DRAM, 12 TB memory optane, 35.8 TB storage, SDFLEX hardware type
S896oo: 16 sockets, 896 CPU threads, 448 CPU cores, 18 TB total memory, 6 TB DRAM, 12 TB memory optane, 27.4 TB storage, SDFLEX hardware type
S896oom: 16 sockets, 896 CPU threads, 448 CPU cores, 36 TB total memory, 12 TB DRAM, 24 TB memory optane, 52.7 TB storage, SDFLEX hardware type
S896ooo: 16 sockets, 896 CPU threads, 448 CPU cores, 30 TB total memory, 6 TB DRAM, 24 TB memory optane, 44.3 TB storage, SDFLEX hardware type
S960m: 20 sockets, 960 CPU threads, 480 CPU cores, 20 TB total memory, 20 TB DRAM, 46 TB storage, HPEMc990x hardware type

AzureLargeInstanceStartResponse

Contains response data for the start operation.

AzureLargeInstanceUpdateResponse

Contains response data for the update operation.

AzureLargeStorageInstanceGetResponse

Contains response data for the get operation.

AzureLargeStorageInstanceListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AzureLargeStorageInstanceListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AzureLargeStorageInstanceListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AzureLargeStorageInstanceListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AzureLargeStorageInstanceUpdateResponse

Contains response data for the update operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: Accepted means ARM resource has been accepted.
Creating: Creating means ARM resource is being created.
Updating: Updating means an existing ARM resource is being updated
Failed: Failed means resource is in failed state
Succeeded: Succeeded means resource creation succeeded during last create/update
Deleting: Deleting means resource is in the process of being deleted
Canceled: Cancelled means resource operation has been cancelled
Migrating: Migrating means resource is being migrated from one subscription or resource group to another

Versions

Defines values for Versions.
KnownVersions can be used interchangeably with Versions, this enum contains the known values that the service supports.

Known values supported by the service

2023-07-20-preview: Azure Large Instance api version 2023-07-20-preview.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownAzureLargeInstanceForcePowerState

Known values of AzureLargeInstanceForcePowerState that the service accepts.

KnownAzureLargeInstanceHardwareTypeNamesEnum

Known values of AzureLargeInstanceHardwareTypeNamesEnum that the service accepts.

KnownAzureLargeInstancePowerStateEnum

Known values of AzureLargeInstancePowerStateEnum that the service accepts.

KnownAzureLargeInstanceProvisioningStatesEnum

Known values of AzureLargeInstanceProvisioningStatesEnum that the service accepts.

KnownAzureLargeInstanceSizeNamesEnum

Known values of AzureLargeInstanceSizeNamesEnum that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownVersions

Known values of Versions that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.