@azure/arm-computerecommender package

Interfaces

ComputeDiagnosticBase

Contains metadata of a diagnostic type

ComputeRecommenderManagementClientOptionalParams

Optional parameters for the client.

DiagnosticProperties

Contains additional properties of a diagnostic

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.

Operation

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

OperationDisplay

Localized display information for an operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PlacementScore

The spot placement score for sku/region/zone combination.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

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

ResourceSize

SpotPlacementRecommender API response.

SkuMixPlacementBase

Contains metadata of the SkuMixPlacement scoring resource

SkuMixPlacementCapacityProfile

Capacity-related properties for the placement request.

SkuMixPlacementDeploymentChoice

A single deployment choice recommendation.

SkuMixPlacementInstanceDescription

Describes which VM sizes to consider.

SkuMixPlacementItem

A single VM size allocation within a deployment choice.

SkuMixPlacementProperties

Contains properties of the SkuMixPlacement resource.

SkuMixPlacementRequest

Sku Mix Placement API request.

SkuMixPlacementResponse

Sku Mix Placement API response.

SkuMixPlacementScoresGetOptionalParams

Optional parameters.

SkuMixPlacementScoresOperations

Interface representing a SkuMixPlacementScores operations.

SkuMixPlacementScoresPostOptionalParams

Optional parameters.

SkuMixPlacementSpotPriorityProfile

Spot priority configuration. Required when priority is Spot.

SkuMixPlacementVMSize

A VM size with optional rank for prioritization.

SkuMixPlacementZoneAllocationPolicy

Zone allocation policy for the placement request.

SkuMixPlacementZonePreference

Per-zone allocation preference.

SpotPlacementScoresGetOptionalParams

Optional parameters.

SpotPlacementScoresInput

SpotPlacementScores API Input.

SpotPlacementScoresOperations

Interface representing a SpotPlacementScores operations.

SpotPlacementScoresPostOptionalParams

Optional parameters.

SpotPlacementScoresResponse

SpotPlacementScores API response.

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

SkuMixPlacementAllocationStrategy

Allocation strategy for determining the optimal SKU split.
KnownSkuMixPlacementAllocationStrategy can be used interchangeably with SkuMixPlacementAllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

LowestPrice: VMs allocated to optimize for lowest price.
Prioritized: VMs allocated based on customer-specified rank for each VM size.
EvictionOptimized: VMs allocated to optimize for lowest eviction rate (Spot only).

SkuMixPlacementCapacityType

The unit type for the capacity value.
KnownSkuMixPlacementCapacityType can be used interchangeably with SkuMixPlacementCapacityType, this enum contains the known values that the service supports.

Known values supported by the service

VM: Capacity measured in number of VMs.
VCpu: Capacity measured in number of vCPUs.

SkuMixPlacementOSType

The OS type of the VMs.
KnownSkuMixPlacementOSType can be used interchangeably with SkuMixPlacementOSType, this enum contains the known values that the service supports.

Known values supported by the service

Windows: Windows OS.
Linux: Linux OS.

SkuMixPlacementPartialFulfillmentReason

Reason for partial fulfillment of the requested capacity.
KnownSkuMixPlacementPartialFulfillmentReason can be used interchangeably with SkuMixPlacementPartialFulfillmentReason, this enum contains the known values that the service supports.

Known values supported by the service

None: Full capacity was fulfilled.
InsufficientCapacity: Not enough allocable capacity was available.
InsufficientQuota: Not enough quota was available.

SkuMixPlacementPriority

Priority levels for VM allocation.
KnownSkuMixPlacementPriority can be used interchangeably with SkuMixPlacementPriority, this enum contains the known values that the service supports.

Known values supported by the service

Regular: Regular priority VMs with guaranteed capacity.
Spot: Spot priority VMs with lower cost but potential eviction.

SkuMixPlacementZonalDistributionStrategy

Strategy for distributing capacity across availability zones.
KnownSkuMixPlacementZonalDistributionStrategy can be used interchangeably with SkuMixPlacementZonalDistributionStrategy, this enum contains the known values that the service supports.

Known values supported by the service

BestEffortBalanced: Capacity distributed across zones on a best-effort balanced basis.
Prioritized: Zones filled based on zone preferences/rank. Higher priority zones filled first.
BestEffortSingleZone: Capacity allocated within a single zone on a best-effort basis; may spill across zones if single-zone capacity is insufficient.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownCreatedByType

The kind of entity that created the resource.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownSkuMixPlacementAllocationStrategy

Allocation strategy for determining the optimal SKU split.

KnownSkuMixPlacementCapacityType

The unit type for the capacity value.

KnownSkuMixPlacementOSType

The OS type of the VMs.

KnownSkuMixPlacementPartialFulfillmentReason

Reason for partial fulfillment of the requested capacity.

KnownSkuMixPlacementPriority

Priority levels for VM allocation.

KnownSkuMixPlacementZonalDistributionStrategy

Strategy for distributing capacity across availability zones.

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type