@azure-tools/typespec-azure-resource-manager 0.67.0-dev.1 → 0.67.0-dev.10
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 +39 -38
- package/dist/generated-defs/Azure.ResourceManager.Private.d.ts +12 -0
- package/dist/generated-defs/Azure.ResourceManager.Private.d.ts.map +1 -1
- package/dist/generated-defs/Azure.ResourceManager.d.ts +3 -2
- package/dist/generated-defs/Azure.ResourceManager.d.ts.map +1 -1
- package/dist/src/private.decorators.d.ts +3 -2
- package/dist/src/private.decorators.d.ts.map +1 -1
- package/dist/src/private.decorators.js +68 -4
- package/dist/src/private.decorators.js.map +1 -1
- package/dist/src/resource.d.ts +9 -3
- package/dist/src/resource.d.ts.map +1 -1
- package/dist/src/resource.js +156 -20
- package/dist/src/resource.js.map +1 -1
- package/dist/src/rules/arm-common-types-version.d.ts.map +1 -1
- package/dist/src/rules/arm-common-types-version.js +1 -0
- package/dist/src/rules/arm-common-types-version.js.map +1 -1
- package/dist/src/rules/arm-custom-resource-no-key.js +1 -1
- package/dist/src/rules/arm-custom-resource-no-key.js.map +1 -1
- package/dist/src/rules/arm-custom-resource-usage-discourage.d.ts.map +1 -1
- package/dist/src/rules/arm-custom-resource-usage-discourage.js +1 -0
- package/dist/src/rules/arm-custom-resource-usage-discourage.js.map +1 -1
- package/dist/src/rules/arm-resource-action-no-segment.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-action-no-segment.js +1 -0
- package/dist/src/rules/arm-resource-action-no-segment.js.map +1 -1
- package/dist/src/rules/arm-resource-duplicate-property.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-duplicate-property.js +1 -0
- package/dist/src/rules/arm-resource-duplicate-property.js.map +1 -1
- package/dist/src/rules/arm-resource-interfaces.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-interfaces.js +1 -0
- package/dist/src/rules/arm-resource-interfaces.js.map +1 -1
- package/dist/src/rules/arm-resource-invalid-envelope-property.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-invalid-envelope-property.js +1 -0
- package/dist/src/rules/arm-resource-invalid-envelope-property.js.map +1 -1
- package/dist/src/rules/arm-resource-invalid-version-format.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-invalid-version-format.js +1 -0
- package/dist/src/rules/arm-resource-invalid-version-format.js.map +1 -1
- package/dist/src/rules/arm-resource-key-invalid-chars.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-key-invalid-chars.js +1 -0
- package/dist/src/rules/arm-resource-key-invalid-chars.js.map +1 -1
- package/dist/src/rules/arm-resource-operation-response.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-operation-response.js +1 -0
- package/dist/src/rules/arm-resource-operation-response.js.map +1 -1
- package/dist/src/rules/arm-resource-patch.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-patch.js +1 -0
- package/dist/src/rules/arm-resource-patch.js.map +1 -1
- package/dist/src/rules/arm-resource-path-invalid-chars.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-path-invalid-chars.js +1 -0
- package/dist/src/rules/arm-resource-path-invalid-chars.js.map +1 -1
- package/dist/src/rules/arm-resource-provisioning-state-rule.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-provisioning-state-rule.js +1 -0
- package/dist/src/rules/arm-resource-provisioning-state-rule.js.map +1 -1
- package/dist/src/rules/beyond-nesting-levels.d.ts.map +1 -1
- package/dist/src/rules/beyond-nesting-levels.js +1 -0
- package/dist/src/rules/beyond-nesting-levels.js.map +1 -1
- package/dist/src/rules/core-operations.d.ts.map +1 -1
- package/dist/src/rules/core-operations.js +1 -0
- package/dist/src/rules/core-operations.js.map +1 -1
- package/dist/src/rules/envelope-properties.d.ts.map +1 -1
- package/dist/src/rules/envelope-properties.js +1 -0
- package/dist/src/rules/envelope-properties.js.map +1 -1
- package/dist/src/rules/improper-subscription-list-operation.d.ts.map +1 -1
- package/dist/src/rules/improper-subscription-list-operation.js +1 -0
- package/dist/src/rules/improper-subscription-list-operation.js.map +1 -1
- package/dist/src/rules/operations-interface-missing.d.ts.map +1 -1
- package/dist/src/rules/operations-interface-missing.js +1 -0
- package/dist/src/rules/operations-interface-missing.js.map +1 -1
- package/dist/src/rules/patch-envelope-properties.d.ts.map +1 -1
- package/dist/src/rules/patch-envelope-properties.js +1 -0
- package/dist/src/rules/patch-envelope-properties.js.map +1 -1
- package/dist/src/rules/resource-name.d.ts.map +1 -1
- package/dist/src/rules/resource-name.js +1 -0
- package/dist/src/rules/resource-name.js.map +1 -1
- package/dist/src/rules/retry-after.d.ts.map +1 -1
- package/dist/src/rules/retry-after.js +1 -0
- package/dist/src/rules/retry-after.js.map +1 -1
- package/dist/src/state.d.ts +1 -0
- package/dist/src/state.d.ts.map +1 -1
- package/dist/src/state.js +1 -0
- package/dist/src/state.js.map +1 -1
- package/lib/decorators.tsp +3 -2
- package/lib/legacy-types/resource.tsp +34 -0
- package/lib/operations.tsp +178 -53
- package/lib/parameters.tsp +40 -4
- package/lib/private.decorators.tsp +12 -0
- package/lib/responses.tsp +4 -5
- package/package.json +3 -3
package/lib/operations.tsp
CHANGED
|
@@ -38,6 +38,7 @@ op ArmListBySubscription<
|
|
|
38
38
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
39
39
|
* @template Response Optional. The success response for the list operation
|
|
40
40
|
* @template Error Optional. The error response, if non-standard.
|
|
41
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
41
42
|
*/
|
|
42
43
|
@get
|
|
43
44
|
@autoRoute
|
|
@@ -54,9 +55,10 @@ op ArmResourceListByParent<
|
|
|
54
55
|
ParentFriendlyName extends valueof string = "",
|
|
55
56
|
Parameters extends {} = {},
|
|
56
57
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
57
|
-
Error extends {} = ErrorResponse
|
|
58
|
+
Error extends {} = ErrorResponse,
|
|
59
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
58
60
|
> is ArmReadOperation<
|
|
59
|
-
ResourceParentParameters<Resource, BaseParameters> & Parameters,
|
|
61
|
+
ResourceParentParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
60
62
|
Response,
|
|
61
63
|
Error
|
|
62
64
|
>;
|
|
@@ -68,6 +70,7 @@ op ArmResourceListByParent<
|
|
|
68
70
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
69
71
|
* @template Response Optional. The success response for the list operation
|
|
70
72
|
* @template Error Optional. The error response, if non-standard.
|
|
73
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
71
74
|
*/
|
|
72
75
|
@get
|
|
73
76
|
@autoRoute
|
|
@@ -82,9 +85,10 @@ op ArmResourceListAtScope<
|
|
|
82
85
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
83
86
|
Parameters extends {} = {},
|
|
84
87
|
Response extends {} = ArmResponse<ResourceListResult<Resource>>,
|
|
85
|
-
Error extends {} = ErrorResponse
|
|
88
|
+
Error extends {} = ErrorResponse,
|
|
89
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
86
90
|
> is ArmReadOperation<
|
|
87
|
-
ResourceParentParameters<Resource, BaseParameters> & Parameters,
|
|
91
|
+
ResourceParentParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
88
92
|
Response,
|
|
89
93
|
Error
|
|
90
94
|
>;
|
|
@@ -96,6 +100,7 @@ op ArmResourceListAtScope<
|
|
|
96
100
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
97
101
|
* @template Response Optional. The success response for the read operation
|
|
98
102
|
* @template Error Optional. The error response, if non-standard.
|
|
103
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
99
104
|
*/
|
|
100
105
|
@autoRoute
|
|
101
106
|
@doc("Get a {name}", Resource)
|
|
@@ -106,9 +111,10 @@ op ArmResourceRead<
|
|
|
106
111
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
107
112
|
Parameters extends {} = {},
|
|
108
113
|
Response extends {} = ArmResponse<Resource>,
|
|
109
|
-
Error extends {} = ErrorResponse
|
|
114
|
+
Error extends {} = ErrorResponse,
|
|
115
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
110
116
|
> is ArmReadOperation<
|
|
111
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
117
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
112
118
|
Response,
|
|
113
119
|
Error
|
|
114
120
|
>;
|
|
@@ -120,6 +126,7 @@ op ArmResourceRead<
|
|
|
120
126
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
121
127
|
* @template Response Optional. The success response for the read operation
|
|
122
128
|
* @template Error Optional. The error response, if non-standard.
|
|
129
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
123
130
|
*/
|
|
124
131
|
@autoRoute
|
|
125
132
|
@doc("Check for the existence of a {name}", Resource)
|
|
@@ -130,13 +137,50 @@ op ArmResourceCheckExistence<
|
|
|
130
137
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
131
138
|
Parameters extends {} = {},
|
|
132
139
|
Response extends {} = ArmResourceExistsResponse | ArmResourceNotFoundResponse,
|
|
133
|
-
Error extends {} = ErrorResponse
|
|
140
|
+
Error extends {} = ErrorResponse,
|
|
141
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
134
142
|
> is ArmReadOperation<
|
|
135
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
143
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
136
144
|
Response,
|
|
137
145
|
Error
|
|
138
146
|
>;
|
|
139
147
|
|
|
148
|
+
/**
|
|
149
|
+
* A resource GET operation template for an Azure Resource Manager Operation Status endpoint.
|
|
150
|
+
* The path is determined by the `Scope` parameter. Use one of the four standard scope models:
|
|
151
|
+
* - `TenantActionScope` (default): `GET /providers/{providerNamespace}/operationStatuses/{operationId}`
|
|
152
|
+
* - `SubscriptionActionScope`: `GET /subscriptions/{subscriptionId}/providers/{providerNamespace}/operationStatuses/{operationId}`
|
|
153
|
+
* - `TenantLocationActionScope`: `GET /providers/{providerNamespace}/locations/{location}/operationStatuses/{operationId}`
|
|
154
|
+
* - `SubscriptionLocationActionScope`: `GET /subscriptions/{subscriptionId}/providers/{providerNamespace}/locations/{location}/operationStatuses/{operationId}`
|
|
155
|
+
*
|
|
156
|
+
* @template Response The type of the response body. Defaults to ArmOperationStatus.
|
|
157
|
+
* @template Scope The scope of the operation. Defaults to TenantActionScope.
|
|
158
|
+
* @template Parameters Optional. Additional non-path parameters (e.g. query or header parameters).
|
|
159
|
+
* @template Error Optional. The error response, if non-standard.
|
|
160
|
+
*/
|
|
161
|
+
@autoRoute
|
|
162
|
+
@doc("Get the status of an async operation.")
|
|
163
|
+
@get
|
|
164
|
+
@armResourceCollectionAction
|
|
165
|
+
@Private.armUpdateProviderNamespace
|
|
166
|
+
op GetResourceOperationStatus<
|
|
167
|
+
Response extends {} = ArmOperationStatus,
|
|
168
|
+
Scope extends {} = TenantActionScope,
|
|
169
|
+
Parameters extends {} = {},
|
|
170
|
+
Error extends {} = ErrorResponse
|
|
171
|
+
>(
|
|
172
|
+
...Azure.ResourceManager.Foundations.DefaultBaseParameters<Scope>,
|
|
173
|
+
...ProviderNamespace<Scope>,
|
|
174
|
+
...Scope,
|
|
175
|
+
|
|
176
|
+
@path
|
|
177
|
+
@segment("operationStatuses")
|
|
178
|
+
@doc("The operation ID.")
|
|
179
|
+
operationId: string,
|
|
180
|
+
|
|
181
|
+
...Parameters,
|
|
182
|
+
): ArmResponse<Response> | Error;
|
|
183
|
+
|
|
140
184
|
/**
|
|
141
185
|
* A long-running resource CreateOrUpdate (PUT)
|
|
142
186
|
* @template Resource the resource being created or updated
|
|
@@ -145,6 +189,7 @@ op ArmResourceCheckExistence<
|
|
|
145
189
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
146
190
|
* @template Response Optional. The success response for the createOrUpdate operation
|
|
147
191
|
* @template Error Optional. The error response, if non-standard.
|
|
192
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
148
193
|
*/
|
|
149
194
|
@autoRoute
|
|
150
195
|
@doc("Create a {name}", Resource)
|
|
@@ -162,9 +207,10 @@ op ArmResourceCreateOrUpdateAsync<
|
|
|
162
207
|
Resource,
|
|
163
208
|
LroHeaders
|
|
164
209
|
>,
|
|
165
|
-
Error extends {} = ErrorResponse
|
|
210
|
+
Error extends {} = ErrorResponse,
|
|
211
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
166
212
|
> is ArmCreateOperation<
|
|
167
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
213
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
168
214
|
Resource,
|
|
169
215
|
Response,
|
|
170
216
|
Error
|
|
@@ -177,6 +223,7 @@ op ArmResourceCreateOrUpdateAsync<
|
|
|
177
223
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
178
224
|
* @template Response Optional. The success response for the createOrUpdate operation
|
|
179
225
|
* @template Error Optional. The error response, if non-standard.
|
|
226
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
180
227
|
*/
|
|
181
228
|
#deprecated "Please use ArmResourceCreateOrReplaceSync instead"
|
|
182
229
|
@autoRoute
|
|
@@ -189,9 +236,10 @@ op ArmResourceCreateOrUpdateSync<
|
|
|
189
236
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
190
237
|
Parameters extends {} = {},
|
|
191
238
|
Response extends {} = ArmResponse<Resource>,
|
|
192
|
-
Error extends {} = ErrorResponse
|
|
239
|
+
Error extends {} = ErrorResponse,
|
|
240
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
193
241
|
> is ArmCreateOperation<
|
|
194
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
242
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
195
243
|
Resource,
|
|
196
244
|
Response,
|
|
197
245
|
Error
|
|
@@ -204,6 +252,7 @@ op ArmResourceCreateOrUpdateSync<
|
|
|
204
252
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
205
253
|
* @template Response Optional. The success response for the createOrUpdate operation
|
|
206
254
|
* @template Error Optional. The error response, if non-standard.
|
|
255
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
207
256
|
*/
|
|
208
257
|
@autoRoute
|
|
209
258
|
@doc("Create a {name}", Resource)
|
|
@@ -215,9 +264,10 @@ op ArmResourceCreateOrReplaceSync<
|
|
|
215
264
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
216
265
|
Parameters extends {} = {},
|
|
217
266
|
Response extends {} = ArmResourceUpdatedResponse<Resource> | ArmResourceCreatedSyncResponse<Resource>,
|
|
218
|
-
Error extends {} = ErrorResponse
|
|
267
|
+
Error extends {} = ErrorResponse,
|
|
268
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
219
269
|
> is ArmCreateOperation<
|
|
220
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
270
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
221
271
|
Resource,
|
|
222
272
|
Response,
|
|
223
273
|
Error
|
|
@@ -231,6 +281,7 @@ op ArmResourceCreateOrReplaceSync<
|
|
|
231
281
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
232
282
|
* @template Response Optional. The success response for the createOrReplace operation
|
|
233
283
|
* @template Error Optional. The error response, if non-standard.
|
|
284
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
234
285
|
*/
|
|
235
286
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
236
287
|
op ArmResourceCreateOrReplaceAsync<
|
|
@@ -243,14 +294,16 @@ op ArmResourceCreateOrReplaceAsync<
|
|
|
243
294
|
Resource,
|
|
244
295
|
LroHeaders
|
|
245
296
|
>,
|
|
246
|
-
Error extends {} = ErrorResponse
|
|
297
|
+
Error extends {} = ErrorResponse,
|
|
298
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
247
299
|
> is ArmResourceCreateOrUpdateAsync<
|
|
248
300
|
Resource,
|
|
249
301
|
BaseParameters,
|
|
250
302
|
LroHeaders,
|
|
251
303
|
Parameters,
|
|
252
304
|
Response,
|
|
253
|
-
Error
|
|
305
|
+
Error,
|
|
306
|
+
Provider
|
|
254
307
|
>;
|
|
255
308
|
|
|
256
309
|
/**
|
|
@@ -260,6 +313,7 @@ op ArmResourceCreateOrReplaceAsync<
|
|
|
260
313
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
261
314
|
* @template LroHeaders Optional. Allows overriding the lro headers that appear in the Accepted response
|
|
262
315
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
316
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
263
317
|
*/
|
|
264
318
|
@patch(#{ implicitOptionality: true })
|
|
265
319
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -273,13 +327,17 @@ op ArmTagsPatchAsync<
|
|
|
273
327
|
string
|
|
274
328
|
> &
|
|
275
329
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
276
|
-
Parameters extends {} = {}
|
|
330
|
+
Parameters extends {} = {},
|
|
331
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
277
332
|
> is ArmCustomPatchAsync<
|
|
278
333
|
Resource,
|
|
279
334
|
TagsUpdateModel<Resource>,
|
|
280
335
|
BaseParameters,
|
|
281
336
|
LroHeaders,
|
|
282
|
-
Parameters
|
|
337
|
+
Parameters,
|
|
338
|
+
ArmResponse<Resource> | ArmAcceptedLroResponse<"Resource update request accepted.", LroHeaders>,
|
|
339
|
+
ErrorResponse,
|
|
340
|
+
Provider
|
|
283
341
|
>;
|
|
284
342
|
|
|
285
343
|
/**
|
|
@@ -289,6 +347,7 @@ op ArmTagsPatchAsync<
|
|
|
289
347
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
290
348
|
* @template LroHeaders Optional. Allows overriding the lro headers returned in the Accepted response
|
|
291
349
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
350
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
292
351
|
*/
|
|
293
352
|
@patch(#{ implicitOptionality: true })
|
|
294
353
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -302,8 +361,18 @@ op ArmResourcePatchAsync<
|
|
|
302
361
|
string
|
|
303
362
|
> &
|
|
304
363
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
305
|
-
Parameters extends {} = {}
|
|
306
|
-
|
|
364
|
+
Parameters extends {} = {},
|
|
365
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
366
|
+
> is ArmCustomPatchAsync<
|
|
367
|
+
Resource,
|
|
368
|
+
Resource,
|
|
369
|
+
BaseParameters,
|
|
370
|
+
LroHeaders,
|
|
371
|
+
Parameters,
|
|
372
|
+
ArmResponse<Resource> | ArmAcceptedLroResponse<"Resource update request accepted.", LroHeaders>,
|
|
373
|
+
ErrorResponse,
|
|
374
|
+
Provider
|
|
375
|
+
>;
|
|
307
376
|
|
|
308
377
|
/**
|
|
309
378
|
* A long-running resource update using a custom PATCH payload (Asynchronous)
|
|
@@ -314,6 +383,7 @@ op ArmResourcePatchAsync<
|
|
|
314
383
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
315
384
|
* @template Response Optional. The success response for the patch operation
|
|
316
385
|
* @template Error Optional. The error response, if non-standard.
|
|
386
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
317
387
|
*/
|
|
318
388
|
@autoRoute
|
|
319
389
|
@doc("Update a {name}", Resource)
|
|
@@ -335,9 +405,10 @@ op ArmCustomPatchAsync<
|
|
|
335
405
|
"Resource update request accepted.",
|
|
336
406
|
LroHeaders
|
|
337
407
|
>,
|
|
338
|
-
Error extends {} = ErrorResponse
|
|
408
|
+
Error extends {} = ErrorResponse,
|
|
409
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
339
410
|
> is ArmUpdateOperation<
|
|
340
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
411
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
341
412
|
PatchModel,
|
|
342
413
|
Response,
|
|
343
414
|
Error
|
|
@@ -348,14 +419,24 @@ op ArmCustomPatchAsync<
|
|
|
348
419
|
* @template Resource the resource being patched
|
|
349
420
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
350
421
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
422
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
351
423
|
*/
|
|
352
424
|
@patch(#{ implicitOptionality: true })
|
|
353
425
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
354
426
|
op ArmTagsPatchSync<
|
|
355
427
|
Resource extends Foundations.SimpleResource,
|
|
356
428
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
357
|
-
Parameters extends {} = {}
|
|
358
|
-
|
|
429
|
+
Parameters extends {} = {},
|
|
430
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
431
|
+
> is ArmCustomPatchSync<
|
|
432
|
+
Resource,
|
|
433
|
+
TagsUpdateModel<Resource>,
|
|
434
|
+
BaseParameters,
|
|
435
|
+
Parameters,
|
|
436
|
+
ArmResponse<Resource>,
|
|
437
|
+
ErrorResponse,
|
|
438
|
+
Provider
|
|
439
|
+
>;
|
|
359
440
|
|
|
360
441
|
/**
|
|
361
442
|
* @dev A resource update using the items from the resource marked with Lifecycle.Update visibility
|
|
@@ -363,6 +444,7 @@ op ArmTagsPatchSync<
|
|
|
363
444
|
* @template Properties The model type of the resource properties
|
|
364
445
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
365
446
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
447
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
366
448
|
*/
|
|
367
449
|
@patch(#{ implicitOptionality: true })
|
|
368
450
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -370,8 +452,17 @@ op ArmResourcePatchSync<
|
|
|
370
452
|
Resource extends Foundations.SimpleResource,
|
|
371
453
|
Properties extends TypeSpec.Reflection.Model,
|
|
372
454
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
373
|
-
Parameters extends {} = {}
|
|
374
|
-
|
|
455
|
+
Parameters extends {} = {},
|
|
456
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
457
|
+
> is ArmCustomPatchSync<
|
|
458
|
+
Resource,
|
|
459
|
+
Resource,
|
|
460
|
+
BaseParameters,
|
|
461
|
+
Parameters,
|
|
462
|
+
ArmResponse<Resource>,
|
|
463
|
+
ErrorResponse,
|
|
464
|
+
Provider
|
|
465
|
+
>;
|
|
375
466
|
|
|
376
467
|
/**
|
|
377
468
|
* A resource update using a custom PATCH payload (synchronous)
|
|
@@ -381,6 +472,7 @@ op ArmResourcePatchSync<
|
|
|
381
472
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
382
473
|
* @template Response Optional. The success response for the patch operation
|
|
383
474
|
* @template Error Optional. The error response, if non-standard.
|
|
475
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
384
476
|
*/
|
|
385
477
|
@autoRoute
|
|
386
478
|
@doc("Update a {name}", Resource)
|
|
@@ -393,9 +485,10 @@ op ArmCustomPatchSync<
|
|
|
393
485
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
394
486
|
Parameters extends {} = {},
|
|
395
487
|
Response extends {} = ArmResponse<Resource>,
|
|
396
|
-
Error extends {} = ErrorResponse
|
|
488
|
+
Error extends {} = ErrorResponse,
|
|
489
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
397
490
|
> is ArmUpdateOperation<
|
|
398
|
-
ResourceInstanceParameters<Resource, BaseParameters> & Parameters,
|
|
491
|
+
ResourceInstanceParameters<Resource, BaseParameters, Provider> & Parameters,
|
|
399
492
|
PatchModel,
|
|
400
493
|
Response,
|
|
401
494
|
Error
|
|
@@ -408,6 +501,7 @@ op ArmCustomPatchSync<
|
|
|
408
501
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
409
502
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
410
503
|
* @template Error Optional. The error response, if non-standard.
|
|
504
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
411
505
|
*/
|
|
412
506
|
@autoRoute
|
|
413
507
|
@doc("Delete a {name}", Resource)
|
|
@@ -419,8 +513,12 @@ op ArmResourceDeleteAsyncBase<
|
|
|
419
513
|
Response,
|
|
420
514
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
421
515
|
Parameters extends {} = {},
|
|
422
|
-
Error extends {} = ErrorResponse
|
|
423
|
-
|
|
516
|
+
Error extends {} = ErrorResponse,
|
|
517
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
518
|
+
>(
|
|
519
|
+
...ResourceInstanceParameters<Resource, BaseParameters, Provider>,
|
|
520
|
+
...Parameters,
|
|
521
|
+
): Response | Error;
|
|
424
522
|
|
|
425
523
|
/**
|
|
426
524
|
* @dev Delete a resource asynchronously. DEPRECATED: Use ArmResourceDeleteWithoutOkAsync instead
|
|
@@ -430,6 +528,7 @@ op ArmResourceDeleteAsyncBase<
|
|
|
430
528
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
431
529
|
* @template Response Optional. The success response(s) for the delete operation
|
|
432
530
|
* @template Error Optional. The error response, if non-standard.
|
|
531
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
433
532
|
*/
|
|
434
533
|
#deprecated "Use 'ArmResourceDeleteWithoutOkAsync' instead"
|
|
435
534
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -440,8 +539,9 @@ op ArmResourceDeleteAsync<
|
|
|
440
539
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
441
540
|
Parameters extends {} = {},
|
|
442
541
|
Response extends {} = ArmDeletedResponse | ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
443
|
-
Error extends {} = ErrorResponse
|
|
444
|
-
|
|
542
|
+
Error extends {} = ErrorResponse,
|
|
543
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
544
|
+
> is ArmResourceDeleteAsyncBase<Resource, Response, BaseParameters, Parameters, Error, Provider>;
|
|
445
545
|
|
|
446
546
|
/**
|
|
447
547
|
* @dev Delete a resource asynchronously
|
|
@@ -451,6 +551,7 @@ op ArmResourceDeleteAsync<
|
|
|
451
551
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
452
552
|
* @template Response Optional. The success response(s) for the delete operation
|
|
453
553
|
* @template Error Optional. The error response, if non-standard.
|
|
554
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
454
555
|
*/
|
|
455
556
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
456
557
|
op ArmResourceDeleteWithoutOkAsync<
|
|
@@ -460,8 +561,9 @@ op ArmResourceDeleteWithoutOkAsync<
|
|
|
460
561
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
461
562
|
Parameters extends {} = {},
|
|
462
563
|
Response extends {} = ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
|
|
463
|
-
Error extends {} = ErrorResponse
|
|
464
|
-
|
|
564
|
+
Error extends {} = ErrorResponse,
|
|
565
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
566
|
+
> is ArmResourceDeleteAsyncBase<Resource, Response, BaseParameters, Parameters, Error, Provider>;
|
|
465
567
|
|
|
466
568
|
/**
|
|
467
569
|
* Delete a resource synchronously
|
|
@@ -470,6 +572,7 @@ op ArmResourceDeleteWithoutOkAsync<
|
|
|
470
572
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
471
573
|
* @template Response Optional. The success response(s) for the delete operation
|
|
472
574
|
* @template Error Optional. The error response, if non-standard.
|
|
575
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
473
576
|
*/
|
|
474
577
|
@autoRoute
|
|
475
578
|
@doc("Delete a {name}", Resource)
|
|
@@ -481,8 +584,12 @@ op ArmResourceDeleteSync<
|
|
|
481
584
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
482
585
|
Parameters extends {} = {},
|
|
483
586
|
Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse,
|
|
484
|
-
Error = ErrorResponse
|
|
485
|
-
|
|
587
|
+
Error = ErrorResponse,
|
|
588
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
589
|
+
>(
|
|
590
|
+
...ResourceInstanceParameters<Resource, BaseParameters, Provider>,
|
|
591
|
+
...Parameters,
|
|
592
|
+
): Response | Error;
|
|
486
593
|
|
|
487
594
|
/**
|
|
488
595
|
* A long-running resource action.
|
|
@@ -493,6 +600,7 @@ op ArmResourceDeleteSync<
|
|
|
493
600
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
494
601
|
* @template Error Optional. The error response, if non-standard.
|
|
495
602
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional.
|
|
603
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
496
604
|
*/
|
|
497
605
|
@autoRoute
|
|
498
606
|
@armResourceAction(Resource)
|
|
@@ -505,9 +613,10 @@ op ArmResourceActionAsyncBase<
|
|
|
505
613
|
BaseParameters extends TypeSpec.Reflection.Model,
|
|
506
614
|
Parameters extends {} = {},
|
|
507
615
|
Error extends {} = ErrorResponse,
|
|
508
|
-
OptionalRequestBody extends valueof boolean = false
|
|
616
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
617
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
509
618
|
>(
|
|
510
|
-
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
619
|
+
...ResourceInstanceParameters<Resource, BaseParameters, Provider>,
|
|
511
620
|
...Parameters,
|
|
512
621
|
|
|
513
622
|
@doc("The content of the action request")
|
|
@@ -525,6 +634,7 @@ op ArmResourceActionAsyncBase<
|
|
|
525
634
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
526
635
|
* @template Error Optional. The error response, if non-standard.
|
|
527
636
|
* @template OptionalRequestBody Optional. Indicates whether the body parameter is optional.
|
|
637
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
528
638
|
*/
|
|
529
639
|
@returnsDoc("Azure operation completed successfully.")
|
|
530
640
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -541,7 +651,8 @@ op ArmResourceActionAsync<
|
|
|
541
651
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
542
652
|
Parameters extends {} = {},
|
|
543
653
|
Error extends {} = ErrorResponse,
|
|
544
|
-
OptionalRequestBody extends valueof boolean = false
|
|
654
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
655
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
545
656
|
> is ArmResourceActionAsyncBase<
|
|
546
657
|
Resource,
|
|
547
658
|
Request,
|
|
@@ -549,7 +660,8 @@ op ArmResourceActionAsync<
|
|
|
549
660
|
BaseParameters,
|
|
550
661
|
Parameters,
|
|
551
662
|
Error,
|
|
552
|
-
OptionalRequestBody
|
|
663
|
+
OptionalRequestBody,
|
|
664
|
+
Provider
|
|
553
665
|
>;
|
|
554
666
|
|
|
555
667
|
/**
|
|
@@ -562,6 +674,7 @@ op ArmResourceActionAsync<
|
|
|
562
674
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
563
675
|
* @template Error Optional. The error response, if non-standard.
|
|
564
676
|
* @template OptionalRequestBody Optional. Indicates whether the body parameter is optional.
|
|
677
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
565
678
|
*/
|
|
566
679
|
@returnsDoc("Azure operation completed successfully.")
|
|
567
680
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
@@ -578,7 +691,8 @@ op ActionAsync<
|
|
|
578
691
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
579
692
|
Parameters extends {} = {},
|
|
580
693
|
Error extends {} = ErrorResponse,
|
|
581
|
-
OptionalRequestBody extends valueof boolean = false
|
|
694
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
695
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
582
696
|
> is ArmResourceActionAsyncBase<
|
|
583
697
|
Resource,
|
|
584
698
|
Request,
|
|
@@ -586,7 +700,8 @@ op ActionAsync<
|
|
|
586
700
|
BaseParameters,
|
|
587
701
|
Parameters,
|
|
588
702
|
Error,
|
|
589
|
-
OptionalRequestBody
|
|
703
|
+
OptionalRequestBody,
|
|
704
|
+
Provider
|
|
590
705
|
>;
|
|
591
706
|
|
|
592
707
|
/**
|
|
@@ -598,6 +713,7 @@ op ActionAsync<
|
|
|
598
713
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
599
714
|
* @template Error Optional. The error response, if non-standard.
|
|
600
715
|
* @template OptionalRequestBody Optional. Indicates whether the body parameter is optional.
|
|
716
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
601
717
|
*/
|
|
602
718
|
@autoRoute
|
|
603
719
|
@armResourceAction(Resource)
|
|
@@ -611,9 +727,10 @@ op ArmResourceActionSync<
|
|
|
611
727
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
612
728
|
Parameters extends {} = {},
|
|
613
729
|
Error extends {} = ErrorResponse,
|
|
614
|
-
OptionalRequestBody extends valueof boolean = false
|
|
730
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
731
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
615
732
|
>(
|
|
616
|
-
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
733
|
+
...ResourceInstanceParameters<Resource, BaseParameters, Provider>,
|
|
617
734
|
...Parameters,
|
|
618
735
|
|
|
619
736
|
@doc("The content of the action request")
|
|
@@ -630,6 +747,7 @@ op ArmResourceActionSync<
|
|
|
630
747
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
631
748
|
* @template Error Optional. The error response, if non-standard.
|
|
632
749
|
* @template OptionalRequestBody Optional. Indicates whether the body parameter is optional.
|
|
750
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
633
751
|
*/
|
|
634
752
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
635
753
|
op ArmResourceActionNoContentAsync<
|
|
@@ -640,7 +758,8 @@ op ArmResourceActionNoContentAsync<
|
|
|
640
758
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
641
759
|
Parameters extends {} = {},
|
|
642
760
|
Error extends {} = ErrorResponse,
|
|
643
|
-
OptionalRequestBody extends valueof boolean = false
|
|
761
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
762
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
644
763
|
> is ArmResourceActionAsyncBase<
|
|
645
764
|
Resource,
|
|
646
765
|
Request,
|
|
@@ -651,7 +770,8 @@ op ArmResourceActionNoContentAsync<
|
|
|
651
770
|
BaseParameters,
|
|
652
771
|
Parameters,
|
|
653
772
|
Error,
|
|
654
|
-
OptionalRequestBody
|
|
773
|
+
OptionalRequestBody,
|
|
774
|
+
Provider
|
|
655
775
|
>;
|
|
656
776
|
|
|
657
777
|
/**
|
|
@@ -663,6 +783,7 @@ op ArmResourceActionNoContentAsync<
|
|
|
663
783
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
664
784
|
* @template Error Optional. The error response, if non-standard.
|
|
665
785
|
* @template OptionalRequestBody Optional. Indicates whether the body parameter is optional.
|
|
786
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
666
787
|
*/
|
|
667
788
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
668
789
|
op ArmResourceActionNoResponseContentAsync<
|
|
@@ -677,7 +798,8 @@ op ArmResourceActionNoResponseContentAsync<
|
|
|
677
798
|
Azure.Core.Foundations.RetryAfterHeader,
|
|
678
799
|
Parameters extends {} = {},
|
|
679
800
|
Error extends {} = ErrorResponse,
|
|
680
|
-
OptionalRequestBody extends valueof boolean = false
|
|
801
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
802
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
681
803
|
> is ArmResourceActionAsyncBase<
|
|
682
804
|
Resource,
|
|
683
805
|
Request,
|
|
@@ -685,7 +807,8 @@ op ArmResourceActionNoResponseContentAsync<
|
|
|
685
807
|
BaseParameters,
|
|
686
808
|
Parameters,
|
|
687
809
|
Error,
|
|
688
|
-
OptionalRequestBody
|
|
810
|
+
OptionalRequestBody,
|
|
811
|
+
Provider
|
|
689
812
|
>;
|
|
690
813
|
|
|
691
814
|
/**
|
|
@@ -696,6 +819,7 @@ op ArmResourceActionNoResponseContentAsync<
|
|
|
696
819
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
697
820
|
* @template Error Optional. The error response, if non-standard.
|
|
698
821
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional.
|
|
822
|
+
* @template Provider Optional. The provider namespace model for the resource.
|
|
699
823
|
*/
|
|
700
824
|
@autoRoute
|
|
701
825
|
@armResourceAction(Resource)
|
|
@@ -707,9 +831,10 @@ op ArmResourceActionNoContentSync<
|
|
|
707
831
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
708
832
|
Parameters extends {} = {},
|
|
709
833
|
Error extends {} = ErrorResponse,
|
|
710
|
-
OptionalRequestBody extends valueof boolean = false
|
|
834
|
+
OptionalRequestBody extends valueof boolean = false,
|
|
835
|
+
Provider extends {} = ProviderNamespace<Resource>
|
|
711
836
|
>(
|
|
712
|
-
...ResourceInstanceParameters<Resource, BaseParameters>,
|
|
837
|
+
...ResourceInstanceParameters<Resource, BaseParameters, Provider>,
|
|
713
838
|
...Parameters,
|
|
714
839
|
|
|
715
840
|
@doc("The content of the action request")
|
|
@@ -771,8 +896,8 @@ op checkLocalNameAvailability<
|
|
|
771
896
|
@armResourceCollectionAction
|
|
772
897
|
@Private.armUpdateProviderNamespace
|
|
773
898
|
op ArmProviderActionSync<
|
|
774
|
-
Request extends {} | void = void,
|
|
775
|
-
Response extends {} | void = void,
|
|
899
|
+
Request extends {} | unknown | void = void,
|
|
900
|
+
Response extends {} | unknown | void = void,
|
|
776
901
|
Scope extends {} = TenantActionScope,
|
|
777
902
|
Parameters extends {} = {},
|
|
778
903
|
Error extends {} = ErrorResponse,
|
|
@@ -802,7 +927,7 @@ op ArmProviderActionSync<
|
|
|
802
927
|
@armResourceCollectionAction
|
|
803
928
|
@Private.armUpdateProviderNamespace
|
|
804
929
|
op ArmProviderActionAsync<
|
|
805
|
-
Request extends {} | void = void,
|
|
930
|
+
Request extends {} | unknown | void = void,
|
|
806
931
|
Response extends TypeSpec.Reflection.Model | unknown | void = void,
|
|
807
932
|
Scope extends {} = TenantActionScope,
|
|
808
933
|
Parameters extends {} = {},
|