Skip to content

[BillingBenefits] Updating some commands #20691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions src/BillingBenefits/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ resourcegroup-append: true
nested-object-to-string: true

directive:
### No inline
- no-inline:
- RenewProperties

### Rename Cmdlet names
- where:
verb: Get
Expand Down Expand Up @@ -96,20 +100,18 @@ directive:
- PurchaseDateTime
- Term
- UserFriendlyAppliedScopeType
- AppliedScopePropertiesDisplayName
- SkuName1
- Amount
- CurrencyCode
- AppliedScopePropertyDisplayName
- SkuName
- CommitmentAmount
- CommitmentCurrencyCode
labels:
DisplayName: Name
DisplayProvisioningState: Status
ExpiryDateTime: ExpiryDate
PurchaseDateTime: PurchaseDate
UserFriendlyAppliedScopeType: Scope
SkuName1: ProductName
Amount: CommitmentAmount
CurrencyCode: CommitmentCurrency
AppliedScopePropertiesDisplayName: AppliedScopeDisplayName
SkuName: ProductName
AppliedScopePropertyDisplayName: AppliedScopeDisplayName
- where:
model-name: SavingsPlanOrderModel
set:
Expand Down
4 changes: 2 additions & 2 deletions src/BillingBenefits/docs/Get-AzBillingBenefitsSavingsPlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d
```

```output
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrency
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode
---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------
PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y Shared Compute_Savings_Plan 0.001 USD
```
Expand All @@ -53,7 +53,7 @@ Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d -
```

```output
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrency
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode
---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------
PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y Shared Compute_Savings_Plan 0.001 USD
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Get-AzBillingBenefitsSavingsPlanList
```

```output
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrency
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode
---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------
Compute_SavingsPlan_11-30-2022_15-19 Succeeded 11/30/2023 11:22:53 PM 11/30/2022 11:19:31 PM P1Y Shared Compute_Savings_Plan 0.001 USD
PSTesth1234 Succeeded 11/30/2025 12:36:25 AM 11/30/2022 12:34:31 AM P3Y Shared Compute_Savings_Plan 0.001 USD
Expand All @@ -47,7 +47,7 @@ Get-AzBillingBenefitsSavingsPlanList -Filter "properties/userFriendlyAppliedScop
```

```output
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrency
Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode
---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------
Compute_SavingsPlan_11-30-2022_15-19 Succeeded 11/30/2023 11:22:53 PM 11/30/2022 11:19:31 PM P1Y Shared Compute_Savings_Plan 0.001 USD
PSTesth1234 Succeeded 11/30/2025 12:36:25 AM 11/30/2022 12:34:31 AM P3Y Shared Compute_Savings_Plan 0.001 USD
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,55 +214,59 @@ To create the parameters described below, construct a hash table containing the


`BENEFIT <ISavingsPlanUpdateRequestProperties[]>`: .
- `[AppliedScopePropertiesDisplayName <String>]`: Display name
- `[AppliedScopePropertiesManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertiesResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertiesSubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertiesTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopePropertyDisplayName <String>]`: Display name
- `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
- `[BillingScopeId <String>]`: Subscription that will be charged for purchasing the benefit
- `[CommitmentAmount <Double?>]`:
- `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record.
- `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain.
- `[DisplayName <String>]`: Display name
- `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesDisplayName <String>]`: Display name
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesSubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesTenantId <String>]`: Tenant ID where the benefit is applied.
- `[RenewPropertiesPurchasePropertiesAppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[RenewPropertiesPurchasePropertiesDisplayName <String>]`: Friendly name of the savings plan
- `[RenewPropertiesPurchasePropertiesRenew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[SkuName <String>]`: Name of the SKU to be applied
- `[Term <Term?>]`: Represent benefit term in ISO 8601 format.
- `[RenewProperty <IRenewProperties>]`:
- `[PurchaseProperty <IPurchaseRequest>]`:
- `[AppliedScopePropertyDisplayName <String>]`: Display name
- `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
- `[BillingScopeId <String>]`: Subscription that will be charged for purchasing the benefit
- `[CommitmentAmount <Double?>]`:
- `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record.
- `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain.
- `[DisplayName <String>]`: Friendly name of the savings plan
- `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[SkuName <String>]`: Name of the SKU to be applied
- `[Term <Term?>]`: Represent benefit term in ISO 8601 format.

`BODY <ISavingsPlanUpdateValidateRequest>`: .
- `[Benefit <ISavingsPlanUpdateRequestProperties[]>]`:
- `[AppliedScopePropertiesDisplayName <String>]`: Display name
- `[AppliedScopePropertiesManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertiesResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertiesSubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertiesTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopePropertyDisplayName <String>]`: Display name
- `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
- `[BillingScopeId <String>]`: Subscription that will be charged for purchasing the benefit
- `[CommitmentAmount <Double?>]`:
- `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record.
- `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain.
- `[DisplayName <String>]`: Display name
- `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesDisplayName <String>]`: Display name
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesSubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[RenewPropertiesPurchasePropertiesAppliedScopePropertiesTenantId <String>]`: Tenant ID where the benefit is applied.
- `[RenewPropertiesPurchasePropertiesAppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[RenewPropertiesPurchasePropertiesDisplayName <String>]`: Friendly name of the savings plan
- `[RenewPropertiesPurchasePropertiesRenew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[SkuName <String>]`: Name of the SKU to be applied
- `[Term <Term?>]`: Represent benefit term in ISO 8601 format.
- `[RenewProperty <IRenewProperties>]`:
- `[PurchaseProperty <IPurchaseRequest>]`:
- `[AppliedScopePropertyDisplayName <String>]`: Display name
- `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied.
- `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group.
- `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
- `[BillingScopeId <String>]`: Subscription that will be charged for purchasing the benefit
- `[CommitmentAmount <Double?>]`:
- `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record.
- `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain.
- `[DisplayName <String>]`: Friendly name of the savings plan
- `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new benefit on the expiration date time.
- `[SkuName <String>]`: Name of the SKU to be applied
- `[Term <Term?>]`: Represent benefit term in ISO 8601 format.

`INPUTOBJECT <IBillingBenefitsIdentity>`: Identity Parameter
- `[Id <String>]`: Resource identity path
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ New-AzBillingBenefitsReservationOrderAlias -Name "PSRITest1" -AppliedScopeType "
```output
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
PSRITest1 PSRITest1 Standard_B1ls westus P1Y P1M VirtualMachines /providers/Micro... Created /subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47 Shared
```

Create a reservation order alias.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -454,15 +454,15 @@ To create the parameters described below, construct a hash table containing the
- `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription.
- `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the benefit is applied.
- `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope.
- `[AzureAsyncOperation <String>]`:
- `[AzureAsyncOperation <String>]`:
- `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
- `[BillingScopeId <String>]`: Subscription that will be charged for purchasing the benefit
- `[CommitmentAmount <Double?>]`:
- `[CommitmentAmount <Double?>]`:
- `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record.
- `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain.
- `[DisplayName <String>]`: Display name
- `[Kind <String>]`: Resource provider kind
- `[RetryAfter <Int32?>]`:
- `[RetryAfter <Int32?>]`:
- `[SkuName <String>]`: Name of the SKU to be applied
- `[Term <Term?>]`: Represent benefit term in ISO 8601 format.

Expand Down
Loading