@azure-tools/typespec-azure-resource-manager 0.42.0-dev.11 → 0.42.0-dev.12
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/lib/arm.foundations.tsp +0 -554
- package/lib/arm.tsp +6 -3
- package/lib/common-types/extended-location.tsp +21 -0
- package/lib/common-types/managed-identity.tsp +118 -0
- package/lib/common-types/types.tsp +444 -0
- package/lib/models.tsp +14 -0
- package/package.json +2 -2
- /package/lib/{common-types.tsp → common-types/common-types.tsp} +0 -0
- /package/lib/{customer-managed-keys.tsp → common-types/customer-managed-keys.tsp} +0 -0
- /package/lib/{private-links.tsp → common-types/private-links.tsp} +0 -0
package/lib/arm.foundations.tsp
CHANGED
|
@@ -5,76 +5,6 @@ using Azure.ResourceManager.Private;
|
|
|
5
5
|
|
|
6
6
|
namespace Azure.ResourceManager.Foundations;
|
|
7
7
|
|
|
8
|
-
/**
|
|
9
|
-
* A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
|
|
10
|
-
*/
|
|
11
|
-
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
12
|
-
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
13
|
-
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
14
|
-
@doc("""
|
|
15
|
-
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
|
|
16
|
-
""")
|
|
17
|
-
model OperationListResult is Azure.Core.Page<Operation>;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* Base model that defines common properties for all Azure Resource Manager resources.
|
|
21
|
-
*/
|
|
22
|
-
@doc("Common properties for all Azure Resource Manager resources.")
|
|
23
|
-
model ArmResource extends ArmResourceBase {
|
|
24
|
-
@doc("Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}")
|
|
25
|
-
@visibility("read")
|
|
26
|
-
id: string;
|
|
27
|
-
|
|
28
|
-
@doc("The name of the resource")
|
|
29
|
-
@visibility("read")
|
|
30
|
-
name: string;
|
|
31
|
-
|
|
32
|
-
@doc("The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"")
|
|
33
|
-
@visibility("read")
|
|
34
|
-
type: string;
|
|
35
|
-
|
|
36
|
-
@doc("Azure Resource Manager metadata containing createdBy and modifiedBy information.")
|
|
37
|
-
@visibility("read")
|
|
38
|
-
systemData?: SystemData;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/** Base class used for type definitions */
|
|
42
|
-
model ArmResourceBase {}
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* The base tracked resource.
|
|
46
|
-
*/
|
|
47
|
-
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
48
|
-
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
49
|
-
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
50
|
-
@doc("The resource model definition for an Azure Resource Manager tracked top level resource")
|
|
51
|
-
model TrackedResourceBase extends ArmResource {
|
|
52
|
-
@doc("The geo-location where the resource lives")
|
|
53
|
-
@visibility("read", "create")
|
|
54
|
-
location: string;
|
|
55
|
-
|
|
56
|
-
...ArmTagsProperty;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* The base proxy resource.
|
|
61
|
-
*/
|
|
62
|
-
@doc("The base proxy resource.")
|
|
63
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
64
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
65
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
66
|
-
model ProxyResourceBase extends ArmResource {}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* The base extension resource.
|
|
70
|
-
*/
|
|
71
|
-
// Note that ProxyResource is the base definition for both kinds of resources
|
|
72
|
-
@doc("The base extension resource.")
|
|
73
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
74
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
75
|
-
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
76
|
-
model ExtensionResourceBase extends ArmResource {}
|
|
77
|
-
|
|
78
8
|
/**
|
|
79
9
|
* An internal enum to indicate the resource support for various path types
|
|
80
10
|
*/
|
|
@@ -95,131 +25,6 @@ enum ResourceHome {
|
|
|
95
25
|
Extension,
|
|
96
26
|
}
|
|
97
27
|
|
|
98
|
-
/**
|
|
99
|
-
* The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
100
|
-
*/
|
|
101
|
-
@doc("""
|
|
102
|
-
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
103
|
-
""")
|
|
104
|
-
union Origin {
|
|
105
|
-
@doc("Indicates the operation is initiated by a user.")
|
|
106
|
-
user: "user",
|
|
107
|
-
|
|
108
|
-
@doc("Indicates the operation is initiated by a system.")
|
|
109
|
-
system: "system",
|
|
110
|
-
|
|
111
|
-
@doc("Indicates the operation is initiated by a user or system.")
|
|
112
|
-
`user,system`: "user,system",
|
|
113
|
-
|
|
114
|
-
string,
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
119
|
-
*/
|
|
120
|
-
@doc("""
|
|
121
|
-
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
122
|
-
""")
|
|
123
|
-
union ActionType {
|
|
124
|
-
@doc("Actions are for internal-only APIs.")
|
|
125
|
-
Internal: "Internal",
|
|
126
|
-
|
|
127
|
-
string,
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* Localized display information for and operation.
|
|
132
|
-
*/
|
|
133
|
-
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
134
|
-
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
135
|
-
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
136
|
-
@doc("Localized display information for and operation.")
|
|
137
|
-
model OperationDisplay {
|
|
138
|
-
@doc("""
|
|
139
|
-
The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
|
|
140
|
-
""")
|
|
141
|
-
provider?: string;
|
|
142
|
-
|
|
143
|
-
@doc("""
|
|
144
|
-
The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
|
|
145
|
-
""")
|
|
146
|
-
resource?: string;
|
|
147
|
-
|
|
148
|
-
@doc("""
|
|
149
|
-
The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
|
|
150
|
-
""")
|
|
151
|
-
operation?: string;
|
|
152
|
-
|
|
153
|
-
@doc("The short, localized friendly description of the operation; suitable for tool tips and detailed views.")
|
|
154
|
-
description?: string;
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
* The current status of an async operation.
|
|
159
|
-
*/
|
|
160
|
-
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
161
|
-
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
162
|
-
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
163
|
-
@doc("The current status of an async operation.")
|
|
164
|
-
model OperationStatusResult {
|
|
165
|
-
@doc("Fully qualified ID for the async operation.")
|
|
166
|
-
id?: string;
|
|
167
|
-
|
|
168
|
-
@doc("Name of the async operation.")
|
|
169
|
-
name?: string;
|
|
170
|
-
|
|
171
|
-
@doc("Operation status.")
|
|
172
|
-
status: string;
|
|
173
|
-
|
|
174
|
-
@doc("Percent of the operation that is complete.")
|
|
175
|
-
@minValue(0)
|
|
176
|
-
@maxValue(100)
|
|
177
|
-
percentComplete?: int32;
|
|
178
|
-
|
|
179
|
-
@doc("The start time of the operation.")
|
|
180
|
-
startTime?: utcDateTime;
|
|
181
|
-
|
|
182
|
-
@doc("The end time of the operation.")
|
|
183
|
-
endTime?: utcDateTime;
|
|
184
|
-
|
|
185
|
-
@doc("The operations list.")
|
|
186
|
-
operations: OperationStatusResult[];
|
|
187
|
-
|
|
188
|
-
@doc("If present, details of the operation error.")
|
|
189
|
-
error?: ErrorDetail;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
/**
|
|
193
|
-
* The error detail.
|
|
194
|
-
*/
|
|
195
|
-
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
196
|
-
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
197
|
-
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
198
|
-
@doc("The error detail.")
|
|
199
|
-
model ErrorDetail {
|
|
200
|
-
@doc("The error code.")
|
|
201
|
-
@visibility("read")
|
|
202
|
-
code?: string;
|
|
203
|
-
|
|
204
|
-
@doc("The error message.")
|
|
205
|
-
@visibility("read")
|
|
206
|
-
message?: string;
|
|
207
|
-
|
|
208
|
-
@doc("The error target.")
|
|
209
|
-
@visibility("read")
|
|
210
|
-
target?: string;
|
|
211
|
-
|
|
212
|
-
@extension("x-ms-identifiers", ["message", "target"])
|
|
213
|
-
@doc("The error details.")
|
|
214
|
-
@visibility("read")
|
|
215
|
-
details?: ErrorDetail[];
|
|
216
|
-
|
|
217
|
-
@extension("x-ms-identifiers", ["message", "target"])
|
|
218
|
-
@doc("The error additional info.")
|
|
219
|
-
@visibility("read")
|
|
220
|
-
additionalInfo?: ErrorAdditionalInfo[];
|
|
221
|
-
}
|
|
222
|
-
|
|
223
28
|
/**
|
|
224
29
|
* Base parameters for a resource.
|
|
225
30
|
*
|
|
@@ -283,203 +88,6 @@ model ExtensionBaseParameters is TenantBaseParameters {
|
|
|
283
88
|
...ResourceUriParameter;
|
|
284
89
|
}
|
|
285
90
|
|
|
286
|
-
/**
|
|
287
|
-
* The resource management error additional info.
|
|
288
|
-
*/
|
|
289
|
-
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
290
|
-
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
291
|
-
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
292
|
-
@doc("The resource management error additional info.")
|
|
293
|
-
model ErrorAdditionalInfo {
|
|
294
|
-
@doc("The additional info type.")
|
|
295
|
-
@visibility("read")
|
|
296
|
-
type?: string;
|
|
297
|
-
|
|
298
|
-
@doc("The additional info.")
|
|
299
|
-
@visibility("read")
|
|
300
|
-
info?: {};
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
/**
|
|
304
|
-
* Standard type definition for Azure Resource Manager Tags property.
|
|
305
|
-
*
|
|
306
|
-
* It is included in the TrackedResource template definition.
|
|
307
|
-
*/
|
|
308
|
-
@doc("The Azure Resource Manager Resource tags.")
|
|
309
|
-
model ArmTagsProperty {
|
|
310
|
-
@doc("Resource tags.")
|
|
311
|
-
tags?: Record<string>;
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
/**
|
|
315
|
-
* The kind of entity that created the resource.
|
|
316
|
-
*/
|
|
317
|
-
// NOTE: This is how the extensible enum is named in types.json
|
|
318
|
-
@doc("The kind of entity that created the resource.")
|
|
319
|
-
union createdByType {
|
|
320
|
-
@doc("The entity was created by a user.")
|
|
321
|
-
User: "User",
|
|
322
|
-
|
|
323
|
-
@doc("The entity was created by an application.")
|
|
324
|
-
Application: "Application",
|
|
325
|
-
|
|
326
|
-
@doc("The entity was created by a managed identity.")
|
|
327
|
-
ManagedIdentity: "ManagedIdentity",
|
|
328
|
-
|
|
329
|
-
@doc("The entity was created by a key.")
|
|
330
|
-
Key: "Key",
|
|
331
|
-
|
|
332
|
-
string,
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
/**
|
|
336
|
-
* Metadata pertaining to creation and last modification of the resource.
|
|
337
|
-
*/
|
|
338
|
-
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
339
|
-
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
340
|
-
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
341
|
-
@doc("Metadata pertaining to creation and last modification of the resource.")
|
|
342
|
-
model SystemData {
|
|
343
|
-
@visibility("read")
|
|
344
|
-
@doc("The identity that created the resource.")
|
|
345
|
-
createdBy?: string;
|
|
346
|
-
|
|
347
|
-
@visibility("read")
|
|
348
|
-
@doc("The type of identity that created the resource.")
|
|
349
|
-
createdByType?: createdByType;
|
|
350
|
-
|
|
351
|
-
@visibility("read")
|
|
352
|
-
@doc("The type of identity that created the resource.")
|
|
353
|
-
createdAt?: plainDate;
|
|
354
|
-
|
|
355
|
-
@visibility("read")
|
|
356
|
-
@doc("The identity that last modified the resource.")
|
|
357
|
-
lastModifiedBy?: string;
|
|
358
|
-
|
|
359
|
-
@visibility("read")
|
|
360
|
-
@doc("The type of identity that last modified the resource.")
|
|
361
|
-
lastModifiedByType?: createdByType;
|
|
362
|
-
|
|
363
|
-
@visibility("read")
|
|
364
|
-
@doc("The timestamp of resource last modification (UTC)")
|
|
365
|
-
lastModifiedAt?: plainDate;
|
|
366
|
-
}
|
|
367
|
-
|
|
368
|
-
/**
|
|
369
|
-
* The properties of the managed service identities assigned to this resource.
|
|
370
|
-
*/
|
|
371
|
-
@armCommonDefinition(
|
|
372
|
-
"ManagedServiceIdentity",
|
|
373
|
-
{
|
|
374
|
-
version: Azure.ResourceManager.CommonTypes.Versions.v4,
|
|
375
|
-
isDefault: true,
|
|
376
|
-
},
|
|
377
|
-
"managedidentity.json"
|
|
378
|
-
)
|
|
379
|
-
@armCommonDefinition(
|
|
380
|
-
"ManagedServiceIdentity",
|
|
381
|
-
Azure.ResourceManager.CommonTypes.Versions.v5,
|
|
382
|
-
"managedidentity.json"
|
|
383
|
-
)
|
|
384
|
-
@doc("The properties of the managed service identities assigned to this resource.")
|
|
385
|
-
model ManagedIdentityProperties {
|
|
386
|
-
@doc("The Active Directory tenant id of the principal.")
|
|
387
|
-
@visibility("read")
|
|
388
|
-
tenantId?: string;
|
|
389
|
-
|
|
390
|
-
@doc("The active directory identifier of this principal.")
|
|
391
|
-
@visibility("read")
|
|
392
|
-
principalId?: string;
|
|
393
|
-
|
|
394
|
-
@doc("The type of managed identity assigned to this resource.")
|
|
395
|
-
type: ManagedServiceIdentityType;
|
|
396
|
-
|
|
397
|
-
@doc("The identities assigned to this resource by the user.")
|
|
398
|
-
userAssignedIdentities?: Record<UserAssignedIdentity>;
|
|
399
|
-
}
|
|
400
|
-
|
|
401
|
-
/**
|
|
402
|
-
* The properties of the service-assigned identity associated with this resource.
|
|
403
|
-
*/
|
|
404
|
-
@armCommonDefinition(
|
|
405
|
-
"SystemAssignedServiceIdentity",
|
|
406
|
-
{
|
|
407
|
-
version: Azure.ResourceManager.CommonTypes.Versions.v4,
|
|
408
|
-
isDefault: true,
|
|
409
|
-
},
|
|
410
|
-
"managedidentity.json"
|
|
411
|
-
)
|
|
412
|
-
@armCommonDefinition(
|
|
413
|
-
"SystemAssignedServiceIdentity",
|
|
414
|
-
Azure.ResourceManager.CommonTypes.Versions.v5,
|
|
415
|
-
"managedidentity.json"
|
|
416
|
-
)
|
|
417
|
-
@doc("The properties of the service-assigned identity associated with this resource.")
|
|
418
|
-
model ManagedSystemIdentityProperties {
|
|
419
|
-
@doc("The Active Directory tenant id of the principal.")
|
|
420
|
-
@visibility("read")
|
|
421
|
-
tenantId?: string;
|
|
422
|
-
|
|
423
|
-
@doc("The active directory identifier of this principal.")
|
|
424
|
-
@visibility("read")
|
|
425
|
-
principalId?: string;
|
|
426
|
-
|
|
427
|
-
@doc("The type of managed identity assigned to this resource.")
|
|
428
|
-
type: SystemAssignedServiceIdentityType;
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
/** Alias of ManagedServiceIdentityType for back compatability. Please change to ManagedServiceIdentityType. */
|
|
432
|
-
#deprecated "Please change to ManagedServiceIdentityType."
|
|
433
|
-
alias ManagedIdentityType = ManagedServiceIdentityType;
|
|
434
|
-
/**
|
|
435
|
-
* A managed identity assigned by the user.
|
|
436
|
-
*/
|
|
437
|
-
@doc("A managed identity assigned by the user.")
|
|
438
|
-
model UserAssignedIdentity {
|
|
439
|
-
@doc("The active directory client identifier for this principal.")
|
|
440
|
-
clientId?: string;
|
|
441
|
-
|
|
442
|
-
@doc("The active directory identifier for this principal.")
|
|
443
|
-
principalId?: string;
|
|
444
|
-
}
|
|
445
|
-
|
|
446
|
-
/**
|
|
447
|
-
* The kind of managed identity assigned to this resource.
|
|
448
|
-
*/
|
|
449
|
-
@doc("The kind of managed identity assigned to this resource.")
|
|
450
|
-
union ManagedServiceIdentityType {
|
|
451
|
-
@doc("No managed identity.")
|
|
452
|
-
None: "None",
|
|
453
|
-
|
|
454
|
-
@doc("System assigned managed identity.")
|
|
455
|
-
SystemAssigned: "SystemAssigned",
|
|
456
|
-
|
|
457
|
-
@doc("User assigned managed identity.")
|
|
458
|
-
UserAssigned: "UserAssigned",
|
|
459
|
-
|
|
460
|
-
@doc("System and user assigned managed identity.")
|
|
461
|
-
SystemAndUserAssigned: "SystemAssigned, UserAssigned",
|
|
462
|
-
|
|
463
|
-
string,
|
|
464
|
-
}
|
|
465
|
-
|
|
466
|
-
/** Alias of SystemAssignedServiceIdentityType for back compatability. Please change to SystemAssignedServiceIdentityType. */
|
|
467
|
-
alias ManagedSystemIdentityType = SystemAssignedServiceIdentityType;
|
|
468
|
-
|
|
469
|
-
/**
|
|
470
|
-
* The kind of managemed identity assigned to this resource.
|
|
471
|
-
*/
|
|
472
|
-
@doc("The kind of managemed identity assigned to this resource.")
|
|
473
|
-
union SystemAssignedServiceIdentityType {
|
|
474
|
-
@doc("No managed system identity.")
|
|
475
|
-
None: "None",
|
|
476
|
-
|
|
477
|
-
@doc("System assigned managed system identity.")
|
|
478
|
-
SystemAssigned: "SystemAssigned",
|
|
479
|
-
|
|
480
|
-
string,
|
|
481
|
-
}
|
|
482
|
-
|
|
483
91
|
/**
|
|
484
92
|
* Defines a properties type used to create named resource update models.
|
|
485
93
|
* This type is not used directly, it is referenced by ResourceUpdateModel.
|
|
@@ -558,72 +166,6 @@ model ExtensionScope<Resource extends ArmResource>
|
|
|
558
166
|
*/
|
|
559
167
|
model ResourceGroupScope<Resource extends ArmResource> is ResourceParentParameters<Resource>;
|
|
560
168
|
|
|
561
|
-
/**
|
|
562
|
-
* Details of the resource plan.
|
|
563
|
-
*/
|
|
564
|
-
@doc("Details of the resource plan.")
|
|
565
|
-
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
566
|
-
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
567
|
-
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
568
|
-
model ResourcePlanType {
|
|
569
|
-
@doc("A user defined name of the 3rd Party Artifact that is being procured.")
|
|
570
|
-
name: string;
|
|
571
|
-
|
|
572
|
-
@doc("The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic")
|
|
573
|
-
publisher: string;
|
|
574
|
-
|
|
575
|
-
@doc("The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ")
|
|
576
|
-
product: string;
|
|
577
|
-
|
|
578
|
-
@doc("A publisher provided promotion code as provisioned in Data Market for the said product/artifact.")
|
|
579
|
-
promotionCode?: string;
|
|
580
|
-
|
|
581
|
-
@doc("The version of the desired product/artifact.")
|
|
582
|
-
version?: string;
|
|
583
|
-
}
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* The SKU (Stock Keeping Unit) assigned to this resource.
|
|
587
|
-
*/
|
|
588
|
-
@doc("The SKU (Stock Keeping Unit) assigned to this resource.")
|
|
589
|
-
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
590
|
-
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
591
|
-
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
592
|
-
model ResourceSkuType {
|
|
593
|
-
@doc("The name of the SKU, usually a combination of letters and numbers, for example, 'P3'")
|
|
594
|
-
name: string;
|
|
595
|
-
|
|
596
|
-
@doc("This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.")
|
|
597
|
-
tier?: SkuTier;
|
|
598
|
-
|
|
599
|
-
@doc("The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.")
|
|
600
|
-
size?: string;
|
|
601
|
-
|
|
602
|
-
@doc("If the service has different generations of hardware, for the same SKU, then that can be captured here.")
|
|
603
|
-
family?: string;
|
|
604
|
-
|
|
605
|
-
@doc("If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.")
|
|
606
|
-
capacity?: int32;
|
|
607
|
-
}
|
|
608
|
-
|
|
609
|
-
/**
|
|
610
|
-
* Available service tiers for the SKU.
|
|
611
|
-
*/
|
|
612
|
-
@doc("Available service tiers for the SKU.")
|
|
613
|
-
enum SkuTier {
|
|
614
|
-
@doc("The Free service tier.")
|
|
615
|
-
Free,
|
|
616
|
-
|
|
617
|
-
@doc("The Basic service tier.")
|
|
618
|
-
Basic,
|
|
619
|
-
|
|
620
|
-
@doc("The Standard service tier.")
|
|
621
|
-
Standard,
|
|
622
|
-
|
|
623
|
-
@doc("The Premium service tier.")
|
|
624
|
-
Premium,
|
|
625
|
-
}
|
|
626
|
-
|
|
627
169
|
/**
|
|
628
170
|
* The type used for update operations of the resource.
|
|
629
171
|
* @template Resource The type of the resource.
|
|
@@ -639,102 +181,6 @@ model ProxyResourceUpdateModel<
|
|
|
639
181
|
properties?: ResourceUpdateModelProperties<Resource, Properties>;
|
|
640
182
|
}
|
|
641
183
|
|
|
642
|
-
/**
|
|
643
|
-
* Details of a REST API operation, returned from the Resource Provider Operations API
|
|
644
|
-
*/
|
|
645
|
-
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
646
|
-
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
647
|
-
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
648
|
-
@doc("Details of a REST API operation, returned from the Resource Provider Operations API")
|
|
649
|
-
model Operation {
|
|
650
|
-
@doc("""
|
|
651
|
-
The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
|
|
652
|
-
""")
|
|
653
|
-
@visibility("read")
|
|
654
|
-
name?: string;
|
|
655
|
-
|
|
656
|
-
@doc("""
|
|
657
|
-
Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations.
|
|
658
|
-
""")
|
|
659
|
-
@visibility("read")
|
|
660
|
-
isDataAction?: boolean;
|
|
661
|
-
|
|
662
|
-
@doc("Localized display information for this particular operation.")
|
|
663
|
-
display?: OperationDisplay;
|
|
664
|
-
|
|
665
|
-
@doc("""
|
|
666
|
-
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
667
|
-
""")
|
|
668
|
-
@visibility("read")
|
|
669
|
-
origin?: Origin;
|
|
670
|
-
|
|
671
|
-
@doc("""
|
|
672
|
-
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
673
|
-
""")
|
|
674
|
-
actionType?: ActionType;
|
|
675
|
-
}
|
|
676
|
-
|
|
677
|
-
/**
|
|
678
|
-
* The default operationId parameter type.
|
|
679
|
-
*/
|
|
680
|
-
@doc("The default operationId parameter type.")
|
|
681
|
-
model OperationIdParameter {
|
|
682
|
-
@path
|
|
683
|
-
@minLength(1)
|
|
684
|
-
@doc("The ID of an ongoing async operation.")
|
|
685
|
-
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
686
|
-
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
687
|
-
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
688
|
-
operationId: string;
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
/**
|
|
692
|
-
* The check availability request body.
|
|
693
|
-
*/
|
|
694
|
-
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
695
|
-
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
696
|
-
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
697
|
-
@doc("The check availability request body.")
|
|
698
|
-
model CheckNameAvailabilityRequest {
|
|
699
|
-
@doc("The name of the resource for which availability needs to be checked.")
|
|
700
|
-
name?: string;
|
|
701
|
-
|
|
702
|
-
@doc("The resource type.")
|
|
703
|
-
type?: string;
|
|
704
|
-
}
|
|
705
|
-
|
|
706
|
-
/**
|
|
707
|
-
* Possible reasons for a name not being available.
|
|
708
|
-
*/
|
|
709
|
-
@doc("Possible reasons for a name not being available.")
|
|
710
|
-
union CheckNameAvailabilityReason {
|
|
711
|
-
@doc("Name is invalid.")
|
|
712
|
-
Invalid: "Invalid",
|
|
713
|
-
|
|
714
|
-
@doc("Name already exists.")
|
|
715
|
-
AlreadyExists: "AlreadyExists",
|
|
716
|
-
|
|
717
|
-
string,
|
|
718
|
-
}
|
|
719
|
-
|
|
720
|
-
/**
|
|
721
|
-
* The check availability result.
|
|
722
|
-
*/
|
|
723
|
-
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
724
|
-
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
725
|
-
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
726
|
-
@doc("The check availability result.")
|
|
727
|
-
model CheckNameAvailabilityResponse {
|
|
728
|
-
@doc("Indicates if the resource name is available.")
|
|
729
|
-
nameAvailable?: boolean;
|
|
730
|
-
|
|
731
|
-
@doc("The reason why the given name is not available.")
|
|
732
|
-
reason?: CheckNameAvailabilityReason;
|
|
733
|
-
|
|
734
|
-
@doc("Detailed reason why the given name is not available.")
|
|
735
|
-
message?: string;
|
|
736
|
-
}
|
|
737
|
-
|
|
738
184
|
alias DefaultProviderNamespace = {
|
|
739
185
|
@path
|
|
740
186
|
@TypeSpec.Rest.segment("providers")
|
package/lib/arm.tsp
CHANGED
|
@@ -7,7 +7,12 @@ import "@azure-tools/typespec-autorest";
|
|
|
7
7
|
import "@azure-tools/typespec-azure-core";
|
|
8
8
|
|
|
9
9
|
import "./arm.foundations.tsp";
|
|
10
|
-
import "./common-types.tsp";
|
|
10
|
+
import "./common-types/common-types.tsp";
|
|
11
|
+
import "./common-types/types.tsp";
|
|
12
|
+
import "./common-types/managed-identity.tsp";
|
|
13
|
+
import "./common-types/private-links.tsp";
|
|
14
|
+
import "./common-types/customer-managed-keys.tsp";
|
|
15
|
+
import "./common-types/extended-location.tsp";
|
|
11
16
|
import "./private.decorators.tsp";
|
|
12
17
|
import "./models.tsp";
|
|
13
18
|
import "./operations.tsp";
|
|
@@ -15,8 +20,6 @@ import "./decorators.tsp";
|
|
|
15
20
|
import "./interfaces.tsp";
|
|
16
21
|
import "./responses.tsp";
|
|
17
22
|
import "./parameters.tsp";
|
|
18
|
-
import "./private-links.tsp";
|
|
19
|
-
import "./customer-managed-keys.tsp";
|
|
20
23
|
|
|
21
24
|
using TypeSpec.Http;
|
|
22
25
|
using TypeSpec.Rest;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
namespace Azure.ResourceManager.Foundations {
|
|
2
|
+
/** The complex type of the extended location. */
|
|
3
|
+
model ExtendedLocation {
|
|
4
|
+
/** The name of the extended location. */
|
|
5
|
+
name: string;
|
|
6
|
+
|
|
7
|
+
/** The type of the extended location. */
|
|
8
|
+
type: ExtendedLocationType;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
/** The supported ExtendedLocation types. */
|
|
12
|
+
union ExtendedLocationType {
|
|
13
|
+
/** Azure Edge Zones location type */
|
|
14
|
+
EdgeZone: "EdgeZone",
|
|
15
|
+
|
|
16
|
+
/** Azure Custom Locations type */
|
|
17
|
+
CustomLocation: "CustomLocation",
|
|
18
|
+
|
|
19
|
+
string,
|
|
20
|
+
}
|
|
21
|
+
}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
using Azure.ResourceManager.Private;
|
|
2
|
+
|
|
3
|
+
namespace Azure.ResourceManager.Foundations;
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* The properties of the managed service identities assigned to this resource.
|
|
7
|
+
*/
|
|
8
|
+
@armCommonDefinition(
|
|
9
|
+
"ManagedServiceIdentity",
|
|
10
|
+
{
|
|
11
|
+
version: Azure.ResourceManager.CommonTypes.Versions.v4,
|
|
12
|
+
isDefault: true,
|
|
13
|
+
},
|
|
14
|
+
"managedidentity.json"
|
|
15
|
+
)
|
|
16
|
+
@armCommonDefinition(
|
|
17
|
+
"ManagedServiceIdentity",
|
|
18
|
+
Azure.ResourceManager.CommonTypes.Versions.v5,
|
|
19
|
+
"managedidentity.json"
|
|
20
|
+
)
|
|
21
|
+
@doc("The properties of the managed service identities assigned to this resource.")
|
|
22
|
+
model ManagedIdentityProperties {
|
|
23
|
+
@doc("The Active Directory tenant id of the principal.")
|
|
24
|
+
@visibility("read")
|
|
25
|
+
tenantId?: string;
|
|
26
|
+
|
|
27
|
+
@doc("The active directory identifier of this principal.")
|
|
28
|
+
@visibility("read")
|
|
29
|
+
principalId?: string;
|
|
30
|
+
|
|
31
|
+
@doc("The type of managed identity assigned to this resource.")
|
|
32
|
+
type: ManagedServiceIdentityType;
|
|
33
|
+
|
|
34
|
+
@doc("The identities assigned to this resource by the user.")
|
|
35
|
+
userAssignedIdentities?: Record<UserAssignedIdentity>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* The properties of the service-assigned identity associated with this resource.
|
|
40
|
+
*/
|
|
41
|
+
@armCommonDefinition(
|
|
42
|
+
"SystemAssignedServiceIdentity",
|
|
43
|
+
{
|
|
44
|
+
version: Azure.ResourceManager.CommonTypes.Versions.v4,
|
|
45
|
+
isDefault: true,
|
|
46
|
+
},
|
|
47
|
+
"managedidentity.json"
|
|
48
|
+
)
|
|
49
|
+
@armCommonDefinition(
|
|
50
|
+
"SystemAssignedServiceIdentity",
|
|
51
|
+
Azure.ResourceManager.CommonTypes.Versions.v5,
|
|
52
|
+
"managedidentity.json"
|
|
53
|
+
)
|
|
54
|
+
@doc("The properties of the service-assigned identity associated with this resource.")
|
|
55
|
+
model ManagedSystemIdentityProperties {
|
|
56
|
+
@doc("The Active Directory tenant id of the principal.")
|
|
57
|
+
@visibility("read")
|
|
58
|
+
tenantId?: string;
|
|
59
|
+
|
|
60
|
+
@doc("The active directory identifier of this principal.")
|
|
61
|
+
@visibility("read")
|
|
62
|
+
principalId?: string;
|
|
63
|
+
|
|
64
|
+
@doc("The type of managed identity assigned to this resource.")
|
|
65
|
+
type: SystemAssignedServiceIdentityType;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/** Alias of ManagedServiceIdentityType for back compatability. Please change to ManagedServiceIdentityType. */
|
|
69
|
+
#deprecated "Please change to ManagedServiceIdentityType."
|
|
70
|
+
alias ManagedIdentityType = ManagedServiceIdentityType;
|
|
71
|
+
/**
|
|
72
|
+
* A managed identity assigned by the user.
|
|
73
|
+
*/
|
|
74
|
+
@doc("A managed identity assigned by the user.")
|
|
75
|
+
model UserAssignedIdentity {
|
|
76
|
+
@doc("The active directory client identifier for this principal.")
|
|
77
|
+
clientId?: string;
|
|
78
|
+
|
|
79
|
+
@doc("The active directory identifier for this principal.")
|
|
80
|
+
principalId?: string;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* The kind of managed identity assigned to this resource.
|
|
85
|
+
*/
|
|
86
|
+
@doc("The kind of managed identity assigned to this resource.")
|
|
87
|
+
union ManagedServiceIdentityType {
|
|
88
|
+
@doc("No managed identity.")
|
|
89
|
+
None: "None",
|
|
90
|
+
|
|
91
|
+
@doc("System assigned managed identity.")
|
|
92
|
+
SystemAssigned: "SystemAssigned",
|
|
93
|
+
|
|
94
|
+
@doc("User assigned managed identity.")
|
|
95
|
+
UserAssigned: "UserAssigned",
|
|
96
|
+
|
|
97
|
+
@doc("System and user assigned managed identity.")
|
|
98
|
+
SystemAndUserAssigned: "SystemAssigned, UserAssigned",
|
|
99
|
+
|
|
100
|
+
string,
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/** Alias of SystemAssignedServiceIdentityType for back compatability. Please change to SystemAssignedServiceIdentityType. */
|
|
104
|
+
alias ManagedSystemIdentityType = SystemAssignedServiceIdentityType;
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* The kind of managemed identity assigned to this resource.
|
|
108
|
+
*/
|
|
109
|
+
@doc("The kind of managemed identity assigned to this resource.")
|
|
110
|
+
union SystemAssignedServiceIdentityType {
|
|
111
|
+
@doc("No managed system identity.")
|
|
112
|
+
None: "None",
|
|
113
|
+
|
|
114
|
+
@doc("System assigned managed system identity.")
|
|
115
|
+
SystemAssigned: "SystemAssigned",
|
|
116
|
+
|
|
117
|
+
string,
|
|
118
|
+
}
|
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
using TypeSpec.Http;
|
|
2
|
+
using TypeSpec.OpenAPI;
|
|
3
|
+
using Azure.ResourceManager.Private;
|
|
4
|
+
|
|
5
|
+
namespace Azure.ResourceManager.Foundations;
|
|
6
|
+
|
|
7
|
+
/** Base class used for type definitions */
|
|
8
|
+
model ArmResourceBase {}
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Base model that defines common properties for all Azure Resource Manager resources.
|
|
12
|
+
*/
|
|
13
|
+
@doc("Common properties for all Azure Resource Manager resources.")
|
|
14
|
+
model ArmResource extends ArmResourceBase {
|
|
15
|
+
@doc("Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}")
|
|
16
|
+
@visibility("read")
|
|
17
|
+
id: string;
|
|
18
|
+
|
|
19
|
+
@doc("The name of the resource")
|
|
20
|
+
@visibility("read")
|
|
21
|
+
name: string;
|
|
22
|
+
|
|
23
|
+
@doc("The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"")
|
|
24
|
+
@visibility("read")
|
|
25
|
+
type: string;
|
|
26
|
+
|
|
27
|
+
@doc("Azure Resource Manager metadata containing createdBy and modifiedBy information.")
|
|
28
|
+
@visibility("read")
|
|
29
|
+
systemData?: SystemData;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Standard type definition for Azure Resource Manager Tags property.
|
|
34
|
+
*
|
|
35
|
+
* It is included in the TrackedResource template definition.
|
|
36
|
+
*/
|
|
37
|
+
@doc("The Azure Resource Manager Resource tags.")
|
|
38
|
+
model ArmTagsProperty {
|
|
39
|
+
@doc("Resource tags.")
|
|
40
|
+
tags?: Record<string>;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* The base tracked resource.
|
|
45
|
+
*/
|
|
46
|
+
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
47
|
+
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
48
|
+
@armCommonDefinition("TrackedResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
49
|
+
@doc("The resource model definition for an Azure Resource Manager tracked top level resource")
|
|
50
|
+
model TrackedResourceBase extends ArmResource {
|
|
51
|
+
@doc("The geo-location where the resource lives")
|
|
52
|
+
@visibility("read", "create")
|
|
53
|
+
location: string;
|
|
54
|
+
|
|
55
|
+
...ArmTagsProperty;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* The base proxy resource.
|
|
60
|
+
*/
|
|
61
|
+
@doc("The base proxy resource.")
|
|
62
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
63
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
64
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
65
|
+
model ProxyResourceBase extends ArmResource {}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* The base extension resource.
|
|
69
|
+
*/
|
|
70
|
+
// Note that ProxyResource is the base definition for both kinds of resources
|
|
71
|
+
@doc("The base extension resource.")
|
|
72
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
73
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
74
|
+
@armCommonDefinition("ProxyResource", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
75
|
+
model ExtensionResourceBase extends ArmResource {}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* The SKU (Stock Keeping Unit) assigned to this resource.
|
|
79
|
+
*/
|
|
80
|
+
@doc("The SKU (Stock Keeping Unit) assigned to this resource.")
|
|
81
|
+
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
82
|
+
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
83
|
+
@armCommonDefinition("Sku", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
84
|
+
model ResourceSkuType {
|
|
85
|
+
@doc("The name of the SKU, usually a combination of letters and numbers, for example, 'P3'")
|
|
86
|
+
name: string;
|
|
87
|
+
|
|
88
|
+
@doc("This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.")
|
|
89
|
+
tier?: SkuTier;
|
|
90
|
+
|
|
91
|
+
@doc("The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.")
|
|
92
|
+
size?: string;
|
|
93
|
+
|
|
94
|
+
@doc("If the service has different generations of hardware, for the same SKU, then that can be captured here.")
|
|
95
|
+
family?: string;
|
|
96
|
+
|
|
97
|
+
@doc("If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.")
|
|
98
|
+
capacity?: int32;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* Available service tiers for the SKU.
|
|
103
|
+
*/
|
|
104
|
+
@doc("Available service tiers for the SKU.")
|
|
105
|
+
enum SkuTier {
|
|
106
|
+
@doc("The Free service tier.")
|
|
107
|
+
Free,
|
|
108
|
+
|
|
109
|
+
@doc("The Basic service tier.")
|
|
110
|
+
Basic,
|
|
111
|
+
|
|
112
|
+
@doc("The Standard service tier.")
|
|
113
|
+
Standard,
|
|
114
|
+
|
|
115
|
+
@doc("The Premium service tier.")
|
|
116
|
+
Premium,
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
|
|
121
|
+
*/
|
|
122
|
+
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
123
|
+
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
124
|
+
@armCommonDefinition("OperationListResult", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
125
|
+
@doc("""
|
|
126
|
+
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
|
|
127
|
+
""")
|
|
128
|
+
model OperationListResult is Azure.Core.Page<Operation>;
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Details of a REST API operation, returned from the Resource Provider Operations API
|
|
132
|
+
*/
|
|
133
|
+
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
134
|
+
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
135
|
+
@armCommonDefinition("Operation", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
136
|
+
@doc("Details of a REST API operation, returned from the Resource Provider Operations API")
|
|
137
|
+
model Operation {
|
|
138
|
+
@doc("""
|
|
139
|
+
The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
|
|
140
|
+
""")
|
|
141
|
+
@visibility("read")
|
|
142
|
+
name?: string;
|
|
143
|
+
|
|
144
|
+
@doc("""
|
|
145
|
+
Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations.
|
|
146
|
+
""")
|
|
147
|
+
@visibility("read")
|
|
148
|
+
isDataAction?: boolean;
|
|
149
|
+
|
|
150
|
+
@doc("Localized display information for this particular operation.")
|
|
151
|
+
display?: OperationDisplay;
|
|
152
|
+
|
|
153
|
+
@doc("""
|
|
154
|
+
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
155
|
+
""")
|
|
156
|
+
@visibility("read")
|
|
157
|
+
origin?: Origin;
|
|
158
|
+
|
|
159
|
+
@doc("""
|
|
160
|
+
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
161
|
+
""")
|
|
162
|
+
actionType?: ActionType;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Localized display information for and operation.
|
|
167
|
+
*/
|
|
168
|
+
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
169
|
+
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
170
|
+
@armCommonDefinition("OperationDisplay", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
171
|
+
@doc("Localized display information for and operation.")
|
|
172
|
+
model OperationDisplay {
|
|
173
|
+
@doc("""
|
|
174
|
+
The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
|
|
175
|
+
""")
|
|
176
|
+
provider?: string;
|
|
177
|
+
|
|
178
|
+
@doc("""
|
|
179
|
+
The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
|
|
180
|
+
""")
|
|
181
|
+
resource?: string;
|
|
182
|
+
|
|
183
|
+
@doc("""
|
|
184
|
+
The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
|
|
185
|
+
""")
|
|
186
|
+
operation?: string;
|
|
187
|
+
|
|
188
|
+
@doc("The short, localized friendly description of the operation; suitable for tool tips and detailed views.")
|
|
189
|
+
description?: string;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The current status of an async operation.
|
|
194
|
+
*/
|
|
195
|
+
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
196
|
+
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
197
|
+
@armCommonDefinition("OperationStatusResult", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
198
|
+
@doc("The current status of an async operation.")
|
|
199
|
+
model OperationStatusResult {
|
|
200
|
+
@doc("Fully qualified ID for the async operation.")
|
|
201
|
+
id?: string;
|
|
202
|
+
|
|
203
|
+
@doc("Name of the async operation.")
|
|
204
|
+
name?: string;
|
|
205
|
+
|
|
206
|
+
@doc("Operation status.")
|
|
207
|
+
status: string;
|
|
208
|
+
|
|
209
|
+
@doc("Percent of the operation that is complete.")
|
|
210
|
+
@minValue(0)
|
|
211
|
+
@maxValue(100)
|
|
212
|
+
percentComplete?: int32;
|
|
213
|
+
|
|
214
|
+
@doc("The start time of the operation.")
|
|
215
|
+
startTime?: utcDateTime;
|
|
216
|
+
|
|
217
|
+
@doc("The end time of the operation.")
|
|
218
|
+
endTime?: utcDateTime;
|
|
219
|
+
|
|
220
|
+
@doc("The operations list.")
|
|
221
|
+
operations: OperationStatusResult[];
|
|
222
|
+
|
|
223
|
+
@doc("If present, details of the operation error.")
|
|
224
|
+
error?: ErrorDetail;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* The default operationId parameter type.
|
|
229
|
+
*/
|
|
230
|
+
@doc("The default operationId parameter type.")
|
|
231
|
+
model OperationIdParameter {
|
|
232
|
+
@path
|
|
233
|
+
@minLength(1)
|
|
234
|
+
@doc("The ID of an ongoing async operation.")
|
|
235
|
+
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
236
|
+
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
237
|
+
@armCommonParameter("OperationIdParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
238
|
+
operationId: string;
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
243
|
+
*/
|
|
244
|
+
@doc("""
|
|
245
|
+
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
|
|
246
|
+
""")
|
|
247
|
+
union ActionType {
|
|
248
|
+
@doc("Actions are for internal-only APIs.")
|
|
249
|
+
Internal: "Internal",
|
|
250
|
+
|
|
251
|
+
string,
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
256
|
+
*/
|
|
257
|
+
@doc("""
|
|
258
|
+
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
|
|
259
|
+
""")
|
|
260
|
+
union Origin {
|
|
261
|
+
@doc("Indicates the operation is initiated by a user.")
|
|
262
|
+
user: "user",
|
|
263
|
+
|
|
264
|
+
@doc("Indicates the operation is initiated by a system.")
|
|
265
|
+
system: "system",
|
|
266
|
+
|
|
267
|
+
@doc("Indicates the operation is initiated by a user or system.")
|
|
268
|
+
`user,system`: "user,system",
|
|
269
|
+
|
|
270
|
+
string,
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* The error detail.
|
|
275
|
+
*/
|
|
276
|
+
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
277
|
+
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
278
|
+
@armCommonDefinition("ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
279
|
+
@doc("The error detail.")
|
|
280
|
+
model ErrorDetail {
|
|
281
|
+
@doc("The error code.")
|
|
282
|
+
@visibility("read")
|
|
283
|
+
code?: string;
|
|
284
|
+
|
|
285
|
+
@doc("The error message.")
|
|
286
|
+
@visibility("read")
|
|
287
|
+
message?: string;
|
|
288
|
+
|
|
289
|
+
@doc("The error target.")
|
|
290
|
+
@visibility("read")
|
|
291
|
+
target?: string;
|
|
292
|
+
|
|
293
|
+
@extension("x-ms-identifiers", ["message", "target"])
|
|
294
|
+
@doc("The error details.")
|
|
295
|
+
@visibility("read")
|
|
296
|
+
details?: ErrorDetail[];
|
|
297
|
+
|
|
298
|
+
@extension("x-ms-identifiers", ["message", "target"])
|
|
299
|
+
@doc("The error additional info.")
|
|
300
|
+
@visibility("read")
|
|
301
|
+
additionalInfo?: ErrorAdditionalInfo[];
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* The resource management error additional info.
|
|
306
|
+
*/
|
|
307
|
+
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
308
|
+
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
309
|
+
@armCommonDefinition("ErrorAdditionalInfo", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
310
|
+
@doc("The resource management error additional info.")
|
|
311
|
+
model ErrorAdditionalInfo {
|
|
312
|
+
@doc("The additional info type.")
|
|
313
|
+
@visibility("read")
|
|
314
|
+
type?: string;
|
|
315
|
+
|
|
316
|
+
@doc("The additional info.")
|
|
317
|
+
@visibility("read")
|
|
318
|
+
info?: {};
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* Metadata pertaining to creation and last modification of the resource.
|
|
323
|
+
*/
|
|
324
|
+
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
325
|
+
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
326
|
+
@armCommonDefinition("systemData", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
327
|
+
@doc("Metadata pertaining to creation and last modification of the resource.")
|
|
328
|
+
model SystemData {
|
|
329
|
+
@visibility("read")
|
|
330
|
+
@doc("The identity that created the resource.")
|
|
331
|
+
createdBy?: string;
|
|
332
|
+
|
|
333
|
+
@visibility("read")
|
|
334
|
+
@doc("The type of identity that created the resource.")
|
|
335
|
+
createdByType?: createdByType;
|
|
336
|
+
|
|
337
|
+
@visibility("read")
|
|
338
|
+
@doc("The type of identity that created the resource.")
|
|
339
|
+
createdAt?: plainDate;
|
|
340
|
+
|
|
341
|
+
@visibility("read")
|
|
342
|
+
@doc("The identity that last modified the resource.")
|
|
343
|
+
lastModifiedBy?: string;
|
|
344
|
+
|
|
345
|
+
@visibility("read")
|
|
346
|
+
@doc("The type of identity that last modified the resource.")
|
|
347
|
+
lastModifiedByType?: createdByType;
|
|
348
|
+
|
|
349
|
+
@visibility("read")
|
|
350
|
+
@doc("The timestamp of resource last modification (UTC)")
|
|
351
|
+
lastModifiedAt?: plainDate;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* The kind of entity that created the resource.
|
|
356
|
+
*/
|
|
357
|
+
// NOTE: This is how the extensible enum is named in types.json
|
|
358
|
+
@doc("The kind of entity that created the resource.")
|
|
359
|
+
union createdByType {
|
|
360
|
+
@doc("The entity was created by a user.")
|
|
361
|
+
User: "User",
|
|
362
|
+
|
|
363
|
+
@doc("The entity was created by an application.")
|
|
364
|
+
Application: "Application",
|
|
365
|
+
|
|
366
|
+
@doc("The entity was created by a managed identity.")
|
|
367
|
+
ManagedIdentity: "ManagedIdentity",
|
|
368
|
+
|
|
369
|
+
@doc("The entity was created by a key.")
|
|
370
|
+
Key: "Key",
|
|
371
|
+
|
|
372
|
+
string,
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* Details of the resource plan.
|
|
377
|
+
*/
|
|
378
|
+
@doc("Details of the resource plan.")
|
|
379
|
+
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
380
|
+
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
381
|
+
@armCommonDefinition("Plan", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
382
|
+
model ResourcePlanType {
|
|
383
|
+
@doc("A user defined name of the 3rd Party Artifact that is being procured.")
|
|
384
|
+
name: string;
|
|
385
|
+
|
|
386
|
+
@doc("The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic")
|
|
387
|
+
publisher: string;
|
|
388
|
+
|
|
389
|
+
@doc("The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ")
|
|
390
|
+
product: string;
|
|
391
|
+
|
|
392
|
+
@doc("A publisher provided promotion code as provisioned in Data Market for the said product/artifact.")
|
|
393
|
+
promotionCode?: string;
|
|
394
|
+
|
|
395
|
+
@doc("The version of the desired product/artifact.")
|
|
396
|
+
version?: string;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* The check availability request body.
|
|
401
|
+
*/
|
|
402
|
+
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
403
|
+
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
404
|
+
@armCommonDefinition("CheckNameAvailabilityRequest", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
405
|
+
@doc("The check availability request body.")
|
|
406
|
+
model CheckNameAvailabilityRequest {
|
|
407
|
+
@doc("The name of the resource for which availability needs to be checked.")
|
|
408
|
+
name?: string;
|
|
409
|
+
|
|
410
|
+
@doc("The resource type.")
|
|
411
|
+
type?: string;
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
/**
|
|
415
|
+
* The check availability result.
|
|
416
|
+
*/
|
|
417
|
+
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v3)
|
|
418
|
+
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v4)
|
|
419
|
+
@armCommonDefinition("CheckNameAvailabilityResponse", Azure.ResourceManager.CommonTypes.Versions.v5)
|
|
420
|
+
@doc("The check availability result.")
|
|
421
|
+
model CheckNameAvailabilityResponse {
|
|
422
|
+
@doc("Indicates if the resource name is available.")
|
|
423
|
+
nameAvailable?: boolean;
|
|
424
|
+
|
|
425
|
+
@doc("The reason why the given name is not available.")
|
|
426
|
+
reason?: CheckNameAvailabilityReason;
|
|
427
|
+
|
|
428
|
+
@doc("Detailed reason why the given name is not available.")
|
|
429
|
+
message?: string;
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
/**
|
|
433
|
+
* Possible reasons for a name not being available.
|
|
434
|
+
*/
|
|
435
|
+
@doc("Possible reasons for a name not being available.")
|
|
436
|
+
union CheckNameAvailabilityReason {
|
|
437
|
+
@doc("Name is invalid.")
|
|
438
|
+
Invalid: "Invalid",
|
|
439
|
+
|
|
440
|
+
@doc("Name already exists.")
|
|
441
|
+
AlreadyExists: "AlreadyExists",
|
|
442
|
+
|
|
443
|
+
string,
|
|
444
|
+
}
|
package/lib/models.tsp
CHANGED
|
@@ -171,6 +171,20 @@ model DefaultProvisioningStateProperty {
|
|
|
171
171
|
provisioningState?: ResourceProvisioningState;
|
|
172
172
|
}
|
|
173
173
|
|
|
174
|
+
/** The standard evenlop definition of ExtendedLocation.
|
|
175
|
+
*
|
|
176
|
+
* @example
|
|
177
|
+
* ```typespec
|
|
178
|
+
* model Employee is TrackedResource<EmployeeProperties> {
|
|
179
|
+
* ...ResourceNameParameter<Employee>;
|
|
180
|
+
* ...ExtendedLocationProperty;
|
|
181
|
+
* }
|
|
182
|
+
* ```
|
|
183
|
+
*/
|
|
184
|
+
model ExtendedLocationProperty {
|
|
185
|
+
extendedLocation: Foundations.ExtendedLocation;
|
|
186
|
+
}
|
|
187
|
+
|
|
174
188
|
/**
|
|
175
189
|
* Standard Azure Resource Manager definition of ManagedServiceIdentity
|
|
176
190
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure-tools/typespec-azure-resource-manager",
|
|
3
|
-
"version": "0.42.0-dev.
|
|
3
|
+
"version": "0.42.0-dev.12",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "TypeSpec Azure Resource Manager library",
|
|
6
6
|
"homepage": "https://azure.github.io/typespec-azure",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"node": ">=18.0.0"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
|
37
|
-
"lib
|
|
37
|
+
"lib/**/*.tsp",
|
|
38
38
|
"dist/**",
|
|
39
39
|
"!dist/test/**"
|
|
40
40
|
],
|
|
File without changes
|
|
File without changes
|
|
File without changes
|