Share via

AzureReservationAPI class

  • Reference
Package:
@azure/arm-reservations
Extends
ServiceClient

Constructors

AzureReservationAPI(TokenCredential, AzureReservationAPIOptionalParams)

Initializes a new instance of the AzureReservationAPI class.

Properties

$host
calculateExchange
calculateRefund
exchange
operation
quota
quotaRequestStatus
reservation
reservationOrder
return

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

getAppliedReservationList(string, GetAppliedReservationListOptionalParams)

Get applicable Reservations that are applied to this subscription or a resource group under this subscription.
listCatalog(string, GetCatalogOptionalParams)

Get the regions and skus that are available for RI purchase for the specified Azure subscription.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

AzureReservationAPI(TokenCredential, AzureReservationAPIOptionalParams)

Initializes a new instance of the AzureReservationAPI class.

new AzureReservationAPI(credentials: TokenCredential, options?: AzureReservationAPIOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

options
AzureReservationAPIOptionalParams

The parameter options

Property Details

$host 

$host: string

Property Value

string

calculateExchange 

calculateExchange: CalculateExchange

Property Value

CalculateExchange

calculateRefund 

calculateRefund: CalculateRefund

Property Value

CalculateRefund

exchange 

exchange: Exchange

Property Value

Exchange

operation 

operation: Operation

Property Value

Operation

quota 

quota: Quota

Property Value

Quota

quotaRequestStatus 

quotaRequestStatus: QuotaRequestStatus

Property Value

QuotaRequestStatus

reservation 

reservation: Reservation

Property Value

Reservation

reservationOrder 

reservationOrder: ReservationOrder

Property Value

ReservationOrder

return 

return: Return

Property Value

Return

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

getAppliedReservationList(string, GetAppliedReservationListOptionalParams)

Get applicable Reservations that are applied to this subscription or a resource group under this subscription.

function getAppliedReservationList(subscriptionId: string, options?: GetAppliedReservationListOptionalParams): Promise<AppliedReservations>

Parameters

subscriptionId

string

Id of the subscription

options
GetAppliedReservationListOptionalParams

The options parameters.

Returns

Promise<AppliedReservations>

listCatalog(string, GetCatalogOptionalParams)

Get the regions and skus that are available for RI purchase for the specified Azure subscription.

function listCatalog(subscriptionId: string, options?: GetCatalogOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Parameters

subscriptionId

string

Id of the subscription

options
GetCatalogOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest