Skip to content

[AutoPR @azure/arm-consumption] Update Reservation details description #3674

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

Closed
wants to merge 1 commit into from
Closed
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
35 changes: 27 additions & 8 deletions sdk/consumption/arm-consumption/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,34 @@
# Release History

## 10.0.0 (2023-02-03)

**Features**

## 9.2.1 (Unreleased)

### Features Added

### Breaking Changes

### Bugs Fixed
- Added operation LotsOperations.listByCustomer
- Added Interface LotsListByCustomerNextOptionalParams
- Added Interface LotsListByCustomerOptionalParams
- Added Interface ModernReservationRecommendationProperties
- Added Interface ModernSharedScopeReservationRecommendationProperties
- Added Interface ModernSingleScopeReservationRecommendationProperties
- Added Type Alias LotsListByCustomerNextResponse
- Added Type Alias LotsListByCustomerResponse
- Added Type Alias ModernReservationRecommendationPropertiesUnion
- Interface CreditSummary has a new optional parameter eTagPropertiesETag
- Interface LegacyChargeSummary has a new optional parameter azureMarketplaceCharges
- Interface LegacyUsageDetail has a new optional parameter benefitId
- Interface LegacyUsageDetail has a new optional parameter benefitName
- Interface ModernChargeSummary has a new optional parameter subscriptionId
- Interface ModernReservationRecommendation has a new optional parameter resourceType
- Enum KnownEventType has a new value CreditExpired

### Other Changes
**Breaking Changes**

- Operation ReservationRecommendationDetails.get has a new signature
- Interface BudgetFilter no longer has parameter not
- Interface LegacyChargeSummary no longer has parameter marketplaceCharges
- Parameter scope of interface ModernReservationRecommendation is now required


## 9.2.0 (2023-01-03)

**Features**
Expand Down
10 changes: 5 additions & 5 deletions sdk/consumption/arm-consumption/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "d600759c3516b61a7c353bc8682bccbab85a6f65",
"readme": "specification\\consumption\\resource-manager\\readme.md",
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=F:\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\consumption\\resource-manager\\readme.md --use=@autorest/[email protected].20221215.1 --generate-sample=true",
"commit": "39745f80610224fbda62773e722fa7bf79accd75",
"readme": "specification/consumption/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/consumption/resource-manager/readme.md --use=@autorest/[email protected]",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.5.4",
"use": "@autorest/[email protected].20221215.1"
"release_tool": "@azure-tools/js-sdk-release-tools@2.6.1",
"use": "@autorest/[email protected]"
}
17 changes: 4 additions & 13 deletions sdk/consumption/arm-consumption/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for ConsumptionManagementClient.",
"version": "9.2.1",
"version": "10.0.0",
"engines": {
"node": ">=14.0.0"
},
Expand Down Expand Up @@ -37,7 +37,6 @@
"typescript": "~4.8.0",
"uglify-js": "^3.4.9",
"rimraf": "^3.0.0",
"dotenv": "^16.0.0",
"@azure/identity": "^2.0.1",
"@azure-tools/test-recorder": "^2.0.0",
"@azure-tools/test-credential": "^1.0.0",
Expand All @@ -48,6 +47,7 @@
"@types/node": "^14.0.0",
"@azure/dev-tool": "^1.0.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/consumption/arm-consumption",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down Expand Up @@ -108,14 +108,5 @@
}
]
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/consumption/arm-consumption",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-consumption?view=azure-node-preview"
}
}
"autoPublish": true
}
73 changes: 64 additions & 9 deletions sdk/consumption/arm-consumption/review/arm-consumption.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ export interface BudgetComparisonExpression {
export interface BudgetFilter {
and?: BudgetFilterProperties[];
dimensions?: BudgetComparisonExpression;
not?: BudgetFilterProperties;
tags?: BudgetComparisonExpression;
}

Expand Down Expand Up @@ -292,11 +291,11 @@ export interface CreditsGetOptionalParams extends coreClient.OperationOptions {
export type CreditsGetResponse = CreditSummary;

// @public
export interface CreditSummary extends Resource {
export interface CreditSummary extends ProxyResource {
readonly balanceSummary?: CreditBalanceSummary;
readonly billingCurrency?: string;
readonly creditCurrency?: string;
readonly eTag?: string;
readonly eTagPropertiesETag?: string;
readonly expiredCredit?: Amount;
readonly pendingCreditAdjustments?: Amount;
readonly pendingEligibleCharges?: Amount;
Expand Down Expand Up @@ -479,6 +478,7 @@ export enum KnownDatagrain {

// @public
export enum KnownEventType {
CreditExpired = "CreditExpired",
NewCredit = "NewCredit",
PendingAdjustments = "PendingAdjustments",
PendingCharges = "PendingCharges",
Expand Down Expand Up @@ -576,11 +576,11 @@ export enum KnownUsageDetailsKind {
// @public
export interface LegacyChargeSummary extends ChargeSummary {
readonly azureCharges?: number;
readonly azureMarketplaceCharges?: number;
readonly billingPeriodId?: string;
readonly chargesBilledSeparately?: number;
readonly currency?: string;
kind: "legacy";
readonly marketplaceCharges?: number;
readonly usageEnd?: string;
readonly usageStart?: string;
}
Expand Down Expand Up @@ -647,6 +647,8 @@ export interface LegacyUsageDetail extends UsageDetail {
readonly accountName?: string;
readonly accountOwnerId?: string;
readonly additionalInfo?: string;
readonly benefitId?: string;
readonly benefitName?: string;
readonly billingAccountId?: string;
readonly billingAccountName?: string;
readonly billingCurrency?: string;
Expand Down Expand Up @@ -729,10 +731,26 @@ export interface LotsListByBillingProfileOptionalParams extends coreClient.Opera
// @public
export type LotsListByBillingProfileResponse = Lots;

// @public
export interface LotsListByCustomerNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type LotsListByCustomerNextResponse = Lots;

// @public
export interface LotsListByCustomerOptionalParams extends coreClient.OperationOptions {
filter?: string;
}

// @public
export type LotsListByCustomerResponse = Lots;

// @public
export interface LotsOperations {
listByBillingAccount(billingAccountId: string, options?: LotsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<LotSummary>;
listByBillingProfile(billingAccountId: string, billingProfileId: string, options?: LotsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<LotSummary>;
listByCustomer(billingAccountId: string, customerId: string, options?: LotsListByCustomerOptionalParams): PagedAsyncIterableIterator<LotSummary>;
}

// @public
Expand Down Expand Up @@ -865,6 +883,7 @@ export interface ModernChargeSummary extends ChargeSummary {
readonly isInvoiced?: boolean;
kind: "modern";
readonly marketplaceCharges?: Amount;
readonly subscriptionId?: string;
readonly usageEnd?: string;
readonly usageStart?: string;
}
Expand All @@ -883,13 +902,38 @@ export interface ModernReservationRecommendation extends ReservationRecommendati
readonly normalizedSize?: string;
readonly recommendedQuantity?: number;
readonly recommendedQuantityNormalized?: number;
readonly scope?: string;
readonly resourceType?: string;
scope: string;
readonly skuName?: string;
readonly skuProperties?: SkuProperty[];
readonly term?: string;
readonly totalCostWithReservedInstances?: Amount;
}

// @public
export interface ModernReservationRecommendationProperties {
readonly costWithNoReservedInstances?: Amount;
readonly firstUsageDate?: Date;
readonly instanceFlexibilityGroup?: string;
readonly instanceFlexibilityRatio?: number;
readonly location?: string;
readonly lookBackPeriod?: number;
readonly meterId?: string;
readonly netSavings?: Amount;
readonly normalizedSize?: string;
readonly recommendedQuantity?: number;
readonly recommendedQuantityNormalized?: number;
readonly resourceType?: string;
scope: "Single" | "Shared";
readonly skuName?: string;
readonly skuProperties?: SkuProperty[];
readonly term?: string;
readonly totalCostWithReservedInstances?: Amount;
}

// @public (undocumented)
export type ModernReservationRecommendationPropertiesUnion = ModernReservationRecommendationProperties | ModernSingleScopeReservationRecommendationProperties | ModernSharedScopeReservationRecommendationProperties;

// @public
export interface ModernReservationTransaction extends ReservationTransactionResource {
readonly amount?: number;
Expand Down Expand Up @@ -920,6 +964,17 @@ export interface ModernReservationTransactionsListResult {
readonly value?: ModernReservationTransaction[];
}

// @public
export interface ModernSharedScopeReservationRecommendationProperties extends ModernReservationRecommendationProperties {
scope: "Shared";
}

// @public
export interface ModernSingleScopeReservationRecommendationProperties extends ModernReservationRecommendationProperties {
scope: "Single";
readonly subscriptionId?: string;
}

// @public
export interface ModernUsageDetail extends UsageDetail {
readonly additionalInfo?: string;
Expand Down Expand Up @@ -1144,7 +1199,7 @@ export interface ReservationRecommendation extends Resource, ResourceAttributes

// @public
export interface ReservationRecommendationDetails {
get(scope: string, region: string, term: Term, lookBackPeriod: LookBackPeriod, product: string, options?: ReservationRecommendationDetailsGetOptionalParams): Promise<ReservationRecommendationDetailsGetResponse>;
get(resourceScope: string, scope: Scope, region: string, term: Term, lookBackPeriod: LookBackPeriod, product: string, options?: ReservationRecommendationDetailsGetOptionalParams): Promise<ReservationRecommendationDetailsGetResponse>;
}

// @public
Expand Down Expand Up @@ -1211,7 +1266,7 @@ export type ReservationRecommendationKind = string;

// @public
export interface ReservationRecommendations {
list(scope: string, options?: ReservationRecommendationsListOptionalParams): PagedAsyncIterableIterator<ReservationRecommendationUnion>;
list(resourceScope: string, options?: ReservationRecommendationsListOptionalParams): PagedAsyncIterableIterator<ReservationRecommendationUnion>;
}

// @public
Expand Down Expand Up @@ -1241,7 +1296,7 @@ export type ReservationRecommendationUnion = ReservationRecommendation | LegacyR

// @public
export interface ReservationsDetails {
list(scope: string, options?: ReservationsDetailsListOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
list(resourceScope: string, options?: ReservationsDetailsListOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
listByReservationOrder(reservationOrderId: string, filter: string, options?: ReservationsDetailsListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, filter: string, options?: ReservationsDetailsListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
}
Expand Down Expand Up @@ -1295,7 +1350,7 @@ export type ReservationsDetailsListResponse = ReservationDetailsListResult;

// @public
export interface ReservationsSummaries {
list(scope: string, grain: Datagrain, options?: ReservationsSummariesListOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
list(resourceScope: string, grain: Datagrain, options?: ReservationsSummariesListOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
listByReservationOrder(reservationOrderId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export class ConsumptionManagementClient extends coreClient.ServiceClient {
credential: credentials
};

const packageDetails = `azsdk-js-arm-consumption/9.2.1`;
const packageDetails = `azsdk-js-arm-consumption/10.0.0`;
const userAgentPrefix =
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
Expand Down
Loading