@azure/arm-education 1.0.0-alpha.20250620.1 → 1.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,529 +1,529 @@
|
|
|
1
|
-
## API Report File for "@azure/arm-education"
|
|
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 ActionType = string;
|
|
13
|
-
|
|
14
|
-
// @public
|
|
15
|
-
export interface Amount {
|
|
16
|
-
currency?: string;
|
|
17
|
-
value?: number;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
// @public
|
|
21
|
-
export type CreatedByType = string;
|
|
22
|
-
|
|
23
|
-
// @public (undocumented)
|
|
24
|
-
export class EducationManagementClient extends coreClient.ServiceClient {
|
|
25
|
-
// (undocumented)
|
|
26
|
-
$host: string;
|
|
27
|
-
constructor(credentials: coreAuth.TokenCredential, options?: EducationManagementClientOptionalParams);
|
|
28
|
-
// (undocumented)
|
|
29
|
-
apiVersion: string;
|
|
30
|
-
// (undocumented)
|
|
31
|
-
grants: Grants;
|
|
32
|
-
// (undocumented)
|
|
33
|
-
joinRequests: JoinRequests;
|
|
34
|
-
// (undocumented)
|
|
35
|
-
labs: Labs;
|
|
36
|
-
// (undocumented)
|
|
37
|
-
operations: Operations;
|
|
38
|
-
redeemInvitationCode(parameters: RedeemRequest, options?: RedeemInvitationCodeOptionalParams): Promise<void>;
|
|
39
|
-
// (undocumented)
|
|
40
|
-
studentLabs: StudentLabs;
|
|
41
|
-
// (undocumented)
|
|
42
|
-
students: Students;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
// @public
|
|
46
|
-
export interface EducationManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
47
|
-
$host?: string;
|
|
48
|
-
apiVersion?: string;
|
|
49
|
-
endpoint?: string;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
// @public
|
|
53
|
-
export interface ErrorResponse {
|
|
54
|
-
code?: string;
|
|
55
|
-
message?: string;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
// @public
|
|
59
|
-
export interface ErrorResponseBody {
|
|
60
|
-
error?: ErrorResponse;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
// @public
|
|
64
|
-
export function getContinuationToken(page: unknown): string | undefined;
|
|
65
|
-
|
|
66
|
-
// @public
|
|
67
|
-
export interface GrantDetails extends Resource {
|
|
68
|
-
readonly allocatedBudget?: Amount;
|
|
69
|
-
readonly effectiveDate?: Date;
|
|
70
|
-
readonly expirationDate?: Date;
|
|
71
|
-
readonly offerCap?: Amount;
|
|
72
|
-
readonly offerType?: GrantType;
|
|
73
|
-
readonly status?: GrantStatus;
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
// @public
|
|
77
|
-
export interface GrantListResponse {
|
|
78
|
-
readonly nextLink?: string;
|
|
79
|
-
readonly value?: GrantDetails[];
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
// @public
|
|
83
|
-
export interface Grants {
|
|
84
|
-
get(billingAccountName: string, billingProfileName: string, options?: GrantsGetOptionalParams): Promise<GrantsGetResponse>;
|
|
85
|
-
list(billingAccountName: string, billingProfileName: string, options?: GrantsListOptionalParams): PagedAsyncIterableIterator<GrantDetails>;
|
|
86
|
-
listAll(options?: GrantsListAllOptionalParams): PagedAsyncIterableIterator<GrantDetails>;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
// @public
|
|
90
|
-
export interface GrantsGetOptionalParams extends coreClient.OperationOptions {
|
|
91
|
-
includeAllocatedBudget?: boolean;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
// @public
|
|
95
|
-
export type GrantsGetResponse = GrantDetails;
|
|
96
|
-
|
|
97
|
-
// @public
|
|
98
|
-
export interface GrantsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
// @public
|
|
102
|
-
export type GrantsListAllNextResponse = GrantListResponse;
|
|
103
|
-
|
|
104
|
-
// @public
|
|
105
|
-
export interface GrantsListAllOptionalParams extends coreClient.OperationOptions {
|
|
106
|
-
includeAllocatedBudget?: boolean;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
// @public
|
|
110
|
-
export type GrantsListAllResponse = GrantListResponse;
|
|
111
|
-
|
|
112
|
-
// @public
|
|
113
|
-
export interface GrantsListNextOptionalParams extends coreClient.OperationOptions {
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
// @public
|
|
117
|
-
export type GrantsListNextResponse = GrantListResponse;
|
|
118
|
-
|
|
119
|
-
// @public
|
|
120
|
-
export interface GrantsListOptionalParams extends coreClient.OperationOptions {
|
|
121
|
-
includeAllocatedBudget?: boolean;
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
// @public
|
|
125
|
-
export type GrantsListResponse = GrantListResponse;
|
|
126
|
-
|
|
127
|
-
// @public
|
|
128
|
-
export type GrantStatus = string;
|
|
129
|
-
|
|
130
|
-
// @public
|
|
131
|
-
export type GrantType = string;
|
|
132
|
-
|
|
133
|
-
// @public
|
|
134
|
-
export interface InviteCodeGenerateRequest {
|
|
135
|
-
maxStudentCount?: number;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
// @public
|
|
139
|
-
export interface JoinRequestDetails extends Resource {
|
|
140
|
-
email?: string;
|
|
141
|
-
firstName?: string;
|
|
142
|
-
lastName?: string;
|
|
143
|
-
status?: JoinRequestStatus;
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
// @public
|
|
147
|
-
export interface JoinRequestList {
|
|
148
|
-
readonly nextLink?: string;
|
|
149
|
-
readonly value?: JoinRequestDetails[];
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
// @public
|
|
153
|
-
export interface JoinRequests {
|
|
154
|
-
approve(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsApproveOptionalParams): Promise<void>;
|
|
155
|
-
deny(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsDenyOptionalParams): Promise<void>;
|
|
156
|
-
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsGetOptionalParams): Promise<JoinRequestsGetResponse>;
|
|
157
|
-
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: JoinRequestsListOptionalParams): PagedAsyncIterableIterator<JoinRequestDetails>;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
// @public
|
|
161
|
-
export interface JoinRequestsApproveOptionalParams extends coreClient.OperationOptions {
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
// @public
|
|
165
|
-
export interface JoinRequestsDenyOptionalParams extends coreClient.OperationOptions {
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
// @public
|
|
169
|
-
export interface JoinRequestsGetOptionalParams extends coreClient.OperationOptions {
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
// @public
|
|
173
|
-
export type JoinRequestsGetResponse = JoinRequestDetails;
|
|
174
|
-
|
|
175
|
-
// @public
|
|
176
|
-
export interface JoinRequestsListNextOptionalParams extends coreClient.OperationOptions {
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
// @public
|
|
180
|
-
export type JoinRequestsListNextResponse = JoinRequestList;
|
|
181
|
-
|
|
182
|
-
// @public
|
|
183
|
-
export interface JoinRequestsListOptionalParams extends coreClient.OperationOptions {
|
|
184
|
-
includeDenied?: boolean;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
// @public
|
|
188
|
-
export type JoinRequestsListResponse = JoinRequestList;
|
|
189
|
-
|
|
190
|
-
// @public
|
|
191
|
-
export type JoinRequestStatus = string;
|
|
192
|
-
|
|
193
|
-
// @public
|
|
194
|
-
export enum KnownActionType {
|
|
195
|
-
Internal = "Internal"
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
// @public
|
|
199
|
-
export enum KnownCreatedByType {
|
|
200
|
-
Application = "Application",
|
|
201
|
-
Key = "Key",
|
|
202
|
-
ManagedIdentity = "ManagedIdentity",
|
|
203
|
-
User = "User"
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
// @public
|
|
207
|
-
export enum KnownGrantStatus {
|
|
208
|
-
Active = "Active",
|
|
209
|
-
Inactive = "Inactive"
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
// @public
|
|
213
|
-
export enum KnownGrantType {
|
|
214
|
-
Academic = "Academic",
|
|
215
|
-
Student = "Student"
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
// @public
|
|
219
|
-
export enum KnownJoinRequestStatus {
|
|
220
|
-
Denied = "Denied",
|
|
221
|
-
Pending = "Pending"
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
// @public
|
|
225
|
-
export enum KnownLabStatus {
|
|
226
|
-
Active = "Active",
|
|
227
|
-
Deleted = "Deleted",
|
|
228
|
-
Pending = "Pending"
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
// @public
|
|
232
|
-
export enum KnownOrigin {
|
|
233
|
-
System = "system",
|
|
234
|
-
User = "user",
|
|
235
|
-
UserSystem = "user,system"
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
// @public
|
|
239
|
-
export enum KnownStudentLabStatus {
|
|
240
|
-
Active = "Active",
|
|
241
|
-
Deleted = "Deleted",
|
|
242
|
-
Disabled = "Disabled",
|
|
243
|
-
Expired = "Expired",
|
|
244
|
-
Pending = "Pending"
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
// @public
|
|
248
|
-
export enum KnownStudentRole {
|
|
249
|
-
Admin = "Admin",
|
|
250
|
-
Student = "Student"
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
// @public
|
|
254
|
-
export interface LabDetails extends Resource {
|
|
255
|
-
budgetPerStudent?: Amount;
|
|
256
|
-
currencyPropertiesTotalAllocatedBudgetCurrency?: string;
|
|
257
|
-
currencyPropertiesTotalBudgetCurrency?: string;
|
|
258
|
-
description?: string;
|
|
259
|
-
displayName?: string;
|
|
260
|
-
readonly effectiveDate?: Date;
|
|
261
|
-
expirationDate?: Date;
|
|
262
|
-
readonly invitationCode?: string;
|
|
263
|
-
readonly maxStudentCount?: number;
|
|
264
|
-
readonly status?: LabStatus;
|
|
265
|
-
valuePropertiesTotalAllocatedBudgetValue?: number;
|
|
266
|
-
valuePropertiesTotalBudgetValue?: number;
|
|
267
|
-
}
|
|
268
|
-
|
|
269
|
-
// @public
|
|
270
|
-
export interface LabListResult {
|
|
271
|
-
readonly nextLink?: string;
|
|
272
|
-
readonly value?: LabDetails[];
|
|
273
|
-
}
|
|
274
|
-
|
|
275
|
-
// @public
|
|
276
|
-
export interface Labs {
|
|
277
|
-
createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: LabDetails, options?: LabsCreateOrUpdateOptionalParams): Promise<LabsCreateOrUpdateResponse>;
|
|
278
|
-
delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsDeleteOptionalParams): Promise<void>;
|
|
279
|
-
generateInviteCode(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: InviteCodeGenerateRequest, options?: LabsGenerateInviteCodeOptionalParams): Promise<LabsGenerateInviteCodeResponse>;
|
|
280
|
-
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsGetOptionalParams): Promise<LabsGetResponse>;
|
|
281
|
-
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsListOptionalParams): PagedAsyncIterableIterator<LabDetails>;
|
|
282
|
-
listAll(billingAccountName: string, billingProfileName: string, options?: LabsListAllOptionalParams): PagedAsyncIterableIterator<LabDetails>;
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
// @public
|
|
286
|
-
export interface LabsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
// @public
|
|
290
|
-
export type LabsCreateOrUpdateResponse = LabDetails;
|
|
291
|
-
|
|
292
|
-
// @public
|
|
293
|
-
export interface LabsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
// @public
|
|
297
|
-
export interface LabsGenerateInviteCodeOptionalParams extends coreClient.OperationOptions {
|
|
298
|
-
onlyUpdateStudentCountParameter?: boolean;
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
// @public
|
|
302
|
-
export type LabsGenerateInviteCodeResponse = LabDetails;
|
|
303
|
-
|
|
304
|
-
// @public
|
|
305
|
-
export interface LabsGetOptionalParams extends coreClient.OperationOptions {
|
|
306
|
-
includeBudget?: boolean;
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
// @public
|
|
310
|
-
export type LabsGetResponse = LabDetails;
|
|
311
|
-
|
|
312
|
-
// @public
|
|
313
|
-
export interface LabsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
314
|
-
}
|
|
315
|
-
|
|
316
|
-
// @public
|
|
317
|
-
export type LabsListAllNextResponse = LabListResult;
|
|
318
|
-
|
|
319
|
-
// @public
|
|
320
|
-
export interface LabsListAllOptionalParams extends coreClient.OperationOptions {
|
|
321
|
-
includeBudget?: boolean;
|
|
322
|
-
includeDeleted?: boolean;
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
// @public
|
|
326
|
-
export type LabsListAllResponse = LabListResult;
|
|
327
|
-
|
|
328
|
-
// @public
|
|
329
|
-
export interface LabsListNextOptionalParams extends coreClient.OperationOptions {
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
// @public
|
|
333
|
-
export type LabsListNextResponse = LabListResult;
|
|
334
|
-
|
|
335
|
-
// @public
|
|
336
|
-
export interface LabsListOptionalParams extends coreClient.OperationOptions {
|
|
337
|
-
includeBudget?: boolean;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
// @public
|
|
341
|
-
export type LabsListResponse = LabListResult;
|
|
342
|
-
|
|
343
|
-
// @public
|
|
344
|
-
export type LabStatus = string;
|
|
345
|
-
|
|
346
|
-
// @public
|
|
347
|
-
export interface Operation {
|
|
348
|
-
readonly actionType?: ActionType;
|
|
349
|
-
display?: OperationDisplay;
|
|
350
|
-
readonly isDataAction?: boolean;
|
|
351
|
-
readonly name?: string;
|
|
352
|
-
readonly origin?: Origin;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
// @public
|
|
356
|
-
export interface OperationDisplay {
|
|
357
|
-
readonly description?: string;
|
|
358
|
-
readonly operation?: string;
|
|
359
|
-
readonly provider?: string;
|
|
360
|
-
readonly resource?: string;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
// @public
|
|
364
|
-
export interface OperationListResult {
|
|
365
|
-
readonly nextLink?: string;
|
|
366
|
-
readonly value?: Operation[];
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
// @public
|
|
370
|
-
export interface Operations {
|
|
371
|
-
list(options?: OperationsListOptionalParams): Promise<OperationsListResponse>;
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
// @public
|
|
375
|
-
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
// @public
|
|
379
|
-
export type OperationsListResponse = OperationListResult;
|
|
380
|
-
|
|
381
|
-
// @public
|
|
382
|
-
export type Origin = string;
|
|
383
|
-
|
|
384
|
-
// @public
|
|
385
|
-
export interface RedeemInvitationCodeOptionalParams extends coreClient.OperationOptions {
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
// @public
|
|
389
|
-
export interface RedeemRequest {
|
|
390
|
-
firstName: string;
|
|
391
|
-
lastName: string;
|
|
392
|
-
redeemCode: string;
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
// @public
|
|
396
|
-
export interface Resource {
|
|
397
|
-
readonly id?: string;
|
|
398
|
-
readonly name?: string;
|
|
399
|
-
readonly systemData?: SystemData;
|
|
400
|
-
readonly type?: string;
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
// @public
|
|
404
|
-
export interface StudentDetails extends Resource {
|
|
405
|
-
budget?: Amount;
|
|
406
|
-
readonly effectiveDate?: Date;
|
|
407
|
-
email?: string;
|
|
408
|
-
expirationDate?: Date;
|
|
409
|
-
firstName?: string;
|
|
410
|
-
lastName?: string;
|
|
411
|
-
role?: StudentRole;
|
|
412
|
-
readonly status?: StudentLabStatus;
|
|
413
|
-
subscriptionAlias?: string;
|
|
414
|
-
readonly subscriptionId?: string;
|
|
415
|
-
subscriptionInviteLastSentDate?: Date;
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
// @public
|
|
419
|
-
export interface StudentLabDetails extends Resource {
|
|
420
|
-
readonly budget?: Amount;
|
|
421
|
-
readonly description?: string;
|
|
422
|
-
readonly displayName?: string;
|
|
423
|
-
readonly effectiveDate?: Date;
|
|
424
|
-
readonly expirationDate?: Date;
|
|
425
|
-
readonly labScope?: string;
|
|
426
|
-
readonly role?: StudentRole;
|
|
427
|
-
readonly status?: StudentLabStatus;
|
|
428
|
-
readonly subscriptionId?: string;
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
// @public
|
|
432
|
-
export interface StudentLabListResult {
|
|
433
|
-
readonly nextLink?: string;
|
|
434
|
-
readonly value?: StudentLabDetails[];
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
// @public
|
|
438
|
-
export interface StudentLabs {
|
|
439
|
-
get(studentLabName: string, options?: StudentLabsGetOptionalParams): Promise<StudentLabsGetResponse>;
|
|
440
|
-
listAll(options?: StudentLabsListAllOptionalParams): PagedAsyncIterableIterator<StudentLabDetails>;
|
|
441
|
-
}
|
|
442
|
-
|
|
443
|
-
// @public
|
|
444
|
-
export interface StudentLabsGetOptionalParams extends coreClient.OperationOptions {
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
// @public
|
|
448
|
-
export type StudentLabsGetResponse = StudentLabDetails;
|
|
449
|
-
|
|
450
|
-
// @public
|
|
451
|
-
export interface StudentLabsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
452
|
-
}
|
|
453
|
-
|
|
454
|
-
// @public
|
|
455
|
-
export type StudentLabsListAllNextResponse = StudentLabListResult;
|
|
456
|
-
|
|
457
|
-
// @public
|
|
458
|
-
export interface StudentLabsListAllOptionalParams extends coreClient.OperationOptions {
|
|
459
|
-
}
|
|
460
|
-
|
|
461
|
-
// @public
|
|
462
|
-
export type StudentLabsListAllResponse = StudentLabListResult;
|
|
463
|
-
|
|
464
|
-
// @public
|
|
465
|
-
export type StudentLabStatus = string;
|
|
466
|
-
|
|
467
|
-
// @public
|
|
468
|
-
export interface StudentListResult {
|
|
469
|
-
readonly nextLink?: string;
|
|
470
|
-
readonly value?: StudentDetails[];
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
// @public
|
|
474
|
-
export type StudentRole = string;
|
|
475
|
-
|
|
476
|
-
// @public
|
|
477
|
-
export interface Students {
|
|
478
|
-
createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, parameters: StudentDetails, options?: StudentsCreateOrUpdateOptionalParams): Promise<StudentsCreateOrUpdateResponse>;
|
|
479
|
-
delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams): Promise<void>;
|
|
480
|
-
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsGetOptionalParams): Promise<StudentsGetResponse>;
|
|
481
|
-
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: StudentsListOptionalParams): PagedAsyncIterableIterator<StudentDetails>;
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
// @public
|
|
485
|
-
export interface StudentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
486
|
-
}
|
|
487
|
-
|
|
488
|
-
// @public
|
|
489
|
-
export type StudentsCreateOrUpdateResponse = StudentDetails;
|
|
490
|
-
|
|
491
|
-
// @public
|
|
492
|
-
export interface StudentsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
493
|
-
}
|
|
494
|
-
|
|
495
|
-
// @public
|
|
496
|
-
export interface StudentsGetOptionalParams extends coreClient.OperationOptions {
|
|
497
|
-
}
|
|
498
|
-
|
|
499
|
-
// @public
|
|
500
|
-
export type StudentsGetResponse = StudentDetails;
|
|
501
|
-
|
|
502
|
-
// @public
|
|
503
|
-
export interface StudentsListNextOptionalParams extends coreClient.OperationOptions {
|
|
504
|
-
}
|
|
505
|
-
|
|
506
|
-
// @public
|
|
507
|
-
export type StudentsListNextResponse = StudentListResult;
|
|
508
|
-
|
|
509
|
-
// @public
|
|
510
|
-
export interface StudentsListOptionalParams extends coreClient.OperationOptions {
|
|
511
|
-
includeDeleted?: boolean;
|
|
512
|
-
}
|
|
513
|
-
|
|
514
|
-
// @public
|
|
515
|
-
export type StudentsListResponse = StudentListResult;
|
|
516
|
-
|
|
517
|
-
// @public
|
|
518
|
-
export interface SystemData {
|
|
519
|
-
createdAt?: Date;
|
|
520
|
-
createdBy?: string;
|
|
521
|
-
createdByType?: CreatedByType;
|
|
522
|
-
lastModifiedAt?: Date;
|
|
523
|
-
lastModifiedBy?: string;
|
|
524
|
-
lastModifiedByType?: CreatedByType;
|
|
525
|
-
}
|
|
526
|
-
|
|
527
|
-
// (No @packageDocumentation comment for this package)
|
|
528
|
-
|
|
529
|
-
```
|
|
1
|
+
## API Report File for "@azure/arm-education"
|
|
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 ActionType = string;
|
|
13
|
+
|
|
14
|
+
// @public
|
|
15
|
+
export interface Amount {
|
|
16
|
+
currency?: string;
|
|
17
|
+
value?: number;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// @public
|
|
21
|
+
export type CreatedByType = string;
|
|
22
|
+
|
|
23
|
+
// @public (undocumented)
|
|
24
|
+
export class EducationManagementClient extends coreClient.ServiceClient {
|
|
25
|
+
// (undocumented)
|
|
26
|
+
$host: string;
|
|
27
|
+
constructor(credentials: coreAuth.TokenCredential, options?: EducationManagementClientOptionalParams);
|
|
28
|
+
// (undocumented)
|
|
29
|
+
apiVersion: string;
|
|
30
|
+
// (undocumented)
|
|
31
|
+
grants: Grants;
|
|
32
|
+
// (undocumented)
|
|
33
|
+
joinRequests: JoinRequests;
|
|
34
|
+
// (undocumented)
|
|
35
|
+
labs: Labs;
|
|
36
|
+
// (undocumented)
|
|
37
|
+
operations: Operations;
|
|
38
|
+
redeemInvitationCode(parameters: RedeemRequest, options?: RedeemInvitationCodeOptionalParams): Promise<void>;
|
|
39
|
+
// (undocumented)
|
|
40
|
+
studentLabs: StudentLabs;
|
|
41
|
+
// (undocumented)
|
|
42
|
+
students: Students;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// @public
|
|
46
|
+
export interface EducationManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
47
|
+
$host?: string;
|
|
48
|
+
apiVersion?: string;
|
|
49
|
+
endpoint?: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// @public
|
|
53
|
+
export interface ErrorResponse {
|
|
54
|
+
code?: string;
|
|
55
|
+
message?: string;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
// @public
|
|
59
|
+
export interface ErrorResponseBody {
|
|
60
|
+
error?: ErrorResponse;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// @public
|
|
64
|
+
export function getContinuationToken(page: unknown): string | undefined;
|
|
65
|
+
|
|
66
|
+
// @public
|
|
67
|
+
export interface GrantDetails extends Resource {
|
|
68
|
+
readonly allocatedBudget?: Amount;
|
|
69
|
+
readonly effectiveDate?: Date;
|
|
70
|
+
readonly expirationDate?: Date;
|
|
71
|
+
readonly offerCap?: Amount;
|
|
72
|
+
readonly offerType?: GrantType;
|
|
73
|
+
readonly status?: GrantStatus;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// @public
|
|
77
|
+
export interface GrantListResponse {
|
|
78
|
+
readonly nextLink?: string;
|
|
79
|
+
readonly value?: GrantDetails[];
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// @public
|
|
83
|
+
export interface Grants {
|
|
84
|
+
get(billingAccountName: string, billingProfileName: string, options?: GrantsGetOptionalParams): Promise<GrantsGetResponse>;
|
|
85
|
+
list(billingAccountName: string, billingProfileName: string, options?: GrantsListOptionalParams): PagedAsyncIterableIterator<GrantDetails>;
|
|
86
|
+
listAll(options?: GrantsListAllOptionalParams): PagedAsyncIterableIterator<GrantDetails>;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// @public
|
|
90
|
+
export interface GrantsGetOptionalParams extends coreClient.OperationOptions {
|
|
91
|
+
includeAllocatedBudget?: boolean;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// @public
|
|
95
|
+
export type GrantsGetResponse = GrantDetails;
|
|
96
|
+
|
|
97
|
+
// @public
|
|
98
|
+
export interface GrantsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
// @public
|
|
102
|
+
export type GrantsListAllNextResponse = GrantListResponse;
|
|
103
|
+
|
|
104
|
+
// @public
|
|
105
|
+
export interface GrantsListAllOptionalParams extends coreClient.OperationOptions {
|
|
106
|
+
includeAllocatedBudget?: boolean;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
// @public
|
|
110
|
+
export type GrantsListAllResponse = GrantListResponse;
|
|
111
|
+
|
|
112
|
+
// @public
|
|
113
|
+
export interface GrantsListNextOptionalParams extends coreClient.OperationOptions {
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
// @public
|
|
117
|
+
export type GrantsListNextResponse = GrantListResponse;
|
|
118
|
+
|
|
119
|
+
// @public
|
|
120
|
+
export interface GrantsListOptionalParams extends coreClient.OperationOptions {
|
|
121
|
+
includeAllocatedBudget?: boolean;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
// @public
|
|
125
|
+
export type GrantsListResponse = GrantListResponse;
|
|
126
|
+
|
|
127
|
+
// @public
|
|
128
|
+
export type GrantStatus = string;
|
|
129
|
+
|
|
130
|
+
// @public
|
|
131
|
+
export type GrantType = string;
|
|
132
|
+
|
|
133
|
+
// @public
|
|
134
|
+
export interface InviteCodeGenerateRequest {
|
|
135
|
+
maxStudentCount?: number;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
// @public
|
|
139
|
+
export interface JoinRequestDetails extends Resource {
|
|
140
|
+
email?: string;
|
|
141
|
+
firstName?: string;
|
|
142
|
+
lastName?: string;
|
|
143
|
+
status?: JoinRequestStatus;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
// @public
|
|
147
|
+
export interface JoinRequestList {
|
|
148
|
+
readonly nextLink?: string;
|
|
149
|
+
readonly value?: JoinRequestDetails[];
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// @public
|
|
153
|
+
export interface JoinRequests {
|
|
154
|
+
approve(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsApproveOptionalParams): Promise<void>;
|
|
155
|
+
deny(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsDenyOptionalParams): Promise<void>;
|
|
156
|
+
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, joinRequestName: string, options?: JoinRequestsGetOptionalParams): Promise<JoinRequestsGetResponse>;
|
|
157
|
+
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: JoinRequestsListOptionalParams): PagedAsyncIterableIterator<JoinRequestDetails>;
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
// @public
|
|
161
|
+
export interface JoinRequestsApproveOptionalParams extends coreClient.OperationOptions {
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// @public
|
|
165
|
+
export interface JoinRequestsDenyOptionalParams extends coreClient.OperationOptions {
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
// @public
|
|
169
|
+
export interface JoinRequestsGetOptionalParams extends coreClient.OperationOptions {
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// @public
|
|
173
|
+
export type JoinRequestsGetResponse = JoinRequestDetails;
|
|
174
|
+
|
|
175
|
+
// @public
|
|
176
|
+
export interface JoinRequestsListNextOptionalParams extends coreClient.OperationOptions {
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
// @public
|
|
180
|
+
export type JoinRequestsListNextResponse = JoinRequestList;
|
|
181
|
+
|
|
182
|
+
// @public
|
|
183
|
+
export interface JoinRequestsListOptionalParams extends coreClient.OperationOptions {
|
|
184
|
+
includeDenied?: boolean;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// @public
|
|
188
|
+
export type JoinRequestsListResponse = JoinRequestList;
|
|
189
|
+
|
|
190
|
+
// @public
|
|
191
|
+
export type JoinRequestStatus = string;
|
|
192
|
+
|
|
193
|
+
// @public
|
|
194
|
+
export enum KnownActionType {
|
|
195
|
+
Internal = "Internal"
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
// @public
|
|
199
|
+
export enum KnownCreatedByType {
|
|
200
|
+
Application = "Application",
|
|
201
|
+
Key = "Key",
|
|
202
|
+
ManagedIdentity = "ManagedIdentity",
|
|
203
|
+
User = "User"
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// @public
|
|
207
|
+
export enum KnownGrantStatus {
|
|
208
|
+
Active = "Active",
|
|
209
|
+
Inactive = "Inactive"
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
// @public
|
|
213
|
+
export enum KnownGrantType {
|
|
214
|
+
Academic = "Academic",
|
|
215
|
+
Student = "Student"
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
// @public
|
|
219
|
+
export enum KnownJoinRequestStatus {
|
|
220
|
+
Denied = "Denied",
|
|
221
|
+
Pending = "Pending"
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// @public
|
|
225
|
+
export enum KnownLabStatus {
|
|
226
|
+
Active = "Active",
|
|
227
|
+
Deleted = "Deleted",
|
|
228
|
+
Pending = "Pending"
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
// @public
|
|
232
|
+
export enum KnownOrigin {
|
|
233
|
+
System = "system",
|
|
234
|
+
User = "user",
|
|
235
|
+
UserSystem = "user,system"
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
// @public
|
|
239
|
+
export enum KnownStudentLabStatus {
|
|
240
|
+
Active = "Active",
|
|
241
|
+
Deleted = "Deleted",
|
|
242
|
+
Disabled = "Disabled",
|
|
243
|
+
Expired = "Expired",
|
|
244
|
+
Pending = "Pending"
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
// @public
|
|
248
|
+
export enum KnownStudentRole {
|
|
249
|
+
Admin = "Admin",
|
|
250
|
+
Student = "Student"
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
// @public
|
|
254
|
+
export interface LabDetails extends Resource {
|
|
255
|
+
budgetPerStudent?: Amount;
|
|
256
|
+
currencyPropertiesTotalAllocatedBudgetCurrency?: string;
|
|
257
|
+
currencyPropertiesTotalBudgetCurrency?: string;
|
|
258
|
+
description?: string;
|
|
259
|
+
displayName?: string;
|
|
260
|
+
readonly effectiveDate?: Date;
|
|
261
|
+
expirationDate?: Date;
|
|
262
|
+
readonly invitationCode?: string;
|
|
263
|
+
readonly maxStudentCount?: number;
|
|
264
|
+
readonly status?: LabStatus;
|
|
265
|
+
valuePropertiesTotalAllocatedBudgetValue?: number;
|
|
266
|
+
valuePropertiesTotalBudgetValue?: number;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
// @public
|
|
270
|
+
export interface LabListResult {
|
|
271
|
+
readonly nextLink?: string;
|
|
272
|
+
readonly value?: LabDetails[];
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
// @public
|
|
276
|
+
export interface Labs {
|
|
277
|
+
createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: LabDetails, options?: LabsCreateOrUpdateOptionalParams): Promise<LabsCreateOrUpdateResponse>;
|
|
278
|
+
delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsDeleteOptionalParams): Promise<void>;
|
|
279
|
+
generateInviteCode(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: InviteCodeGenerateRequest, options?: LabsGenerateInviteCodeOptionalParams): Promise<LabsGenerateInviteCodeResponse>;
|
|
280
|
+
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsGetOptionalParams): Promise<LabsGetResponse>;
|
|
281
|
+
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsListOptionalParams): PagedAsyncIterableIterator<LabDetails>;
|
|
282
|
+
listAll(billingAccountName: string, billingProfileName: string, options?: LabsListAllOptionalParams): PagedAsyncIterableIterator<LabDetails>;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
// @public
|
|
286
|
+
export interface LabsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
// @public
|
|
290
|
+
export type LabsCreateOrUpdateResponse = LabDetails;
|
|
291
|
+
|
|
292
|
+
// @public
|
|
293
|
+
export interface LabsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
// @public
|
|
297
|
+
export interface LabsGenerateInviteCodeOptionalParams extends coreClient.OperationOptions {
|
|
298
|
+
onlyUpdateStudentCountParameter?: boolean;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
// @public
|
|
302
|
+
export type LabsGenerateInviteCodeResponse = LabDetails;
|
|
303
|
+
|
|
304
|
+
// @public
|
|
305
|
+
export interface LabsGetOptionalParams extends coreClient.OperationOptions {
|
|
306
|
+
includeBudget?: boolean;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
// @public
|
|
310
|
+
export type LabsGetResponse = LabDetails;
|
|
311
|
+
|
|
312
|
+
// @public
|
|
313
|
+
export interface LabsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
// @public
|
|
317
|
+
export type LabsListAllNextResponse = LabListResult;
|
|
318
|
+
|
|
319
|
+
// @public
|
|
320
|
+
export interface LabsListAllOptionalParams extends coreClient.OperationOptions {
|
|
321
|
+
includeBudget?: boolean;
|
|
322
|
+
includeDeleted?: boolean;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
// @public
|
|
326
|
+
export type LabsListAllResponse = LabListResult;
|
|
327
|
+
|
|
328
|
+
// @public
|
|
329
|
+
export interface LabsListNextOptionalParams extends coreClient.OperationOptions {
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
// @public
|
|
333
|
+
export type LabsListNextResponse = LabListResult;
|
|
334
|
+
|
|
335
|
+
// @public
|
|
336
|
+
export interface LabsListOptionalParams extends coreClient.OperationOptions {
|
|
337
|
+
includeBudget?: boolean;
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
// @public
|
|
341
|
+
export type LabsListResponse = LabListResult;
|
|
342
|
+
|
|
343
|
+
// @public
|
|
344
|
+
export type LabStatus = string;
|
|
345
|
+
|
|
346
|
+
// @public
|
|
347
|
+
export interface Operation {
|
|
348
|
+
readonly actionType?: ActionType;
|
|
349
|
+
display?: OperationDisplay;
|
|
350
|
+
readonly isDataAction?: boolean;
|
|
351
|
+
readonly name?: string;
|
|
352
|
+
readonly origin?: Origin;
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
// @public
|
|
356
|
+
export interface OperationDisplay {
|
|
357
|
+
readonly description?: string;
|
|
358
|
+
readonly operation?: string;
|
|
359
|
+
readonly provider?: string;
|
|
360
|
+
readonly resource?: string;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
// @public
|
|
364
|
+
export interface OperationListResult {
|
|
365
|
+
readonly nextLink?: string;
|
|
366
|
+
readonly value?: Operation[];
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// @public
|
|
370
|
+
export interface Operations {
|
|
371
|
+
list(options?: OperationsListOptionalParams): Promise<OperationsListResponse>;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
// @public
|
|
375
|
+
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
// @public
|
|
379
|
+
export type OperationsListResponse = OperationListResult;
|
|
380
|
+
|
|
381
|
+
// @public
|
|
382
|
+
export type Origin = string;
|
|
383
|
+
|
|
384
|
+
// @public
|
|
385
|
+
export interface RedeemInvitationCodeOptionalParams extends coreClient.OperationOptions {
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
// @public
|
|
389
|
+
export interface RedeemRequest {
|
|
390
|
+
firstName: string;
|
|
391
|
+
lastName: string;
|
|
392
|
+
redeemCode: string;
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
// @public
|
|
396
|
+
export interface Resource {
|
|
397
|
+
readonly id?: string;
|
|
398
|
+
readonly name?: string;
|
|
399
|
+
readonly systemData?: SystemData;
|
|
400
|
+
readonly type?: string;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
// @public
|
|
404
|
+
export interface StudentDetails extends Resource {
|
|
405
|
+
budget?: Amount;
|
|
406
|
+
readonly effectiveDate?: Date;
|
|
407
|
+
email?: string;
|
|
408
|
+
expirationDate?: Date;
|
|
409
|
+
firstName?: string;
|
|
410
|
+
lastName?: string;
|
|
411
|
+
role?: StudentRole;
|
|
412
|
+
readonly status?: StudentLabStatus;
|
|
413
|
+
subscriptionAlias?: string;
|
|
414
|
+
readonly subscriptionId?: string;
|
|
415
|
+
subscriptionInviteLastSentDate?: Date;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
// @public
|
|
419
|
+
export interface StudentLabDetails extends Resource {
|
|
420
|
+
readonly budget?: Amount;
|
|
421
|
+
readonly description?: string;
|
|
422
|
+
readonly displayName?: string;
|
|
423
|
+
readonly effectiveDate?: Date;
|
|
424
|
+
readonly expirationDate?: Date;
|
|
425
|
+
readonly labScope?: string;
|
|
426
|
+
readonly role?: StudentRole;
|
|
427
|
+
readonly status?: StudentLabStatus;
|
|
428
|
+
readonly subscriptionId?: string;
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
// @public
|
|
432
|
+
export interface StudentLabListResult {
|
|
433
|
+
readonly nextLink?: string;
|
|
434
|
+
readonly value?: StudentLabDetails[];
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
// @public
|
|
438
|
+
export interface StudentLabs {
|
|
439
|
+
get(studentLabName: string, options?: StudentLabsGetOptionalParams): Promise<StudentLabsGetResponse>;
|
|
440
|
+
listAll(options?: StudentLabsListAllOptionalParams): PagedAsyncIterableIterator<StudentLabDetails>;
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
// @public
|
|
444
|
+
export interface StudentLabsGetOptionalParams extends coreClient.OperationOptions {
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
// @public
|
|
448
|
+
export type StudentLabsGetResponse = StudentLabDetails;
|
|
449
|
+
|
|
450
|
+
// @public
|
|
451
|
+
export interface StudentLabsListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
// @public
|
|
455
|
+
export type StudentLabsListAllNextResponse = StudentLabListResult;
|
|
456
|
+
|
|
457
|
+
// @public
|
|
458
|
+
export interface StudentLabsListAllOptionalParams extends coreClient.OperationOptions {
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
// @public
|
|
462
|
+
export type StudentLabsListAllResponse = StudentLabListResult;
|
|
463
|
+
|
|
464
|
+
// @public
|
|
465
|
+
export type StudentLabStatus = string;
|
|
466
|
+
|
|
467
|
+
// @public
|
|
468
|
+
export interface StudentListResult {
|
|
469
|
+
readonly nextLink?: string;
|
|
470
|
+
readonly value?: StudentDetails[];
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
// @public
|
|
474
|
+
export type StudentRole = string;
|
|
475
|
+
|
|
476
|
+
// @public
|
|
477
|
+
export interface Students {
|
|
478
|
+
createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, parameters: StudentDetails, options?: StudentsCreateOrUpdateOptionalParams): Promise<StudentsCreateOrUpdateResponse>;
|
|
479
|
+
delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams): Promise<void>;
|
|
480
|
+
get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsGetOptionalParams): Promise<StudentsGetResponse>;
|
|
481
|
+
list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: StudentsListOptionalParams): PagedAsyncIterableIterator<StudentDetails>;
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
// @public
|
|
485
|
+
export interface StudentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
// @public
|
|
489
|
+
export type StudentsCreateOrUpdateResponse = StudentDetails;
|
|
490
|
+
|
|
491
|
+
// @public
|
|
492
|
+
export interface StudentsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
// @public
|
|
496
|
+
export interface StudentsGetOptionalParams extends coreClient.OperationOptions {
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
// @public
|
|
500
|
+
export type StudentsGetResponse = StudentDetails;
|
|
501
|
+
|
|
502
|
+
// @public
|
|
503
|
+
export interface StudentsListNextOptionalParams extends coreClient.OperationOptions {
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
// @public
|
|
507
|
+
export type StudentsListNextResponse = StudentListResult;
|
|
508
|
+
|
|
509
|
+
// @public
|
|
510
|
+
export interface StudentsListOptionalParams extends coreClient.OperationOptions {
|
|
511
|
+
includeDeleted?: boolean;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
// @public
|
|
515
|
+
export type StudentsListResponse = StudentListResult;
|
|
516
|
+
|
|
517
|
+
// @public
|
|
518
|
+
export interface SystemData {
|
|
519
|
+
createdAt?: Date;
|
|
520
|
+
createdBy?: string;
|
|
521
|
+
createdByType?: CreatedByType;
|
|
522
|
+
lastModifiedAt?: Date;
|
|
523
|
+
lastModifiedBy?: string;
|
|
524
|
+
lastModifiedByType?: CreatedByType;
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
// (No @packageDocumentation comment for this package)
|
|
528
|
+
|
|
529
|
+
```
|