@azure/arm-billingbenefits package

Classes

BillingBenefitsRP

Interfaces

AppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

BillingBenefitsRPOptionalParams

Optional parameters.

BillingInformation

billing information

BillingPlanInformation

Information describing the type of billing plan for this savings plan.

Commitment

Commitment towards the benefit.

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.).

ExtendedStatusInfo
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.

OperationResultError

Required if status == failed or status == canceled.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PaymentDetail

Information about payment related to a savings plan order.

Price
PricingCurrencyTotal
PurchaseRequest
RenewProperties
ReservationOrderAlias

Interface representing a ReservationOrderAlias.

ReservationOrderAliasCreateHeaders

Defines headers for ReservationOrderAlias_create operation.

ReservationOrderAliasCreateOptionalParams

Optional parameters.

ReservationOrderAliasGetOptionalParams

Optional parameters.

ReservationOrderAliasRequest

Reservation order alias

ReservationOrderAliasRequestPropertiesReservedResourceProperties

Properties specific to each reserved resource type. Not required if not applicable.

ReservationOrderAliasResponse

Reservation order alias

ReservationOrderAliasResponsePropertiesReservedResourceProperties

Properties specific to each reserved resource type. Not required if not applicable.

Resource

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

RoleAssignmentEntity

Role assignment entity

SavingsPlan

Interface representing a SavingsPlan.

SavingsPlanGetOptionalParams

Optional parameters.

SavingsPlanListAllNextOptionalParams

Optional parameters.

SavingsPlanListAllOptionalParams

Optional parameters.

SavingsPlanListNextOptionalParams

Optional parameters.

SavingsPlanListOptionalParams

Optional parameters.

SavingsPlanModel

Savings plan

SavingsPlanModelList
SavingsPlanModelListResult
SavingsPlanOrder

Interface representing a SavingsPlanOrder.

SavingsPlanOrderAlias

Interface representing a SavingsPlanOrderAlias.

SavingsPlanOrderAliasCreateHeaders

Defines headers for SavingsPlanOrderAlias_create operation.

SavingsPlanOrderAliasCreateOptionalParams

Optional parameters.

SavingsPlanOrderAliasGetOptionalParams

Optional parameters.

SavingsPlanOrderAliasModel

Savings plan order alias

SavingsPlanOrderElevateOptionalParams

Optional parameters.

SavingsPlanOrderGetOptionalParams

Optional parameters.

SavingsPlanOrderListNextOptionalParams

Optional parameters.

SavingsPlanOrderListOptionalParams

Optional parameters.

SavingsPlanOrderModel

Savings plan order

SavingsPlanOrderModelList
SavingsPlanPurchaseValidateRequest
SavingsPlanSummary

Savings plans list summary

SavingsPlanSummaryCount

The roll up count summary of savings plans in each state

SavingsPlanUpdateHeaders

Defines headers for SavingsPlan_update operation.

SavingsPlanUpdateOptionalParams

Optional parameters.

SavingsPlanUpdateRequest

Savings plan patch request

SavingsPlanUpdateRequestProperties

Savings plan patch request

SavingsPlanUpdateValidateRequest
SavingsPlanValidResponseProperty

Benefit scope response property

SavingsPlanValidateResponse
SavingsPlanValidateUpdateOptionalParams

Optional parameters.

Sku

The SKU to be applied for this resource

SystemData

Metadata pertaining to creation and last modification of the resource.

Utilization

Savings plan utilization

UtilizationAggregates

The aggregate values of savings plan utilization

ValidatePurchaseOptionalParams

Optional parameters.

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

AppliedScopeType

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

Known values supported by the service

Single
Shared
ManagementGroup

BillingPlan

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

Known values supported by the service

P1M

CommitmentGrain

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

Known values supported by the service

Hourly

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

InstanceFlexibility

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

Known values supported by the service

On
Off

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

PaymentStatus

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

Known values supported by the service

Succeeded
Failed
Scheduled
Cancelled

PricingCurrencyDuration

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

Known values supported by the service

P1M
P1Y
P3Y

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

Creating
PendingBilling
ConfirmedBilling
Created
Succeeded
Cancelled
Expired
Failed

ReservationOrderAliasCreateResponse

Contains response data for the create operation.

ReservationOrderAliasGetResponse

Contains response data for the get operation.

ReservedResourceType

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

Known values supported by the service

VirtualMachines
SqlDatabases
SuseLinux
CosmosDb
RedHat
SqlDataWarehouse
VMwareCloudSimple
RedHatOsa
Databricks
AppService
ManagedDisk
BlockBlob
RedisCache
AzureDataExplorer
MySql
MariaDb
PostgreSql
DedicatedHost
SapHana
SqlAzureHybridBenefit
AVS
DataFactory
NetAppStorage
AzureFiles
SqlEdge
VirtualMachineSoftware

SavingsPlanGetResponse

Contains response data for the get operation.

SavingsPlanListAllNextResponse

Contains response data for the listAllNext operation.

SavingsPlanListAllResponse

Contains response data for the listAll operation.

SavingsPlanListNextResponse

Contains response data for the listNext operation.

SavingsPlanListResponse

Contains response data for the list operation.

SavingsPlanOrderAliasCreateResponse

Contains response data for the create operation.

SavingsPlanOrderAliasGetResponse

Contains response data for the get operation.

SavingsPlanOrderElevateResponse

Contains response data for the elevate operation.

SavingsPlanOrderGetResponse

Contains response data for the get operation.

SavingsPlanOrderListNextResponse

Contains response data for the listNext operation.

SavingsPlanOrderListResponse

Contains response data for the list operation.

SavingsPlanUpdateResponse

Contains response data for the update operation.

SavingsPlanValidateUpdateResponse

Contains response data for the validateUpdate operation.

Term

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

Known values supported by the service

P1Y
P3Y
P5Y

ValidatePurchaseResponse

Contains response data for the validatePurchase operation.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownAppliedScopeType

Known values of AppliedScopeType that the service accepts.

KnownBillingPlan

Known values of BillingPlan that the service accepts.

KnownCommitmentGrain

Known values of CommitmentGrain that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownInstanceFlexibility

Known values of InstanceFlexibility that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPaymentStatus

Known values of PaymentStatus that the service accepts.

KnownPricingCurrencyDuration

Known values of PricingCurrencyDuration that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownReservedResourceType

Known values of ReservedResourceType that the service accepts.

KnownTerm

Known values of Term 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.