@azure-tools/typespec-azure-resource-manager 0.40.0-dev.5 → 0.40.0-dev.7
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/README.md +27 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -94,13 +94,13 @@ the version of the Azure Resource Manager common-types to use for refs in emitte
|
|
|
94
94
|
|
|
95
95
|
##### Target
|
|
96
96
|
|
|
97
|
-
`
|
|
97
|
+
`Namespace | EnumMember`
|
|
98
98
|
|
|
99
99
|
##### Parameters
|
|
100
100
|
|
|
101
|
-
| Name | Type
|
|
102
|
-
| ------- |
|
|
103
|
-
| version | `valueof
|
|
101
|
+
| Name | Type | Description |
|
|
102
|
+
| ------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
103
|
+
| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value. |
|
|
104
104
|
|
|
105
105
|
#### `@armLibraryNamespace`
|
|
106
106
|
|
|
@@ -140,9 +140,9 @@ Namespace element value unless an override value is specified.
|
|
|
140
140
|
|
|
141
141
|
##### Parameters
|
|
142
142
|
|
|
143
|
-
| Name | Type
|
|
144
|
-
| ----------------- |
|
|
145
|
-
| providerNamespace | `valueof
|
|
143
|
+
| Name | Type | Description |
|
|
144
|
+
| ----------------- | ---------------- | ------------------ |
|
|
145
|
+
| providerNamespace | `valueof string` | Provider namespace |
|
|
146
146
|
|
|
147
147
|
##### Examples
|
|
148
148
|
|
|
@@ -167,7 +167,7 @@ property to the type of the Azure Resource Manager resource.
|
|
|
167
167
|
|
|
168
168
|
##### Target
|
|
169
169
|
|
|
170
|
-
`
|
|
170
|
+
`Operation | Model`
|
|
171
171
|
|
|
172
172
|
##### Parameters
|
|
173
173
|
|
|
@@ -187,11 +187,11 @@ Marks the operation as being a collection action
|
|
|
187
187
|
|
|
188
188
|
##### Parameters
|
|
189
189
|
|
|
190
|
-
| Name | Type
|
|
191
|
-
| ---------------------- |
|
|
192
|
-
| resourceType | `Model`
|
|
193
|
-
| parentTypeName | `valueof
|
|
194
|
-
| parentFriendlyTypeName | `valueof
|
|
190
|
+
| Name | Type | Description |
|
|
191
|
+
| ---------------------- | ---------------- | ------------------------- |
|
|
192
|
+
| resourceType | `Model` | Resource |
|
|
193
|
+
| parentTypeName | `valueof string` | : Parent type name. |
|
|
194
|
+
| parentFriendlyTypeName | `valueof string` | Friendly name for parent. |
|
|
195
195
|
|
|
196
196
|
#### `@armResourceAction`
|
|
197
197
|
|
|
@@ -294,9 +294,9 @@ clients.
|
|
|
294
294
|
|
|
295
295
|
##### Parameters
|
|
296
296
|
|
|
297
|
-
| Name | Type
|
|
298
|
-
| ---- |
|
|
299
|
-
| \_ | `
|
|
297
|
+
| Name | Type | Description |
|
|
298
|
+
| ---- | --------- | ----------- |
|
|
299
|
+
| \_ | `unknown` | DEPRECATED |
|
|
300
300
|
|
|
301
301
|
#### `@armResourceRead`
|
|
302
302
|
|
|
@@ -395,7 +395,7 @@ None
|
|
|
395
395
|
This decorator sets the base type of the given resource.
|
|
396
396
|
|
|
397
397
|
```typespec
|
|
398
|
-
@Azure.ResourceManager.resourceBaseType(baseType: Tenant | Subscription | ResourceGroup | Location | Extension)
|
|
398
|
+
@Azure.ResourceManager.resourceBaseType(baseType: "Tenant" | "Subscription" | "ResourceGroup" | "Location" | "Extension")
|
|
399
399
|
```
|
|
400
400
|
|
|
401
401
|
##### Target
|
|
@@ -404,9 +404,9 @@ This decorator sets the base type of the given resource.
|
|
|
404
404
|
|
|
405
405
|
##### Parameters
|
|
406
406
|
|
|
407
|
-
| Name | Type
|
|
408
|
-
| -------- |
|
|
409
|
-
| baseType | `
|
|
407
|
+
| Name | Type | Description |
|
|
408
|
+
| -------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
409
|
+
| baseType | `"Tenant" \| "Subscription" \| "ResourceGroup" \| "Location" \| "Extension"` | The built-in parent of the resource, this can be "Tenant", "Subscription", "ResourceGroup", "Location", or "Extension" |
|
|
410
410
|
|
|
411
411
|
#### `@resourceGroupResource`
|
|
412
412
|
|
|
@@ -440,7 +440,7 @@ Singleton resources only have a single instance with a fixed key name.
|
|
|
440
440
|
See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
|
|
441
441
|
|
|
442
442
|
```typespec
|
|
443
|
-
@Azure.ResourceManager.singleton(keyValue?: valueof string | default)
|
|
443
|
+
@Azure.ResourceManager.singleton(keyValue?: valueof string | "default")
|
|
444
444
|
```
|
|
445
445
|
|
|
446
446
|
##### Target
|
|
@@ -449,9 +449,9 @@ See more details on [different Azure Resource Manager resource type here.](https
|
|
|
449
449
|
|
|
450
450
|
##### Parameters
|
|
451
451
|
|
|
452
|
-
| Name | Type
|
|
453
|
-
| -------- |
|
|
454
|
-
| keyValue | `valueof
|
|
452
|
+
| Name | Type | Description |
|
|
453
|
+
| -------- | ----------------------------- | -------------------------------------------------------------- |
|
|
454
|
+
| keyValue | `valueof string \| "default"` | The name of the singleton resource. Default name is "default". |
|
|
455
455
|
|
|
456
456
|
#### `@subscriptionResource`
|
|
457
457
|
|
|
@@ -510,6 +510,6 @@ This allows sharing Azure Resource Manager resource types across specifications
|
|
|
510
510
|
|
|
511
511
|
##### Parameters
|
|
512
512
|
|
|
513
|
-
| Name | Type
|
|
514
|
-
| ---------- |
|
|
515
|
-
| namespaces | `
|
|
513
|
+
| Name | Type | Description |
|
|
514
|
+
| ---------- | ------------- | ------------------------------------------------------------------------ |
|
|
515
|
+
| namespaces | `Namespace[]` | The namespaces of Azure Resource Manager libraries used in this provider |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure-tools/typespec-azure-resource-manager",
|
|
3
|
-
"version": "0.40.0-dev.
|
|
3
|
+
"version": "0.40.0-dev.7",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "TypeSpec Azure Resource Manager library",
|
|
6
6
|
"homepage": "https://azure.github.io/typespec-azure",
|