New-AzBillingBenefitsReservationOrderAlias

Create a reservation order alias.

Syntax

PowerShell
New-AzBillingBenefitsReservationOrderAlias
   -Name <String>
   [-AppliedScopePropertyDisplayName <String>]
   [-AppliedScopePropertyManagementGroupId <String>]
   [-AppliedScopePropertyResourceGroupId <String>]
   [-AppliedScopePropertySubscriptionId <String>]
   [-AppliedScopePropertyTenantId <String>]
   [-AppliedScopeType <AppliedScopeType>]
   [-BillingPlan <BillingPlan>]
   [-BillingScopeId <String>]
   [-DisplayName <String>]
   [-Location <String>]
   [-Quantity <Int32>]
   [-Renew]
   [-ReservedResourcePropertyInstanceFlexibility <InstanceFlexibility>]
   [-ReservedResourceType <ReservedResourceType>]
   [-ReviewDateTime <DateTime>]
   [-SkuName <String>]
   [-Term <Term>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell
New-AzBillingBenefitsReservationOrderAlias
   -Name <String>
   -Body <IReservationOrderAliasRequest>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell
New-AzBillingBenefitsReservationOrderAlias
   -InputObject <IBillingBenefitsIdentity>
   [-AppliedScopePropertyDisplayName <String>]
   [-AppliedScopePropertyManagementGroupId <String>]
   [-AppliedScopePropertyResourceGroupId <String>]
   [-AppliedScopePropertySubscriptionId <String>]
   [-AppliedScopePropertyTenantId <String>]
   [-AppliedScopeType <AppliedScopeType>]
   [-BillingPlan <BillingPlan>]
   [-BillingScopeId <String>]
   [-DisplayName <String>]
   [-Location <String>]
   [-Quantity <Int32>]
   [-Renew]
   [-ReservedResourcePropertyInstanceFlexibility <InstanceFlexibility>]
   [-ReservedResourceType <ReservedResourceType>]
   [-ReviewDateTime <DateTime>]
   [-SkuName <String>]
   [-Term <Term>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell
New-AzBillingBenefitsReservationOrderAlias
   -InputObject <IBillingBenefitsIdentity>
   -Body <IReservationOrderAliasRequest>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create a reservation order alias.

Examples

Example 1: Create a reservation order alias.

PowerShell
New-AzBillingBenefitsReservationOrderAlias -Name "PSRITest1" -AppliedScopeType "Shared" -BillingPlan "P1M" -BillingScopeId "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47" -SkuName "Standard_B1ls" -Location "westus" -Quantity 1 -ReservedResourceType 'VirtualMachines' -Term "P1Y" -DisplayName "PSRITest1"

Name      DisplayName SkuName       Location Term BillingPlan ReservedResourceType ReservationOrderId   ProvisioningState BillingScopeId                                      AppliedScopeType                 
----      ----------- -------       -------- ---- ----------- -------------------- ------------------   ----------------- --------------                                      --------
PSRITest1 PSRITest1   Standard_B1ls westus   P1Y  P1M         VirtualMachines      /providers/Micro...  Created           /subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47 Shared

Create a reservation order alias.

Parameters

-AppliedScopePropertyDisplayName

Display name

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppliedScopePropertyManagementGroupId

Fully-qualified identifier of the management group where the benefit must be applied.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppliedScopePropertyResourceGroupId

Fully-qualified identifier of the resource group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppliedScopePropertySubscriptionId

Fully-qualified identifier of the subscription.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppliedScopePropertyTenantId

Tenant ID where the benefit is applied.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppliedScopeType

Type of the Applied Scope.

Type:AppliedScopeType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BillingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.

Type:BillingPlan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BillingScopeId

Subscription that will be charged for purchasing the benefit

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Body

Reservation order alias To construct, see NOTES section for BODY properties and create a hash table.

Type:IReservationOrderAliasRequest
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Display name

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IBillingBenefitsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

The Azure Region where the reservation benefits are applied to.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name of the reservation order alias

Type:String
Aliases:ReservationOrderAliasName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Quantity

Total Quantity of the SKUs purchased in the Reservation.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Renew

Setting this to true will automatically purchase a new benefit on the expiration date time.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReservedResourcePropertyInstanceFlexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group.

Type:InstanceFlexibility
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReservedResourceType

The type of the resource that is being reserved.

Type:ReservedResourceType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReviewDateTime

This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuName

Name of the SKU to be applied

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Term

Represent benefit term in ISO 8601 format.

Type:Term
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Outputs