@azure-tools/typespec-azure-resource-manager 0.62.0-dev.3 → 0.62.0-dev.5
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 +51 -24
- package/dist/generated-defs/Azure.ResourceManager.Private.d.ts +42 -0
- package/dist/generated-defs/Azure.ResourceManager.Private.d.ts.map +1 -1
- package/dist/generated-defs/Azure.ResourceManager.d.ts +26 -12
- package/dist/generated-defs/Azure.ResourceManager.d.ts.map +1 -1
- package/dist/src/linter.d.ts.map +1 -1
- package/dist/src/linter.js +2 -0
- package/dist/src/linter.js.map +1 -1
- package/dist/src/operations.d.ts +30 -3
- package/dist/src/operations.d.ts.map +1 -1
- package/dist/src/operations.js +97 -28
- package/dist/src/operations.js.map +1 -1
- package/dist/src/private.decorators.d.ts.map +1 -1
- package/dist/src/private.decorators.js +177 -3
- package/dist/src/private.decorators.js.map +1 -1
- package/dist/src/resource.d.ts +30 -16
- package/dist/src/resource.d.ts.map +1 -1
- package/dist/src/resource.js +75 -89
- package/dist/src/resource.js.map +1 -1
- package/dist/src/rules/secret-prop.d.ts +4 -0
- package/dist/src/rules/secret-prop.d.ts.map +1 -0
- package/dist/src/rules/secret-prop.js +57 -0
- package/dist/src/rules/secret-prop.js.map +1 -0
- package/dist/src/tsp-index.d.ts.map +1 -1
- package/dist/src/tsp-index.js +2 -1
- package/dist/src/tsp-index.js.map +1 -1
- package/lib/decorators.tsp +45 -12
- package/lib/extension/operations.tsp +116 -31
- package/lib/legacy-types/extension-operations.tsp +31 -10
- package/lib/legacy-types/extension.tsp +51 -24
- package/lib/legacy-types/operations.tsp +61 -26
- package/lib/legacy-types/resource.tsp +25 -3
- package/lib/operations.tsp +1 -0
- package/lib/private-endpoints.tsp +69 -113
- package/lib/private-links.tsp +17 -7
- package/lib/private.decorators.tsp +88 -0
- package/package.json +1 -1
|
@@ -12,12 +12,14 @@ using Rest;
|
|
|
12
12
|
* @template TargetParameters The path parameters for the target resource
|
|
13
13
|
* @template ExtensionParentParameters Parent parameters of the extension resource
|
|
14
14
|
* @template ExtensionInstanceParameters The instance parameters of the extension resource
|
|
15
|
+
* @template ResourceName Optional. The name of the resource type at this scope in clients.
|
|
15
16
|
*/
|
|
16
17
|
@doc("")
|
|
17
18
|
interface ExtensionOperations<
|
|
18
19
|
TargetParameters extends {},
|
|
19
20
|
ExtensionParentParameters extends {},
|
|
20
|
-
ExtensionInstanceParameters extends {}
|
|
21
|
+
ExtensionInstanceParameters extends {},
|
|
22
|
+
ResourceName extends valueof string = string("")
|
|
21
23
|
> {
|
|
22
24
|
/**
|
|
23
25
|
* A long-running resource CreateOrUpdate (PUT)
|
|
@@ -29,10 +31,11 @@ interface ExtensionOperations<
|
|
|
29
31
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
30
32
|
* @template OperationOptions Optional. The route options for the operation.
|
|
31
33
|
* @template Request Optional. The request body for the createOrUpdate operation.
|
|
34
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
32
35
|
*/
|
|
33
36
|
@armOperationRoute(OperationOptions)
|
|
34
37
|
@doc("Create a {name}", Resource)
|
|
35
|
-
@
|
|
38
|
+
@legacyExtensionResourceOperation(Resource, "createOrUpdate", OverrideResourceName)
|
|
36
39
|
@Azure.Core.Foundations.Private.defaultFinalStateVia(#["location", "azure-async-operation"])
|
|
37
40
|
@put
|
|
38
41
|
CreateOrUpdateAsync<
|
|
@@ -47,7 +50,8 @@ interface ExtensionOperations<
|
|
|
47
50
|
OptionalRequestBody extends valueof boolean = false,
|
|
48
51
|
ErrorType extends {} = ErrorResponse,
|
|
49
52
|
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
50
|
-
Request extends {} | void = Resource
|
|
53
|
+
Request extends {} | void = Resource,
|
|
54
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
51
55
|
>(
|
|
52
56
|
...TargetParameters,
|
|
53
57
|
...ExtensionInstanceParameters,
|
|
@@ -64,11 +68,12 @@ interface ExtensionOperations<
|
|
|
64
68
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
65
69
|
* @template OperationOptions Optional. The route options for the operation.
|
|
66
70
|
* @template Request Optional. The request body for the createOrUpdate operation.
|
|
71
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
67
72
|
*/
|
|
68
73
|
#suppress "@azure-tools/typespec-azure-core/no-private-usage"
|
|
69
74
|
@armOperationRoute(OperationOptions)
|
|
70
75
|
@doc("Create a {name}", Resource)
|
|
71
|
-
@
|
|
76
|
+
@legacyExtensionResourceOperation(Resource, "createOrUpdate", OverrideResourceName)
|
|
72
77
|
@put
|
|
73
78
|
CreateOrUpdateSync<
|
|
74
79
|
Resource extends Foundations.SimpleResource,
|
|
@@ -77,7 +82,8 @@ interface ExtensionOperations<
|
|
|
77
82
|
OptionalRequestBody extends valueof boolean = false,
|
|
78
83
|
ErrorType extends {} = ErrorResponse,
|
|
79
84
|
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
80
|
-
Request extends {} | void = Resource
|
|
85
|
+
Request extends {} | void = Resource,
|
|
86
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
81
87
|
>(
|
|
82
88
|
...TargetParameters,
|
|
83
89
|
...ExtensionInstanceParameters,
|
|
@@ -95,10 +101,11 @@ interface ExtensionOperations<
|
|
|
95
101
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
96
102
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
97
103
|
* @template OperationOptions Optional. The route options for the operation.
|
|
104
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
98
105
|
*/
|
|
99
106
|
@armOperationRoute(OperationOptions)
|
|
100
107
|
@doc("Update a {name}", Resource)
|
|
101
|
-
@
|
|
108
|
+
@legacyExtensionResourceOperation(Resource, "update", OverrideResourceName)
|
|
102
109
|
@patch(#{ implicitOptionality: false })
|
|
103
110
|
CustomPatchAsync<
|
|
104
111
|
Resource extends Foundations.SimpleResource,
|
|
@@ -116,7 +123,8 @@ interface ExtensionOperations<
|
|
|
116
123
|
>,
|
|
117
124
|
OptionalRequestBody extends valueof boolean = false,
|
|
118
125
|
ErrorType extends {} = ErrorResponse,
|
|
119
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
126
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
127
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
120
128
|
>(
|
|
121
129
|
...TargetParameters,
|
|
122
130
|
...ExtensionInstanceParameters,
|
|
@@ -133,10 +141,11 @@ interface ExtensionOperations<
|
|
|
133
141
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
134
142
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
135
143
|
* @template OperationOptions Optional. The route options for the operation.
|
|
144
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
136
145
|
*/
|
|
137
146
|
@armOperationRoute(OperationOptions)
|
|
138
147
|
@doc("Update a {name}", Resource)
|
|
139
|
-
@
|
|
148
|
+
@legacyExtensionResourceOperation(Resource, "update", OverrideResourceName)
|
|
140
149
|
@patch(#{ implicitOptionality: false })
|
|
141
150
|
CustomPatchSync<
|
|
142
151
|
Resource extends Foundations.SimpleResource,
|
|
@@ -145,7 +154,8 @@ interface ExtensionOperations<
|
|
|
145
154
|
Response extends {} = ArmResponse<Resource>,
|
|
146
155
|
OptionalRequestBody extends valueof boolean = false,
|
|
147
156
|
ErrorType extends {} = ErrorResponse,
|
|
148
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
157
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
158
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
149
159
|
>(
|
|
150
160
|
...TargetParameters,
|
|
151
161
|
...ExtensionInstanceParameters,
|
|
@@ -161,13 +171,14 @@ interface ExtensionOperations<
|
|
|
161
171
|
* @template Response Optional. The success response(s) for the delete operation
|
|
162
172
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
163
173
|
* @template OperationOptions Optional. The route options for the operation.
|
|
174
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
164
175
|
*/
|
|
165
176
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
|
|
166
177
|
@armOperationRoute(OperationOptions)
|
|
167
178
|
@doc("Delete a {name}", Resource)
|
|
168
179
|
@delete
|
|
169
180
|
@deletesResource(Resource)
|
|
170
|
-
@
|
|
181
|
+
@legacyExtensionResourceOperation(Resource, "delete", OverrideResourceName)
|
|
171
182
|
DeleteWithoutOkAsync<
|
|
172
183
|
Resource extends Foundations.SimpleResource,
|
|
173
184
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
|
|
@@ -175,7 +186,8 @@ interface ExtensionOperations<
|
|
|
175
186
|
Parameters extends {} = {},
|
|
176
187
|
Response extends {} = ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
177
188
|
ErrorType extends {} = ErrorResponse,
|
|
178
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
189
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
190
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
179
191
|
>(...TargetParameters, ...ExtensionInstanceParameters, ...Parameters): Response | ErrorType;
|
|
180
192
|
|
|
181
193
|
/**
|
|
@@ -185,19 +197,21 @@ interface ExtensionOperations<
|
|
|
185
197
|
* @template Response Optional. The success response(s) for the delete operation
|
|
186
198
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
187
199
|
* @template OperationOptions Optional. The route options for the operation.
|
|
200
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
188
201
|
*/
|
|
189
202
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
|
|
190
203
|
@armOperationRoute(OperationOptions)
|
|
191
204
|
@doc("Delete a {name}", Resource)
|
|
192
205
|
@delete
|
|
193
206
|
@deletesResource(Resource)
|
|
194
|
-
@
|
|
207
|
+
@legacyExtensionResourceOperation(Resource, "delete", OverrideResourceName)
|
|
195
208
|
DeleteSync<
|
|
196
209
|
Resource extends Foundations.SimpleResource,
|
|
197
210
|
Parameters extends {} = {},
|
|
198
211
|
Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse,
|
|
199
212
|
ErrorType extends {} = ErrorResponse,
|
|
200
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
213
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
214
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
201
215
|
>(...TargetParameters, ...ExtensionInstanceParameters, ...Parameters): Response | ErrorType;
|
|
202
216
|
|
|
203
217
|
/**
|
|
@@ -207,18 +221,20 @@ interface ExtensionOperations<
|
|
|
207
221
|
* @template Response Optional. The success response for a get operation.
|
|
208
222
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
209
223
|
* @template OperationOptions Optional. The route options for the operation.
|
|
224
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
210
225
|
*/
|
|
211
226
|
@armOperationRoute(OperationOptions)
|
|
212
227
|
@doc("Get a {name}", Resource)
|
|
213
228
|
@get
|
|
214
229
|
@readsResource(Resource)
|
|
215
|
-
@
|
|
230
|
+
@legacyExtensionResourceOperation(Resource, "read", OverrideResourceName)
|
|
216
231
|
Read<
|
|
217
232
|
Resource extends Foundations.SimpleResource,
|
|
218
233
|
Parameters extends {} = {},
|
|
219
234
|
Response extends {} = ArmResponse<Resource>,
|
|
220
235
|
ErrorType extends {} = ErrorResponse,
|
|
221
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
236
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
237
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
222
238
|
>(...TargetParameters, ...ExtensionInstanceParameters, ...Parameters): Response | ErrorType;
|
|
223
239
|
|
|
224
240
|
/**
|
|
@@ -228,16 +244,19 @@ interface ExtensionOperations<
|
|
|
228
244
|
* @template Response Optional. The success response for a head operation (by default NoContent or NotFound response).
|
|
229
245
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
230
246
|
* @template OperationOptions Optional. The route options for the operation.
|
|
247
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
231
248
|
*/
|
|
232
249
|
@armOperationRoute(OperationOptions)
|
|
233
250
|
@doc("Check for the existence of a {name}", Resource)
|
|
251
|
+
@legacyExtensionResourceOperation(Resource, "checkExistence", OverrideResourceName)
|
|
234
252
|
@head
|
|
235
253
|
CheckExistence<
|
|
236
254
|
Resource extends Foundations.SimpleResource,
|
|
237
255
|
Parameters extends {} = {},
|
|
238
256
|
Response extends {} = ArmResourceExistsResponse | ArmResourceNotFoundResponse,
|
|
239
257
|
ErrorType extends {} = ErrorResponse,
|
|
240
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
258
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
259
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
241
260
|
> is Foundations.ArmReadOperation<
|
|
242
261
|
TargetParameters & ExtensionInstanceParameters & Parameters,
|
|
243
262
|
Response,
|
|
@@ -250,19 +269,21 @@ interface ExtensionOperations<
|
|
|
250
269
|
* @template Response Optional. The response returned by the list
|
|
251
270
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
252
271
|
* @template OperationOptions Optional. The route options for the operation.
|
|
272
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
253
273
|
*/
|
|
254
274
|
@armOperationRoute(OperationOptions)
|
|
255
275
|
@doc("List a {name}", Resource)
|
|
256
276
|
@get
|
|
257
277
|
@list
|
|
258
278
|
@listsResource(Resource)
|
|
259
|
-
@
|
|
279
|
+
@legacyExtensionResourceOperation(Resource, "list", OverrideResourceName)
|
|
260
280
|
List<
|
|
261
281
|
Resource extends Foundations.SimpleResource,
|
|
262
282
|
Parameters extends {} = {},
|
|
263
283
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
264
284
|
ErrorType extends {} = ErrorResponse,
|
|
265
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
285
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
286
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
266
287
|
>(...TargetParameters, ...ExtensionParentParameters, ...Parameters): Response | ErrorType;
|
|
267
288
|
|
|
268
289
|
/**
|
|
@@ -272,18 +293,20 @@ interface ExtensionOperations<
|
|
|
272
293
|
* @template Response Optional. The response returned by the list
|
|
273
294
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
274
295
|
* @template OperationOptions Optional. The route options for the operation.
|
|
296
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
275
297
|
*/
|
|
276
298
|
@armOperationRoute(OperationOptions)
|
|
277
299
|
@doc("List a {name}", Resource)
|
|
278
300
|
@get
|
|
279
301
|
@listsResource(Resource)
|
|
280
|
-
@
|
|
302
|
+
@legacyExtensionResourceOperation(Resource, "list", OverrideResourceName)
|
|
281
303
|
ListSinglePage<
|
|
282
304
|
Resource extends Foundations.SimpleResource,
|
|
283
305
|
Parameters extends {} = {},
|
|
284
306
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
285
307
|
ErrorType extends {} = ErrorResponse,
|
|
286
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
308
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
309
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
287
310
|
>(...TargetParameters, ...ExtensionParentParameters, ...Parameters): Response | ErrorType;
|
|
288
311
|
|
|
289
312
|
/**
|
|
@@ -295,10 +318,11 @@ interface ExtensionOperations<
|
|
|
295
318
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
296
319
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
297
320
|
* @template OperationOptions Optional. The route options for the operation.
|
|
321
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
298
322
|
*/
|
|
299
323
|
@doc("")
|
|
300
324
|
@armOperationRoute(OperationOptions)
|
|
301
|
-
@
|
|
325
|
+
@legacyExtensionResourceOperation(Resource, "action", OverrideResourceName)
|
|
302
326
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
303
327
|
@post
|
|
304
328
|
@returnsDoc("Azure operation completed successfully.")
|
|
@@ -309,7 +333,8 @@ interface ExtensionOperations<
|
|
|
309
333
|
Parameters extends {} = {},
|
|
310
334
|
OptionalRequestBody extends valueof boolean = false,
|
|
311
335
|
ErrorType extends {} = ErrorResponse,
|
|
312
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
336
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
337
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
313
338
|
>(
|
|
314
339
|
...TargetParameters,
|
|
315
340
|
...ExtensionInstanceParameters,
|
|
@@ -331,11 +356,12 @@ interface ExtensionOperations<
|
|
|
331
356
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
332
357
|
* @template ErrorType Optional. The error response, if non-standard.
|
|
333
358
|
* @template OperationOptions Optional. The route options for the operation.
|
|
359
|
+
* @template OverrideResourceName Optional. The name of the resource type at this scope in clients.
|
|
334
360
|
*/
|
|
335
361
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "ARM"
|
|
336
362
|
@doc("")
|
|
337
363
|
@armOperationRoute(OperationOptions)
|
|
338
|
-
@
|
|
364
|
+
@legacyExtensionResourceOperation(Resource, "action", OverrideResourceName)
|
|
339
365
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
340
366
|
@post
|
|
341
367
|
@returnsDoc("Azure operation completed successfully.")
|
|
@@ -356,7 +382,8 @@ interface ExtensionOperations<
|
|
|
356
382
|
> | Result,
|
|
357
383
|
OptionalRequestBody extends valueof boolean = false,
|
|
358
384
|
ErrorType extends {} = ErrorResponse,
|
|
359
|
-
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
385
|
+
OperationOptions extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
386
|
+
OverrideResourceName extends valueof string = "${ResourceName}"
|
|
360
387
|
>(
|
|
361
388
|
...TargetParameters,
|
|
362
389
|
...ExtensionInstanceParameters,
|
|
@@ -14,12 +14,20 @@ using Rest;
|
|
|
14
14
|
* @template ParentParameters The path parameters for the resource parent
|
|
15
15
|
* @template ResourceTypeParameter The path parameter for the resource name
|
|
16
16
|
* @template ErrorType Optional. The type of error models used in operations created form this template
|
|
17
|
+
* @template ResourceName Optional. The name of the resource type described in this template
|
|
17
18
|
*/
|
|
18
19
|
interface LegacyOperations<
|
|
19
20
|
ParentParameters extends {},
|
|
20
21
|
ResourceTypeParameter extends {},
|
|
21
|
-
ErrorType extends {} = ErrorResponse
|
|
22
|
-
|
|
22
|
+
ErrorType extends {} = ErrorResponse,
|
|
23
|
+
ResourceName extends valueof string = string("")
|
|
24
|
+
>
|
|
25
|
+
extends RoutedOperations<
|
|
26
|
+
ParentParameters,
|
|
27
|
+
ResourceTypeParameter,
|
|
28
|
+
ErrorType,
|
|
29
|
+
RoutedResourceName = ResourceName
|
|
30
|
+
> {}
|
|
23
31
|
|
|
24
32
|
/**
|
|
25
33
|
* An operation template used to build resource operations in which the same resource type
|
|
@@ -28,13 +36,15 @@ interface LegacyOperations<
|
|
|
28
36
|
* @template ResourceTypeParameter The path parameter for the resource name
|
|
29
37
|
* @template ErrorType Optional. The type of error models used in operations created form this template
|
|
30
38
|
* @template ResourceRoute Optional. The resource route to use for operations in the interface.
|
|
39
|
+
* @template RoutedResourceName Optional. The name of the resource type described in this template
|
|
31
40
|
*/
|
|
32
41
|
@doc("")
|
|
33
42
|
interface RoutedOperations<
|
|
34
43
|
ParentParameters extends {},
|
|
35
44
|
ResourceTypeParameter extends {},
|
|
36
45
|
ErrorType extends {} = ErrorResponse,
|
|
37
|
-
ResourceRoute extends valueof ArmOperationOptions = #{ useStaticRoute: false }
|
|
46
|
+
ResourceRoute extends valueof ArmOperationOptions = #{ useStaticRoute: false },
|
|
47
|
+
RoutedResourceName extends valueof string = string("")
|
|
38
48
|
> {
|
|
39
49
|
/**
|
|
40
50
|
* A long-running resource CreateOrUpdate (PUT)
|
|
@@ -46,10 +56,11 @@ interface RoutedOperations<
|
|
|
46
56
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
47
57
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
48
58
|
* @template Request Optional. The request body for the createOrUpdate operation.
|
|
59
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
49
60
|
*/
|
|
50
61
|
@doc("Create a {name}", Resource)
|
|
51
62
|
@armOperationRoute(OverrideRouteOptions)
|
|
52
|
-
@
|
|
63
|
+
@legacyResourceOperation(Resource, "createOrUpdate", OverrideResourceName)
|
|
53
64
|
@Private.armUpdateProviderNamespace
|
|
54
65
|
@Azure.Core.Foundations.Private.defaultFinalStateVia(#["location", "azure-async-operation"])
|
|
55
66
|
@put
|
|
@@ -65,7 +76,8 @@ interface RoutedOperations<
|
|
|
65
76
|
OptionalRequestBody extends valueof boolean = false,
|
|
66
77
|
OverrideErrorType extends {} = ErrorType,
|
|
67
78
|
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
68
|
-
Request extends {} | void = Resource
|
|
79
|
+
Request extends {} | void = Resource,
|
|
80
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
69
81
|
>(
|
|
70
82
|
...ParentParameters,
|
|
71
83
|
...ResourceTypeParameter,
|
|
@@ -82,11 +94,12 @@ interface RoutedOperations<
|
|
|
82
94
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
83
95
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
84
96
|
* @template Request Optional. The request body for the createOrUpdate operation.
|
|
97
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
85
98
|
*/
|
|
86
99
|
#suppress "@azure-tools/typespec-azure-core/no-private-usage"
|
|
87
100
|
@armOperationRoute(OverrideRouteOptions)
|
|
88
101
|
@doc("Create a {name}", Resource)
|
|
89
|
-
@
|
|
102
|
+
@legacyResourceOperation(Resource, "createOrUpdate", OverrideResourceName)
|
|
90
103
|
@Private.armUpdateProviderNamespace
|
|
91
104
|
@put
|
|
92
105
|
CreateOrUpdateSync<
|
|
@@ -96,7 +109,8 @@ interface RoutedOperations<
|
|
|
96
109
|
OptionalRequestBody extends valueof boolean = false,
|
|
97
110
|
OverrideErrorType extends {} = ErrorType,
|
|
98
111
|
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
99
|
-
Request extends {} | void = Resource
|
|
112
|
+
Request extends {} | void = Resource,
|
|
113
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
100
114
|
>(
|
|
101
115
|
...ParentParameters,
|
|
102
116
|
...ResourceTypeParameter,
|
|
@@ -114,10 +128,11 @@ interface RoutedOperations<
|
|
|
114
128
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
115
129
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
116
130
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
131
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
117
132
|
*/
|
|
118
133
|
@doc("Update a {name}", Resource)
|
|
119
134
|
@armOperationRoute(OverrideRouteOptions)
|
|
120
|
-
@
|
|
135
|
+
@legacyResourceOperation(Resource, "update", OverrideResourceName)
|
|
121
136
|
@Private.armUpdateProviderNamespace
|
|
122
137
|
@patch(#{ implicitOptionality: false })
|
|
123
138
|
CustomPatchAsync<
|
|
@@ -136,7 +151,8 @@ interface RoutedOperations<
|
|
|
136
151
|
>,
|
|
137
152
|
OptionalRequestBody extends valueof boolean = false,
|
|
138
153
|
OverrideErrorType extends {} = ErrorType,
|
|
139
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
154
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
155
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
140
156
|
>(
|
|
141
157
|
...ParentParameters,
|
|
142
158
|
...ResourceTypeParameter,
|
|
@@ -153,10 +169,11 @@ interface RoutedOperations<
|
|
|
153
169
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
154
170
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
155
171
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
172
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
156
173
|
*/
|
|
157
174
|
@doc("Update a {name}", Resource)
|
|
158
175
|
@armOperationRoute(OverrideRouteOptions)
|
|
159
|
-
@
|
|
176
|
+
@legacyResourceOperation(Resource, "update", OverrideResourceName)
|
|
160
177
|
@Private.armUpdateProviderNamespace
|
|
161
178
|
@patch(#{ implicitOptionality: false })
|
|
162
179
|
CustomPatchSync<
|
|
@@ -166,7 +183,8 @@ interface RoutedOperations<
|
|
|
166
183
|
Response extends {} = ArmResponse<Resource>,
|
|
167
184
|
OptionalRequestBody extends valueof boolean = false,
|
|
168
185
|
OverrideErrorType extends {} = ErrorType,
|
|
169
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
186
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
187
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
170
188
|
>(
|
|
171
189
|
...ParentParameters,
|
|
172
190
|
...ResourceTypeParameter,
|
|
@@ -182,6 +200,7 @@ interface RoutedOperations<
|
|
|
182
200
|
* @template Response Optional. The success response(s) for the delete operation
|
|
183
201
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
184
202
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
203
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
185
204
|
*/
|
|
186
205
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
|
|
187
206
|
@doc("Delete a {name}", Resource)
|
|
@@ -189,7 +208,7 @@ interface RoutedOperations<
|
|
|
189
208
|
@delete
|
|
190
209
|
@deletesResource(Resource)
|
|
191
210
|
@Private.armUpdateProviderNamespace
|
|
192
|
-
@
|
|
211
|
+
@legacyResourceOperation(Resource, "delete", OverrideResourceName)
|
|
193
212
|
DeleteWithoutOkAsync<
|
|
194
213
|
Resource extends Foundations.SimpleResource,
|
|
195
214
|
LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
|
|
@@ -197,7 +216,8 @@ interface RoutedOperations<
|
|
|
197
216
|
Parameters extends {} = {},
|
|
198
217
|
Response extends {} = ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
199
218
|
OverrideErrorType extends {} = ErrorType,
|
|
200
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
219
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
220
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
201
221
|
>(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
|
|
202
222
|
|
|
203
223
|
/**
|
|
@@ -207,20 +227,22 @@ interface RoutedOperations<
|
|
|
207
227
|
* @template Response Optional. The success response(s) for the delete operation
|
|
208
228
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
209
229
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
230
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
210
231
|
*/
|
|
211
232
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
|
|
212
233
|
@doc("Delete a {name}", Resource)
|
|
213
234
|
@armOperationRoute(OverrideRouteOptions)
|
|
214
235
|
@delete
|
|
215
236
|
@deletesResource(Resource)
|
|
216
|
-
@
|
|
237
|
+
@legacyResourceOperation(Resource, "delete", OverrideResourceName)
|
|
217
238
|
@Private.armUpdateProviderNamespace
|
|
218
239
|
DeleteSync<
|
|
219
240
|
Resource extends Foundations.SimpleResource,
|
|
220
241
|
Parameters extends {} = {},
|
|
221
242
|
Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse,
|
|
222
243
|
OverrideErrorType extends {} = ErrorType,
|
|
223
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
244
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
245
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
224
246
|
>(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
|
|
225
247
|
|
|
226
248
|
/**
|
|
@@ -230,19 +252,21 @@ interface RoutedOperations<
|
|
|
230
252
|
* @template Response Optional. The success response for a get operation.
|
|
231
253
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
232
254
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
255
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
233
256
|
*/
|
|
234
257
|
@doc("Get a {name}", Resource)
|
|
235
258
|
@armOperationRoute(OverrideRouteOptions)
|
|
236
259
|
@get
|
|
237
260
|
@readsResource(Resource)
|
|
238
|
-
@
|
|
261
|
+
@legacyResourceOperation(Resource, "read", OverrideResourceName)
|
|
239
262
|
@Private.armUpdateProviderNamespace
|
|
240
263
|
Read<
|
|
241
264
|
Resource extends Foundations.SimpleResource,
|
|
242
265
|
Parameters extends {} = {},
|
|
243
266
|
Response extends {} = ArmResponse<Resource>,
|
|
244
267
|
OverrideErrorType extends {} = ErrorType,
|
|
245
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
268
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
269
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
246
270
|
>(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
|
|
247
271
|
|
|
248
272
|
/**
|
|
@@ -252,8 +276,10 @@ interface RoutedOperations<
|
|
|
252
276
|
* @template Response Optional. The success response for a head operation (by default NoContent or NotFound response).
|
|
253
277
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
254
278
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
279
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
255
280
|
*/
|
|
256
281
|
@armOperationRoute(OverrideRouteOptions)
|
|
282
|
+
@legacyResourceOperation(Resource, "checkExistence", OverrideResourceName)
|
|
257
283
|
@doc("Check for the existence of a {name}", Resource)
|
|
258
284
|
@Private.armUpdateProviderNamespace
|
|
259
285
|
@head
|
|
@@ -262,7 +288,8 @@ interface RoutedOperations<
|
|
|
262
288
|
Parameters extends {} = {},
|
|
263
289
|
Response extends {} = ArmResourceExistsResponse | ArmResourceNotFoundResponse,
|
|
264
290
|
OverrideErrorType extends {} = ErrorType,
|
|
265
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
291
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
292
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
266
293
|
> is Foundations.ArmReadOperation<
|
|
267
294
|
ParentParameters & ResourceTypeParameter & Parameters,
|
|
268
295
|
Response,
|
|
@@ -276,6 +303,7 @@ interface RoutedOperations<
|
|
|
276
303
|
* @template Response Optional. The response returned by the list
|
|
277
304
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
278
305
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
306
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
279
307
|
*/
|
|
280
308
|
@segmentOf(ResourceTypeParameter)
|
|
281
309
|
@doc("List a {name}", Resource)
|
|
@@ -283,14 +311,15 @@ interface RoutedOperations<
|
|
|
283
311
|
@list
|
|
284
312
|
@listsResource(Resource)
|
|
285
313
|
@armOperationRoute(OverrideRouteOptions)
|
|
286
|
-
@
|
|
314
|
+
@legacyResourceOperation(Resource, "list", OverrideResourceName)
|
|
287
315
|
@Private.armUpdateProviderNamespace
|
|
288
316
|
List<
|
|
289
317
|
Resource extends Foundations.SimpleResource,
|
|
290
318
|
Parameters extends {} = {},
|
|
291
319
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
292
320
|
OverrideErrorType extends {} = ErrorType,
|
|
293
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
321
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
322
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
294
323
|
>(...ParentParameters, ...Parameters): Response | OverrideErrorType;
|
|
295
324
|
|
|
296
325
|
/**
|
|
@@ -300,20 +329,22 @@ interface RoutedOperations<
|
|
|
300
329
|
* @template Response Optional. The response returned by the list
|
|
301
330
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
302
331
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
332
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
303
333
|
*/
|
|
304
334
|
@segmentOf(ResourceTypeParameter)
|
|
305
335
|
@doc("List a {name}", Resource)
|
|
306
336
|
@get
|
|
307
337
|
@listsResource(Resource)
|
|
308
338
|
@armOperationRoute(OverrideRouteOptions)
|
|
309
|
-
@
|
|
339
|
+
@legacyResourceOperation(Resource, "list", OverrideResourceName)
|
|
310
340
|
@Private.armUpdateProviderNamespace
|
|
311
341
|
ListSinglePage<
|
|
312
342
|
Resource extends Foundations.SimpleResource,
|
|
313
343
|
Parameters extends {} = {},
|
|
314
344
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
315
345
|
OverrideErrorType extends {} = ErrorType,
|
|
316
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
346
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
347
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
317
348
|
>(...ParentParameters, ...Parameters): Response | OverrideErrorType;
|
|
318
349
|
|
|
319
350
|
/**
|
|
@@ -325,9 +356,10 @@ interface RoutedOperations<
|
|
|
325
356
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
326
357
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
327
358
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
359
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
328
360
|
*/
|
|
329
361
|
@doc("")
|
|
330
|
-
@
|
|
362
|
+
@legacyResourceOperation(Resource, "action", OverrideResourceName)
|
|
331
363
|
@armOperationRoute(OverrideRouteOptions)
|
|
332
364
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
333
365
|
@post
|
|
@@ -340,7 +372,8 @@ interface RoutedOperations<
|
|
|
340
372
|
Parameters extends {} = {},
|
|
341
373
|
OptionalRequestBody extends valueof boolean = false,
|
|
342
374
|
OverrideErrorType extends {} = ErrorType,
|
|
343
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
375
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
376
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
344
377
|
>(
|
|
345
378
|
...ParentParameters,
|
|
346
379
|
...ResourceTypeParameter,
|
|
@@ -362,10 +395,11 @@ interface RoutedOperations<
|
|
|
362
395
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
363
396
|
* @template OverrideErrorType Optional. The error response, if non-standard.
|
|
364
397
|
* @template OverrideRouteOptions Optional. The route options for the operation.
|
|
398
|
+
* @template OverrideResourceName Optional. The name of the resource type being acted upon.
|
|
365
399
|
*/
|
|
366
400
|
#suppress "@azure-tools/typespec-azure-core/no-response-body" "ARM"
|
|
367
401
|
@doc("")
|
|
368
|
-
@
|
|
402
|
+
@legacyResourceOperation(Resource, "action", OverrideResourceName)
|
|
369
403
|
@armOperationRoute(OverrideRouteOptions)
|
|
370
404
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
371
405
|
@Private.armUpdateProviderNamespace
|
|
@@ -388,7 +422,8 @@ interface RoutedOperations<
|
|
|
388
422
|
> | Result,
|
|
389
423
|
OptionalRequestBody extends valueof boolean = false,
|
|
390
424
|
OverrideErrorType extends {} = ErrorType,
|
|
391
|
-
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
|
|
425
|
+
OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute,
|
|
426
|
+
OverrideResourceName extends valueof string = "${RoutedResourceName}"
|
|
392
427
|
>(
|
|
393
428
|
...ParentParameters,
|
|
394
429
|
...ResourceTypeParameter,
|
|
@@ -91,6 +91,28 @@ model ExtendedLocationOptional {
|
|
|
91
91
|
@Http.Private.includeInapplicableMetadataInPayload(false)
|
|
92
92
|
model ResourceWithPathParameter {}
|
|
93
93
|
|
|
94
|
+
/**
|
|
95
|
+
* Model representing the `kind` envelope property only for use with a polymorphic resource..
|
|
96
|
+
* Spread this model into a resource model if the resource support ARM `kind`.
|
|
97
|
+
* @template Type The type of the kind property. Default is string. However you can pass a union with string values.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
*
|
|
101
|
+
* ```typespec
|
|
102
|
+
* model Foo is TrackedResource<FooProperties> {
|
|
103
|
+
* // Only have standard Succeeded, Failed, Cancelled states
|
|
104
|
+
* ...PolymorphicResourceKindProperty;
|
|
105
|
+
* }
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
@doc("The resource kind property envelope.")
|
|
109
|
+
model PolymorphicResourceKindProperty<Type extends string = string> {
|
|
110
|
+
@doc("Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.")
|
|
111
|
+
@pattern("^[-\\w\\._,\\(\\\\\\)]+$")
|
|
112
|
+
@visibility(Lifecycle.Read, Lifecycle.Create)
|
|
113
|
+
kind: Type;
|
|
114
|
+
}
|
|
115
|
+
|
|
94
116
|
/**
|
|
95
117
|
* Discriminated tracked resource types can be created by instantiating this type, with 'kind' as the discriminator property.
|
|
96
118
|
*
|
|
@@ -116,7 +138,7 @@ model DiscriminatedTrackedResource<
|
|
|
116
138
|
KindType extends string = string,
|
|
117
139
|
Description extends valueof string = "Polymorphic Tracked resource types can be created by instantiating this type, with 'kind' as the discriminator."
|
|
118
140
|
> extends Foundations.TrackedResource {
|
|
119
|
-
...
|
|
141
|
+
...PolymorphicResourceKindProperty<KindType>;
|
|
120
142
|
}
|
|
121
143
|
|
|
122
144
|
/**
|
|
@@ -144,7 +166,7 @@ model DiscriminatedProxyResource<
|
|
|
144
166
|
KindType extends string = string,
|
|
145
167
|
Description extends valueof string = "Polymorphic proxy resource types can be created by instantiating this type, using 'kind' as the discriminator property."
|
|
146
168
|
> extends Foundations.ProxyResource {
|
|
147
|
-
...
|
|
169
|
+
...PolymorphicResourceKindProperty<KindType>;
|
|
148
170
|
}
|
|
149
171
|
|
|
150
172
|
/**
|
|
@@ -173,5 +195,5 @@ model DiscriminatedExtensionResource<
|
|
|
173
195
|
KindType extends string = string,
|
|
174
196
|
Description extends valueof string = "Polymorphic extension resource types can be created by aliasing this type using a specific property type."
|
|
175
197
|
> extends Foundations.ExtensionResource {
|
|
176
|
-
...
|
|
198
|
+
...PolymorphicResourceKindProperty<KindType>;
|
|
177
199
|
}
|