@azure/arm-billingbenefits package

Classes

BillingBenefitsRP

Interfaces

ApplicableMacc	Applicable MACC.
ApplicableMaccsListOptionalParams	Optional parameters.
ApplicableMaccsOperations	Interface representing a ApplicableMaccs operations.
AppliedScopeProperties	Properties specific to applied scope type. Not required if not applicable.
AutomaticShortfallSuppressReason	Optional field to record suppression reason for automatic shortfall.
Award	Award details for milestone completion
BenefitOperations	Interface representing a Benefit operations.
BenefitValidateModel	Abstract benefit model to validate.
BenefitValidateOptionalParams	Optional parameters.
BenefitValidateRequest	Request to validate any benefit.
BenefitValidateResponse	Benefit validate response.
BenefitValidateResponseProperty	Benefit validate response property
BillingBenefitsRPOptionalParams	Optional parameters for the client.
BillingPlanInformation	Information describing the type of billing plan for this savings plan.
CatalogClaimsItem	Catalog claim for a discount.
ChargeShortfallRequest	Charge shortfall request
Commitment	Commitment towards the benefit.
ConditionalCredit	Resource definition for Conditional Credits.
ConditionalCreditContributor	Conditional credit contributor
ConditionalCreditContributorsGetFromPrimaryOptionalParams	Optional parameters.
ConditionalCreditContributorsListFromApplicableConditionalCreditOptionalParams	Optional parameters.
ConditionalCreditContributorsListFromPrimaryOptionalParams	Optional parameters.
ConditionalCreditContributorsOperations	Interface representing a ConditionalCreditContributors operations.
ConditionalCreditMilestone	Milestone definition within a conditional credit
ConditionalCreditMilestoneBase	Base milestone definition for conditional credits
ConditionalCreditPatchRequest	Conditional credit patch request
ConditionalCreditPatchRequestProperties	Conditional credit patch request properties
ConditionalCreditProperties	Properties belonging to conditional credits.
ConditionalCreditsCancelOptionalParams	Optional parameters.
ConditionalCreditsCreateOrUpdateOptionalParams	Optional parameters.
ConditionalCreditsDeleteOptionalParams	Optional parameters.
ConditionalCreditsGetOptionalParams	Optional parameters.
ConditionalCreditsListByResourceGroupOptionalParams	Optional parameters.
ConditionalCreditsListBySubscriptionOptionalParams	Optional parameters.
ConditionalCreditsOperations	Interface representing a ConditionalCredits operations.
ConditionalCreditsScopeListOptionalParams	Optional parameters.
ConditionalCreditsUpdateOptionalParams	Optional parameters.
ConditionalCreditsValidateModel	Conditional Credits validate model
ConditionsItem	Condition for a discount.
Contributor	MACC contributor
ContributorConditionalCreditMilestone	Milestone definition for contributor conditional credit (excludes award details)
ContributorConditionalCreditProperties	Properties for contributor conditional credit.
ContributorsGetFromPrimaryOptionalParams	Optional parameters.
ContributorsListFromApplicableMaccOptionalParams	Optional parameters.
ContributorsListFromPrimaryOptionalParams	Optional parameters.
ContributorsOperations	Interface representing a Contributors operations.
Credit	Credit resource definition
CreditBreakdownItem	Credit breakdown item representing a milestone, line-item, or no-charge service
CreditDimension	Key-value pair for additional credit parameters and metadata
CreditPatchProperties	Credit patch properties
CreditPatchRequest	Credit patch request
CreditPolicies	Credit breakdown item representing a milestone, line-item, or no-charge service
CreditProperties	Properties of a credit
CreditReason	The reason for the credit. Not required if not applicable.
CreditSource	Credit source resource definition
CreditSourcePatchRequest	Credit patch request
CreditSourceProperties	Properties of a credit source
CreditsCancelOptionalParams	Optional parameters.
CreditsCreateOptionalParams	Optional parameters.
CreditsDeleteOptionalParams	Optional parameters.
CreditsGetOptionalParams	Optional parameters.
CreditsListApplicableOptionalParams	Optional parameters.
CreditsListByResourceGroupOptionalParams	Optional parameters.
CreditsListBySubscriptionOptionalParams	Optional parameters.
CreditsOperations	Interface representing a Credits operations.
CreditsUpdateOptionalParams	Optional parameters.
CreditsValidateModel	Credits validate model
CustomPriceProperties	Custom price properties for a given discount.
Discount	Resource definition for Discounts.
DiscountGetOptionalParams	Optional parameters.
DiscountOperations	Interface representing a Discount operations.
DiscountPatchRequest	Discounts patch request
DiscountPatchRequestProperties	Discounts patch request properties
DiscountProperties	Properties belonging to discounts.
DiscountTypeCustomPrice	Discount type properties including product family name, product id, sku, and custom price properties. Allows a single entry in marketSetPrices.
DiscountTypeCustomPriceMultiCurrency	Discount type properties including product family name, product id, sku, and custom price properties. Allows multiple entries in marketSetPrices.
DiscountTypeProduct	Discount type properties including product family name and product id.
DiscountTypeProductFamily	Discount type properties including product family name
DiscountTypeProductSku	Discount type properties including product family name, product id, and sku id.
DiscountTypeProperties	This defines the conditions for a given discount type.
DiscountUpdateOptionalParams	Optional parameters.
DiscountsCancelOptionalParams	Optional parameters.
DiscountsCreateOptionalParams	Optional parameters.
DiscountsDeleteOptionalParams	Optional parameters.
DiscountsOperations	Interface representing a Discounts operations.
DiscountsResourceGroupListOptionalParams	Optional parameters.
DiscountsScopeListOptionalParams	Optional parameters.
DiscountsSubscriptionListOptionalParams	Optional parameters.
EntityTypeAffiliateDiscount	Entity type for affiliate discounts
EntityTypePrimaryDiscount	Entity type for primary discounts
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.
ExtendedStatusInfo	model interface ExtendedStatusInfo
FreeServices	Free Services resource definition
FreeServicesCreateOptionalParams	Optional parameters.
FreeServicesDeleteOptionalParams	Optional parameters.
FreeServicesGetOptionalParams	Optional parameters.
FreeServicesListByResourceGroupOptionalParams	Optional parameters.
FreeServicesListBySubscriptionOptionalParams	Optional parameters.
FreeServicesOperations	Interface representing a FreeServices operations.
FreeServicesPatchRequest	Free services patch request
FreeServicesPatchRequestProperties	Free services patch request properties
FreeServicesProperties	Properties of free services
FreeServicesUpdateOptionalParams	Optional parameters.
Macc	Microsoft Azure Consumption Commitment.
MaccMilestone	MACC milestone represents interim targets within the period of MACC.
MaccModelProperties	MACC properties
MaccPatchRequest	Macc patch request
MaccPatchRequestProperties	Macc patch request properties
MaccValidateModel	MACC validate model
MaccsCancelOptionalParams	Optional parameters.
MaccsChargeShortfallOptionalParams	Optional parameters.
MaccsCreateOptionalParams	Optional parameters.
MaccsDeleteOptionalParams	Optional parameters.
MaccsGetOptionalParams	Optional parameters.
MaccsListByResourceGroupOptionalParams	Optional parameters.
MaccsListBySubscriptionOptionalParams	Optional parameters.
MaccsOperations	Interface representing a Maccs operations.
MaccsUpdateOptionalParams	Optional parameters.
MaccsWriteOffOptionalParams	Optional parameters.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MarketSetPricesItems	Items in the MarketSetPrices array.
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.
PaymentDetail	Information about payment related to a savings plan order.
Plan	Plan for the resource.
Price	model interface Price
PriceGuaranteeProperties	Set only in price guarantee scenario.
PrimaryConditionalCreditProperties	Properties for primary conditional credit.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PurchaseRequest	model interface PurchaseRequest
PurchaseRequestProperties	model interface PurchaseRequestProperties
RenewProperties	model interface RenewProperties
ReservationOrderAliasCreateOptionalParams	Optional parameters.
ReservationOrderAliasGetOptionalParams	Optional parameters.
ReservationOrderAliasOperations	Interface representing a ReservationOrderAlias operations.
ReservationOrderAliasRequest	Reservation order alias
ReservationOrderAliasRequestProperties	Reservation properties
ReservationOrderAliasRequestPropertiesReservedResourceProperties	Properties specific to each reserved resource type. Not required if not applicable.
ReservationOrderAliasResponse	Reservation order alias
ReservationOrderAliasResponseProperties	Reservation properties
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
ResourceSku	model interface ResourceSku
RestorePollerOptions
RoleAssignmentEntity	Role assignment entity
RoleAssignmentEntityProperties	Role assignment entity properties
SavingsPlanGetOptionalParams	Optional parameters.
SavingsPlanListAllOptionalParams	Optional parameters.
SavingsPlanListOptionalParams	Optional parameters.
SavingsPlanModel	Savings plan
SavingsPlanModelProperties	Savings plan properties
SavingsPlanOperations	Interface representing a SavingsPlan operations.
SavingsPlanOrderAliasCreateOptionalParams	Optional parameters.
SavingsPlanOrderAliasGetOptionalParams	Optional parameters.
SavingsPlanOrderAliasModel	Savings plan order alias
SavingsPlanOrderAliasOperations	Interface representing a SavingsPlanOrderAlias operations.
SavingsPlanOrderAliasProperties	Savings plan properties
SavingsPlanOrderElevateOptionalParams	Optional parameters.
SavingsPlanOrderGetOptionalParams	Optional parameters.
SavingsPlanOrderListOptionalParams	Optional parameters.
SavingsPlanOrderModel	Savings plan order
SavingsPlanOrderModelProperties	Savings plan order properties
SavingsPlanOrderOperations	Interface representing a SavingsPlanOrder operations.
SavingsPlanSummary	Savings plans list summary
SavingsPlanSummaryCount	The roll up count summary of savings plans in each state
SavingsPlanUpdateOptionalParams	Optional parameters.
SavingsPlanUpdateRequest	Savings plan patch request
SavingsPlanUpdateRequestProperties	Savings plan patch request
SavingsPlanUpdateValidateRequest	model interface SavingsPlanUpdateValidateRequest
SavingsPlanValidResponseProperty	Benefit scope response property
SavingsPlanValidateModel	Savings plan validate model
SavingsPlanValidateResponse	model interface SavingsPlanValidateResponse
SavingsPlanValidateUpdateOptionalParams	Optional parameters.
SellerResourceListOptionalParams	Optional parameters.
SellerResourceListRequest	List MACCs under a billing account
SellerResourceListRequestProperties	Request properties to list maccs under a billing account
SellerResourceOperations	Interface representing a SellerResource operations.
ServiceManagedIdentity	Managed service identity (system assigned and/or user assigned identities)
Shortfall	MACC shortfall
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	The resource model definition representing SKU
SourcesCreateOptionalParams	Optional parameters.
SourcesDeleteOptionalParams	Optional parameters.
SourcesGetOptionalParams	Optional parameters.
SourcesListByCreditOptionalParams	Optional parameters.
SourcesOperations	Interface representing a Sources operations.
SourcesUpdateOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
Utilization	Savings plan utilization
UtilizationAggregates	The aggregate values of savings plan utilization

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.
AppliedScopeType	Type of the Applied Scope. 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
ApplyDiscountOn	The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. KnownApplyDiscountOn can be used interchangeably with ApplyDiscountOn, this enum contains the known values that the service supports. Known values supported by the service Purchase Consume Renew
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BenefitType	Represents benefit model type for validation. KnownBenefitType can be used interchangeably with BenefitType, this enum contains the known values that the service supports. Known values supported by the service SavingsPlan MACC ConditionalCredits Credits
BenefitValidateModelUnion	Alias for BenefitValidateModelUnion
BillingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. 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	Grain. KnownCommitmentGrain can be used interchangeably with CommitmentGrain, this enum contains the known values that the service supports. Known values supported by the service Hourly FullTerm Unknown
ConditionalCreditEntityType	Type of conditional credit entity KnownConditionalCreditEntityType can be used interchangeably with ConditionalCreditEntityType, this enum contains the known values that the service supports. Known values supported by the service Primary Contributor
ConditionalCreditPropertiesUnion	Alias for ConditionalCreditPropertiesUnion
ConditionalCreditStatus	The status of the conditional credit KnownConditionalCreditStatus can be used interchangeably with ConditionalCreditStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown Scheduled Active Pending Failed Canceled Completed Stopped PendingSettlement
ConditionalCreditsProvisioningState	The provisioning state of the resource KnownConditionalCreditsProvisioningState can be used interchangeably with ConditionalCreditsProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded Failed Canceled Pending
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.
CreditExpirationPolicy	Expiration policy of the Credit KnownCreditExpirationPolicy can be used interchangeably with CreditExpirationPolicy, this enum contains the known values that the service supports. Known values supported by the service None: No policy applied to the expiration of this credit SuspendBillingProfile: Billing profile is suspended when the credit expires
CreditRedemptionPolicy	Redemption policy of the Credit KnownCreditRedemptionPolicy can be used interchangeably with CreditRedemptionPolicy, this enum contains the known values that the service supports. Known values supported by the service NotApplicable: Redemption policy is not applicable for this credit AutoRedeem: Credit is automatically redeemed ManualRedeem: Credit is manually redeemed
CreditStatus	Status of the credit KnownCreditStatus can be used interchangeably with CreditStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown: Credit status is unknown Pending: Credit is pending activation Active: Credit is active and available for use Succeeded: Credit operation succeeded Canceled: Credit has been cancelled Failed: Credit operation failed Expired: Credit has expired Exhausted: Credit has been fully consumed NotStarted: Credit application has not started yet
DiscountAppliedScopeType	List of applied scopes supported for discounts. KnownDiscountAppliedScopeType can be used interchangeably with DiscountAppliedScopeType, this enum contains the known values that the service supports. Known values supported by the service BillingAccount BillingProfile Customer
DiscountCombinationRule	The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. KnownDiscountCombinationRule can be used interchangeably with DiscountCombinationRule, this enum contains the known values that the service supports. Known values supported by the service BestOf Stackable
DiscountEntityType	This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. KnownDiscountEntityType can be used interchangeably with DiscountEntityType, this enum contains the known values that the service supports. Known values supported by the service Primary Affiliate
DiscountPropertiesUnion	Alias for DiscountPropertiesUnion
DiscountProvisioningState	Provisioning states of Discount. KnownDiscountProvisioningState can be used interchangeably with DiscountProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Pending Succeeded Canceled Failed
DiscountRuleType	The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling. KnownDiscountRuleType can be used interchangeably with DiscountRuleType, this enum contains the known values that the service supports. Known values supported by the service FixedPriceLock FixedListPrice PriceCeiling
DiscountStatus	Represents the current status of the discount. KnownDiscountStatus can be used interchangeably with DiscountStatus, this enum contains the known values that the service supports. Known values supported by the service Active Pending Failed Canceled Expired
DiscountType	Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. KnownDiscountType can be used interchangeably with DiscountType, this enum contains the known values that the service supports. Known values supported by the service ProductFamily Product Sku CustomPrice CustomPriceMultiCurrency
DiscountTypeCustomPriceUnion	Alias for DiscountTypeCustomPriceUnion
DiscountTypePropertiesUnion	Alias for DiscountTypePropertiesUnion
EnablementMode	Represents the enablement status of a feature or settings. KnownEnablementMode can be used interchangeably with EnablementMode, this enum contains the known values that the service supports. Known values supported by the service Unknown Enabled Disabled
FreeServicesStatus	Status of the free services KnownFreeServicesStatus can be used interchangeably with FreeServicesStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown: Free services status is unknown Pending: Free services are pending activation Active: Free services are active Canceled: Free services have been canceled Completed: Free services have been fully consumed or completed
InstanceFlexibility	Turning this on will apply the reservation discount to other VMs in the same VM size group. 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
MaccEntityType	Represents type of the object being operated on. Possible values are primary or contributor. KnownMaccEntityType can be used interchangeably with MaccEntityType, this enum contains the known values that the service supports. Known values supported by the service Primary Contributor
MaccMilestoneStatus	Represents the current status of the Milestone. KnownMaccMilestoneStatus can be used interchangeably with MaccMilestoneStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown Scheduled Active Pending Failed Completed Canceled Removed PendingSettlement ShortfallCharged ShortfallWaived
MaccStatus	Represents the current status of the MACC. KnownMaccStatus can be used interchangeably with MaccStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown Scheduled Active Pending Failed Canceled Completed Stopped PendingSettlement ShortfallCharged ShortfallWaived
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
MilestoneStatus	Current status of the milestone KnownMilestoneStatus can be used interchangeably with MilestoneStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown Scheduled Active Pending Failed Completed Canceled Removed PendingSettlement Missed
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.
PaymentStatus	Describes whether the payment is completed, failed, cancelled or scheduled in the future. 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
PricingPolicy	Supported values: Protected, Locked KnownPricingPolicy can be used interchangeably with PricingPolicy, this enum contains the known values that the service supports. Known values supported by the service Protected Locked
ProvisioningState	Provisioning state 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
ReservedResourceType	The type of the resource that is being reserved. 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
ServiceManagedIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownServiceManagedIdentityType can be used interchangeably with ServiceManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned,UserAssigned
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Term	Represent benefit term in ISO 8601 format. KnownTerm can be used interchangeably with Term, this enum contains the known values that the service supports. Known values supported by the service P1M P1Y P3Y P5Y

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.
KnownAppliedScopeType	Type of the Applied Scope.
KnownApplyDiscountOn	The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values.
KnownBenefitType	Represents benefit model type for validation.
KnownBillingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
KnownCommitmentGrain	Grain.
KnownConditionalCreditEntityType	Type of conditional credit entity
KnownConditionalCreditStatus	The status of the conditional credit
KnownConditionalCreditsProvisioningState	The provisioning state of the resource
KnownCreatedByType	The kind of entity that created the resource.
KnownCreditExpirationPolicy	Expiration policy of the Credit
KnownCreditRedemptionPolicy	Redemption policy of the Credit
KnownCreditStatus	Status of the credit
KnownDiscountAppliedScopeType	List of applied scopes supported for discounts.
KnownDiscountCombinationRule	The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf.
KnownDiscountEntityType	This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values.
KnownDiscountProvisioningState	Provisioning states of Discount.
KnownDiscountRuleType	The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling.
KnownDiscountStatus	Represents the current status of the discount.
KnownDiscountType	Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency.
KnownEnablementMode	Represents the enablement status of a feature or settings.
KnownFreeServicesStatus	Status of the free services
KnownInstanceFlexibility	Turning this on will apply the reservation discount to other VMs in the same VM size group.
KnownMaccEntityType	Represents type of the object being operated on. Possible values are primary or contributor.
KnownMaccMilestoneStatus	Represents the current status of the Milestone.
KnownMaccStatus	Represents the current status of the MACC.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMilestoneStatus	Current status of the milestone
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPaymentStatus	Describes whether the payment is completed, failed, cancelled or scheduled in the future.
KnownPricingPolicy	Supported values: Protected, Locked
KnownProvisioningState	Provisioning state
KnownReservedResourceType	The type of the resource that is being reserved.
KnownServiceManagedIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownTerm	Represent benefit term in ISO 8601 format.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(BillingBenefitsRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

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

restorePoller<TResponse, TResult>(BillingBenefitsRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: BillingBenefitsRP, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

BillingBenefitsRP

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor