@azure/arm-commerce 4.0.0-alpha.20250620.1 → 4.0.0-alpha.20250718.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,181 +1,181 @@
|
|
|
1
|
-
## API Report File for "@azure/arm-commerce"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import * as coreAuth from '@azure/core-auth';
|
|
8
|
-
import * as coreClient from '@azure/core-client';
|
|
9
|
-
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
10
|
-
|
|
11
|
-
// @public
|
|
12
|
-
export type AggregationGranularity = "Daily" | "Hourly";
|
|
13
|
-
|
|
14
|
-
// @public
|
|
15
|
-
export interface ErrorResponse {
|
|
16
|
-
code?: string;
|
|
17
|
-
message?: string;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
// @public
|
|
21
|
-
export function getContinuationToken(page: unknown): string | undefined;
|
|
22
|
-
|
|
23
|
-
// @public
|
|
24
|
-
export interface InfoField {
|
|
25
|
-
project?: string;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
// @public
|
|
29
|
-
export interface MeterInfo {
|
|
30
|
-
effectiveDate?: Date;
|
|
31
|
-
includedQuantity?: number;
|
|
32
|
-
meterCategory?: string;
|
|
33
|
-
meterId?: string;
|
|
34
|
-
meterName?: string;
|
|
35
|
-
meterRates?: {
|
|
36
|
-
[propertyName: string]: number;
|
|
37
|
-
};
|
|
38
|
-
meterRegion?: string;
|
|
39
|
-
meterSubCategory?: string;
|
|
40
|
-
meterTags?: string[];
|
|
41
|
-
unit?: string;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
// @public
|
|
45
|
-
export interface MonetaryCommitment extends OfferTermInfoAutoGenerated {
|
|
46
|
-
excludedMeterIds?: string[];
|
|
47
|
-
name: "Monetary Commitment";
|
|
48
|
-
tieredDiscount?: {
|
|
49
|
-
[propertyName: string]: number;
|
|
50
|
-
};
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
// @public
|
|
54
|
-
export interface MonetaryCredit extends OfferTermInfoAutoGenerated {
|
|
55
|
-
credit?: number;
|
|
56
|
-
excludedMeterIds?: string[];
|
|
57
|
-
name: "Monetary Credit";
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
// @public
|
|
61
|
-
export type OfferTermInfo = "Recurring Charge" | "Monetary Commitment" | "Monetary Credit";
|
|
62
|
-
|
|
63
|
-
// @public
|
|
64
|
-
export interface OfferTermInfoAutoGenerated {
|
|
65
|
-
effectiveDate?: Date;
|
|
66
|
-
name: "Monetary Credit" | "Monetary Commitment" | "Recurring Charge";
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
// @public (undocumented)
|
|
70
|
-
export type OfferTermInfoAutoGeneratedUnion = OfferTermInfoAutoGenerated | MonetaryCredit | MonetaryCommitment | RecurringCharge;
|
|
71
|
-
|
|
72
|
-
// @public
|
|
73
|
-
export interface RateCard {
|
|
74
|
-
get(filter: string, options?: RateCardGetOptionalParams): Promise<RateCardGetResponse>;
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
// @public
|
|
78
|
-
export interface RateCardGetOptionalParams extends coreClient.OperationOptions {
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
// @public
|
|
82
|
-
export type RateCardGetResponse = ResourceRateCardInfo;
|
|
83
|
-
|
|
84
|
-
// @public
|
|
85
|
-
export interface RateCardQueryParameters {
|
|
86
|
-
currency: string;
|
|
87
|
-
locale: string;
|
|
88
|
-
offerDurableId: string;
|
|
89
|
-
regionInfo: string;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
// @public
|
|
93
|
-
export interface RecurringCharge extends OfferTermInfoAutoGenerated {
|
|
94
|
-
name: "Recurring Charge";
|
|
95
|
-
recurringCharge?: number;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
// @public
|
|
99
|
-
export interface ResourceRateCardInfo {
|
|
100
|
-
currency?: string;
|
|
101
|
-
isTaxIncluded?: boolean;
|
|
102
|
-
locale?: string;
|
|
103
|
-
meters?: MeterInfo[];
|
|
104
|
-
offerTerms?: OfferTermInfoAutoGeneratedUnion[];
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
// @public
|
|
108
|
-
export interface UsageAggregates {
|
|
109
|
-
list(reportedStartTime: Date, reportedEndTime: Date, options?: UsageAggregatesListOptionalParams): PagedAsyncIterableIterator<UsageAggregation>;
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
// @public
|
|
113
|
-
export interface UsageAggregatesListNextOptionalParams extends coreClient.OperationOptions {
|
|
114
|
-
aggregationGranularity?: AggregationGranularity;
|
|
115
|
-
continuationToken?: string;
|
|
116
|
-
showDetails?: boolean;
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
// @public
|
|
120
|
-
export type UsageAggregatesListNextResponse = UsageAggregationListResult;
|
|
121
|
-
|
|
122
|
-
// @public
|
|
123
|
-
export interface UsageAggregatesListOptionalParams extends coreClient.OperationOptions {
|
|
124
|
-
aggregationGranularity?: AggregationGranularity;
|
|
125
|
-
continuationToken?: string;
|
|
126
|
-
showDetails?: boolean;
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
// @public
|
|
130
|
-
export type UsageAggregatesListResponse = UsageAggregationListResult;
|
|
131
|
-
|
|
132
|
-
// @public
|
|
133
|
-
export interface UsageAggregation {
|
|
134
|
-
id?: string;
|
|
135
|
-
infoFields?: InfoField;
|
|
136
|
-
instanceData?: string;
|
|
137
|
-
meterCategory?: string;
|
|
138
|
-
meterId?: string;
|
|
139
|
-
meterName?: string;
|
|
140
|
-
meterRegion?: string;
|
|
141
|
-
meterSubCategory?: string;
|
|
142
|
-
name?: string;
|
|
143
|
-
quantity?: number;
|
|
144
|
-
subscriptionId?: string;
|
|
145
|
-
type?: string;
|
|
146
|
-
unit?: string;
|
|
147
|
-
usageEndTime?: Date;
|
|
148
|
-
usageStartTime?: Date;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
// @public
|
|
152
|
-
export interface UsageAggregationListResult {
|
|
153
|
-
nextLink?: string;
|
|
154
|
-
value?: UsageAggregation[];
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
// @public (undocumented)
|
|
158
|
-
export class UsageManagementClient extends coreClient.ServiceClient {
|
|
159
|
-
// (undocumented)
|
|
160
|
-
$host: string;
|
|
161
|
-
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: UsageManagementClientOptionalParams);
|
|
162
|
-
// (undocumented)
|
|
163
|
-
apiVersion: string;
|
|
164
|
-
// (undocumented)
|
|
165
|
-
rateCard: RateCard;
|
|
166
|
-
// (undocumented)
|
|
167
|
-
subscriptionId: string;
|
|
168
|
-
// (undocumented)
|
|
169
|
-
usageAggregates: UsageAggregates;
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
// @public
|
|
173
|
-
export interface UsageManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
174
|
-
$host?: string;
|
|
175
|
-
apiVersion?: string;
|
|
176
|
-
endpoint?: string;
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
// (No @packageDocumentation comment for this package)
|
|
180
|
-
|
|
181
|
-
```
|
|
1
|
+
## API Report File for "@azure/arm-commerce"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import * as coreAuth from '@azure/core-auth';
|
|
8
|
+
import * as coreClient from '@azure/core-client';
|
|
9
|
+
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
10
|
+
|
|
11
|
+
// @public
|
|
12
|
+
export type AggregationGranularity = "Daily" | "Hourly";
|
|
13
|
+
|
|
14
|
+
// @public
|
|
15
|
+
export interface ErrorResponse {
|
|
16
|
+
code?: string;
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// @public
|
|
21
|
+
export function getContinuationToken(page: unknown): string | undefined;
|
|
22
|
+
|
|
23
|
+
// @public
|
|
24
|
+
export interface InfoField {
|
|
25
|
+
project?: string;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
// @public
|
|
29
|
+
export interface MeterInfo {
|
|
30
|
+
effectiveDate?: Date;
|
|
31
|
+
includedQuantity?: number;
|
|
32
|
+
meterCategory?: string;
|
|
33
|
+
meterId?: string;
|
|
34
|
+
meterName?: string;
|
|
35
|
+
meterRates?: {
|
|
36
|
+
[propertyName: string]: number;
|
|
37
|
+
};
|
|
38
|
+
meterRegion?: string;
|
|
39
|
+
meterSubCategory?: string;
|
|
40
|
+
meterTags?: string[];
|
|
41
|
+
unit?: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// @public
|
|
45
|
+
export interface MonetaryCommitment extends OfferTermInfoAutoGenerated {
|
|
46
|
+
excludedMeterIds?: string[];
|
|
47
|
+
name: "Monetary Commitment";
|
|
48
|
+
tieredDiscount?: {
|
|
49
|
+
[propertyName: string]: number;
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// @public
|
|
54
|
+
export interface MonetaryCredit extends OfferTermInfoAutoGenerated {
|
|
55
|
+
credit?: number;
|
|
56
|
+
excludedMeterIds?: string[];
|
|
57
|
+
name: "Monetary Credit";
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// @public
|
|
61
|
+
export type OfferTermInfo = "Recurring Charge" | "Monetary Commitment" | "Monetary Credit";
|
|
62
|
+
|
|
63
|
+
// @public
|
|
64
|
+
export interface OfferTermInfoAutoGenerated {
|
|
65
|
+
effectiveDate?: Date;
|
|
66
|
+
name: "Monetary Credit" | "Monetary Commitment" | "Recurring Charge";
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// @public (undocumented)
|
|
70
|
+
export type OfferTermInfoAutoGeneratedUnion = OfferTermInfoAutoGenerated | MonetaryCredit | MonetaryCommitment | RecurringCharge;
|
|
71
|
+
|
|
72
|
+
// @public
|
|
73
|
+
export interface RateCard {
|
|
74
|
+
get(filter: string, options?: RateCardGetOptionalParams): Promise<RateCardGetResponse>;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
// @public
|
|
78
|
+
export interface RateCardGetOptionalParams extends coreClient.OperationOptions {
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
// @public
|
|
82
|
+
export type RateCardGetResponse = ResourceRateCardInfo;
|
|
83
|
+
|
|
84
|
+
// @public
|
|
85
|
+
export interface RateCardQueryParameters {
|
|
86
|
+
currency: string;
|
|
87
|
+
locale: string;
|
|
88
|
+
offerDurableId: string;
|
|
89
|
+
regionInfo: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
// @public
|
|
93
|
+
export interface RecurringCharge extends OfferTermInfoAutoGenerated {
|
|
94
|
+
name: "Recurring Charge";
|
|
95
|
+
recurringCharge?: number;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// @public
|
|
99
|
+
export interface ResourceRateCardInfo {
|
|
100
|
+
currency?: string;
|
|
101
|
+
isTaxIncluded?: boolean;
|
|
102
|
+
locale?: string;
|
|
103
|
+
meters?: MeterInfo[];
|
|
104
|
+
offerTerms?: OfferTermInfoAutoGeneratedUnion[];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// @public
|
|
108
|
+
export interface UsageAggregates {
|
|
109
|
+
list(reportedStartTime: Date, reportedEndTime: Date, options?: UsageAggregatesListOptionalParams): PagedAsyncIterableIterator<UsageAggregation>;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
// @public
|
|
113
|
+
export interface UsageAggregatesListNextOptionalParams extends coreClient.OperationOptions {
|
|
114
|
+
aggregationGranularity?: AggregationGranularity;
|
|
115
|
+
continuationToken?: string;
|
|
116
|
+
showDetails?: boolean;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// @public
|
|
120
|
+
export type UsageAggregatesListNextResponse = UsageAggregationListResult;
|
|
121
|
+
|
|
122
|
+
// @public
|
|
123
|
+
export interface UsageAggregatesListOptionalParams extends coreClient.OperationOptions {
|
|
124
|
+
aggregationGranularity?: AggregationGranularity;
|
|
125
|
+
continuationToken?: string;
|
|
126
|
+
showDetails?: boolean;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// @public
|
|
130
|
+
export type UsageAggregatesListResponse = UsageAggregationListResult;
|
|
131
|
+
|
|
132
|
+
// @public
|
|
133
|
+
export interface UsageAggregation {
|
|
134
|
+
id?: string;
|
|
135
|
+
infoFields?: InfoField;
|
|
136
|
+
instanceData?: string;
|
|
137
|
+
meterCategory?: string;
|
|
138
|
+
meterId?: string;
|
|
139
|
+
meterName?: string;
|
|
140
|
+
meterRegion?: string;
|
|
141
|
+
meterSubCategory?: string;
|
|
142
|
+
name?: string;
|
|
143
|
+
quantity?: number;
|
|
144
|
+
subscriptionId?: string;
|
|
145
|
+
type?: string;
|
|
146
|
+
unit?: string;
|
|
147
|
+
usageEndTime?: Date;
|
|
148
|
+
usageStartTime?: Date;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
// @public
|
|
152
|
+
export interface UsageAggregationListResult {
|
|
153
|
+
nextLink?: string;
|
|
154
|
+
value?: UsageAggregation[];
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
// @public (undocumented)
|
|
158
|
+
export class UsageManagementClient extends coreClient.ServiceClient {
|
|
159
|
+
// (undocumented)
|
|
160
|
+
$host: string;
|
|
161
|
+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: UsageManagementClientOptionalParams);
|
|
162
|
+
// (undocumented)
|
|
163
|
+
apiVersion: string;
|
|
164
|
+
// (undocumented)
|
|
165
|
+
rateCard: RateCard;
|
|
166
|
+
// (undocumented)
|
|
167
|
+
subscriptionId: string;
|
|
168
|
+
// (undocumented)
|
|
169
|
+
usageAggregates: UsageAggregates;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// @public
|
|
173
|
+
export interface UsageManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
174
|
+
$host?: string;
|
|
175
|
+
apiVersion?: string;
|
|
176
|
+
endpoint?: string;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
// (No @packageDocumentation comment for this package)
|
|
180
|
+
|
|
181
|
+
```
|