@azure-tools/typespec-azure-resource-manager 0.30.0 → 0.31.0-dev.2

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.
@@ -64,10 +64,19 @@ model ExtensionResourceBase extends ArmResource {}
64
64
  * An internal enum to indicate the resource support for various path types
65
65
  */
66
66
  enum ResourceHome {
67
+ @doc("The resource is bound to a tenant")
67
68
  Tenant,
69
+
70
+ @doc("The resource is bound to a subscription")
68
71
  Subscription,
72
+
73
+ @doc("The resource is bound to a location")
69
74
  Location,
75
+
76
+ @doc("The resource is bound to a resource group")
70
77
  ResourceGroup,
78
+
79
+ @doc("The resource is bound to an extension")
71
80
  Extension,
72
81
  }
73
82
 
@@ -78,8 +87,13 @@ enum ResourceHome {
78
87
  The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
79
88
  """)
80
89
  enum Origin {
90
+ @doc("Indicates the operation is initiated by a user.")
81
91
  user,
92
+
93
+ @doc("Indicates the operation is initiated by a system.")
82
94
  system,
95
+
96
+ @doc("Indicates the operation is initiated by a user or system.")
83
97
  `user,system`,
84
98
  }
85
99
 
@@ -90,6 +104,7 @@ enum Origin {
90
104
  Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
91
105
  """)
92
106
  enum ActionType {
107
+ @doc("Actions are for internal-only APIs.")
93
108
  Internal,
94
109
  }
95
110
 
@@ -264,9 +279,16 @@ model ArmTagsProperty {
264
279
  // NOTE: This is how the enum is named in types.json
265
280
  @doc("The kind of entity that created the resource.")
266
281
  enum createdByType {
282
+ @doc("The entity was created by a user.")
267
283
  User,
284
+
285
+ @doc("The entity was created by an application.")
268
286
  Application,
287
+
288
+ @doc("The entity was created by a managed identity.")
269
289
  ManagedIdentity,
290
+
291
+ @doc("The entity was created by a key.")
270
292
  Key,
271
293
  }
272
294
 
@@ -357,9 +379,16 @@ model UserAssignedIdentity {
357
379
  */
358
380
  @doc("The kind of managed identity assigned to this resource.")
359
381
  enum ManagedIdentityType {
382
+ @doc("No managed identity.")
360
383
  None,
384
+
385
+ @doc("System assigned managed identity.")
361
386
  SystemAssigned,
387
+
388
+ @doc("User assigned managed identity.")
362
389
  UserAssigned,
390
+
391
+ @doc("System and user assigned managed identity.")
363
392
  SystemAndUserAssigned: "SystemAssigned, UserAssigned",
364
393
  }
365
394
 
@@ -368,7 +397,10 @@ enum ManagedIdentityType {
368
397
  */
369
398
  @doc("The kind of managemed identity assigned to this resource.")
370
399
  enum ManagedSystemIdentityType {
400
+ @doc("No managed system identity.")
371
401
  None,
402
+
403
+ @doc("System assigned managed system identity.")
372
404
  SystemAssigned,
373
405
  }
374
406
 
@@ -495,9 +527,16 @@ model ResourceSkuType {
495
527
  */
496
528
  @doc("Available service tiers for the SKU.")
497
529
  enum SkuTier {
530
+ @doc("The Free service tier.")
498
531
  Free,
532
+
533
+ @doc("The Basic service tier.")
499
534
  Basic,
535
+
536
+ @doc("The Standard service tier.")
500
537
  Standard,
538
+
539
+ @doc("The Premium service tier.")
501
540
  Premium,
502
541
  }
503
542
 
@@ -576,7 +615,10 @@ model CheckNameAvailabilityRequest {
576
615
  */
577
616
  @doc("Possible reasons for a name not being available.")
578
617
  enum CheckNameAvailabilityReason {
618
+ @doc("Name is invalid.")
579
619
  Invalid,
620
+
621
+ @doc("Name already exists.")
580
622
  AlreadyExists,
581
623
  }
582
624
 
package/lib/arm.tsp CHANGED
@@ -28,7 +28,9 @@ namespace Azure.ResourceManager;
28
28
  /**
29
29
  * Supported versions of Azure.ResourceManager building blocks.
30
30
  */
31
+ @doc("Supported versions of Azure.ResourceManager building blocks.")
31
32
  enum Versions {
33
+ @doc("Version 1.0-preview.1")
32
34
  @useDependency(Azure.Core.Versions.v1_0_Preview_1)
33
35
  v1_0_Preview_1: "1.0-preview.1",
34
36
  }
package/lib/models.tsp CHANGED
@@ -141,8 +141,13 @@ model ResourceIdentifierAllowedResource {
141
141
  @doc("The provisioning state of a resource type.")
142
142
  @Azure.Core.lroStatus
143
143
  enum ResourceProvisioningState {
144
+ @doc("Resource has been created.")
144
145
  Succeeded,
146
+
147
+ @doc("Resource creation failed.")
145
148
  Failed,
149
+
150
+ @doc("Resource creation was canceled.")
146
151
  Canceled,
147
152
  }
148
153
 
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@azure-tools/typespec-azure-resource-manager",
3
- "version": "0.30.0",
3
+ "version": "0.31.0-dev.2",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec Azure Resource Manager library",
6
6
  "homepage": "https://azure.github.io/typespec-azure",
7
- "readme": "https://github.com/Microsoft/typespec/blob/master/README.md",
7
+ "readme": "https://github.com/Azure/typespec-azure/blob/main/packages/typespec-azure-resource-manager/README.md",
8
8
  "license": "MIT",
9
9
  "repository": {
10
10
  "type": "git",
11
- "url": "git+https://github.com/Microsoft/typespec.git"
11
+ "url": "git+https://github.com/Azure/typespec-azure.git"
12
12
  },
13
13
  "bugs": {
14
- "url": "https://github.com/Microsot/typespec/issues"
14
+ "url": "https://github.com/Azure/typespec-azure/issues"
15
15
  },
16
16
  "keywords": [
17
17
  "typespec"
@@ -42,30 +42,30 @@
42
42
  "!dist/test/**"
43
43
  ],
44
44
  "peerDependencies": {
45
- "@typespec/compiler": "~0.44.0",
46
- "@azure-tools/typespec-azure-core": "~0.30.0",
47
- "@azure-tools/typespec-autorest": "~0.30.0",
48
- "@typespec/openapi": "~0.44.0",
49
- "@typespec/rest": "~0.44.0",
50
- "@typespec/http": "~0.44.0",
51
- "@typespec/versioning": "~0.44.0"
45
+ "@typespec/compiler": "~0.44.0 || >=0.45.0-dev <0.45.0",
46
+ "@azure-tools/typespec-azure-core": "~0.30.1 || >=0.31.0-dev <0.31.0",
47
+ "@azure-tools/typespec-autorest": "~0.30.0 || >=0.31.0-dev <0.31.0",
48
+ "@typespec/openapi": "~0.44.0 || >=0.45.0-dev <0.45.0",
49
+ "@typespec/rest": "~0.44.0 || >=0.45.0-dev <0.45.0",
50
+ "@typespec/http": "~0.44.0 || >=0.45.0-dev <0.45.0",
51
+ "@typespec/versioning": "~0.44.0 || >=0.45.0-dev <0.45.0"
52
52
  },
53
53
  "dependencies": {
54
- "@typespec/lint": "~0.44.0"
54
+ "@typespec/lint": "~0.44.0 || >=0.45.0-dev <0.45.0"
55
55
  },
56
56
  "devDependencies": {
57
- "@typespec/compiler": "~0.44.0",
58
- "@typespec/openapi": "~0.44.0",
59
- "@azure-tools/typespec-azure-core": "~0.30.0",
60
- "@azure-tools/typespec-autorest": "~0.30.0",
61
- "@typespec/rest": "~0.44.0",
62
- "@typespec/http": "~0.44.0",
63
- "@typespec/versioning": "~0.44.0",
57
+ "@typespec/compiler": "~0.44.0 || >=0.45.0-dev <0.45.0",
58
+ "@typespec/openapi": "~0.44.0 || >=0.45.0-dev <0.45.0",
59
+ "@azure-tools/typespec-azure-core": "~0.30.1 || >=0.31.0-dev <0.31.0",
60
+ "@azure-tools/typespec-autorest": "~0.30.0 || >=0.31.0-dev <0.31.0",
61
+ "@typespec/rest": "~0.44.0 || >=0.45.0-dev <0.45.0",
62
+ "@typespec/http": "~0.44.0 || >=0.45.0-dev <0.45.0",
63
+ "@typespec/versioning": "~0.44.0 || >=0.45.0-dev <0.45.0",
64
64
  "@types/mocha": "~10.0.0",
65
65
  "@types/node": "~18.11.9",
66
- "@typespec/eslint-config-typespec": "~0.7.0",
67
- "@typespec/library-linter": "~0.44.0",
68
- "@typespec/eslint-plugin": "~0.44.0",
66
+ "@typespec/eslint-config-typespec": "~0.7.0 || >=0.8.0-dev <0.8.0",
67
+ "@typespec/library-linter": "~0.44.0 || >=0.45.0-dev <0.45.0",
68
+ "@typespec/eslint-plugin": "~0.44.0 || >=0.45.0-dev <0.45.0",
69
69
  "eslint": "^8.36.0",
70
70
  "mocha": "~10.2.0",
71
71
  "mocha-junit-reporter": "~2.2.0",