@azure-tools/typespec-azure-resource-manager 0.70.0-dev.1 → 0.70.0-dev.3
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 +42 -10
- package/dist/generated-defs/Azure.ResourceManager.d.ts +34 -24
- package/dist/generated-defs/Azure.ResourceManager.d.ts.map +1 -1
- package/lib/common-types/nsp-operations.tsp +5 -5
- package/lib/common-types/types.tsp +2 -3
- package/lib/decorators.tsp +40 -11
- package/lib/extension/operations.tsp +8 -6
- package/lib/foundations/arm.foundations.tsp +22 -11
- package/lib/interfaces.tsp +24 -14
- package/lib/legacy-types/extension.tsp +1 -1
- package/lib/legacy-types/operations.tsp +9 -5
- package/lib/legacy-types/private-endpoints.tsp +4 -4
- package/lib/models.tsp +1 -1
- package/lib/operations.tsp +31 -19
- package/lib/private-endpoints.tsp +9 -9
- package/lib/private-links.tsp +3 -3
- package/lib/responses.tsp +17 -12
- package/package.json +4 -4
package/lib/interfaces.tsp
CHANGED
|
@@ -13,7 +13,7 @@ namespace Azure.ResourceManager;
|
|
|
13
13
|
*/
|
|
14
14
|
interface Operations {
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* List the operations for the provider.
|
|
17
17
|
*/
|
|
18
18
|
@tag("Operations")
|
|
19
19
|
@autoRoute
|
|
@@ -146,9 +146,10 @@ interface ResourceCollectionOperations<
|
|
|
146
146
|
*/
|
|
147
147
|
interface ResourceListBySubscription<Resource extends Foundations.SimpleResource> {
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* List resources by subscription.
|
|
150
150
|
* @template Resource The ArmResource to list.
|
|
151
151
|
*/
|
|
152
|
+
@doc("List {name} resources by subscription ID", Resource)
|
|
152
153
|
listBySubscription is ArmListBySubscription<Resource>;
|
|
153
154
|
}
|
|
154
155
|
|
|
@@ -166,7 +167,7 @@ interface ResourceListByParent<
|
|
|
166
167
|
ParentFriendlyName extends valueof string = ""
|
|
167
168
|
> {
|
|
168
169
|
/**
|
|
169
|
-
*
|
|
170
|
+
* List resources by parent.
|
|
170
171
|
* @template Resource The ArmResource to list.
|
|
171
172
|
* @template BaseParameters The http parameters that are part of the request
|
|
172
173
|
* @template ParentName The name of the parent resource
|
|
@@ -186,10 +187,11 @@ interface ResourceRead<
|
|
|
186
187
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
187
188
|
> {
|
|
188
189
|
/**
|
|
189
|
-
*
|
|
190
|
+
* Retrieve a resource.
|
|
190
191
|
* @template Resource The ArmResource to retrieve.
|
|
191
192
|
* @template BaseParameters The http parameters that are part of the request
|
|
192
193
|
*/
|
|
194
|
+
@doc("Get a {name}", Resource)
|
|
193
195
|
get is ArmResourceRead<Resource, BaseParameters>;
|
|
194
196
|
}
|
|
195
197
|
|
|
@@ -203,10 +205,11 @@ interface ResourceCreateSync<
|
|
|
203
205
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
204
206
|
> {
|
|
205
207
|
/**
|
|
206
|
-
*
|
|
208
|
+
* Create or update a resource using the synchronous call pattern.
|
|
207
209
|
* @template Resource The ArmResource to create or update.
|
|
208
210
|
* @template BaseParameters The http parameters that are part of the request
|
|
209
211
|
*/
|
|
212
|
+
@doc("Create a {name}", Resource)
|
|
210
213
|
createOrUpdate is ArmResourceCreateOrReplaceSync<Resource, BaseParameters>;
|
|
211
214
|
}
|
|
212
215
|
|
|
@@ -220,15 +223,16 @@ interface ResourceCreateAsync<
|
|
|
220
223
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
221
224
|
> {
|
|
222
225
|
/**
|
|
223
|
-
*
|
|
226
|
+
* Create or update a resource using the asynchronous call pattern.
|
|
224
227
|
* @template Resource The ArmResource to create or update.
|
|
225
228
|
* @template BaseParameters The http parameters that are part of the request
|
|
226
229
|
*/
|
|
230
|
+
@doc("Create a {name}", Resource)
|
|
227
231
|
createOrUpdate is ArmResourceCreateOrUpdateAsync<Resource, BaseParameters>;
|
|
228
232
|
}
|
|
229
233
|
|
|
230
234
|
/**
|
|
231
|
-
*
|
|
235
|
+
* A composite interface for resources that include a long-running delete operation.
|
|
232
236
|
* DEPRECATED: Use ResourceDeleteWithoutOkAsync instead
|
|
233
237
|
* @template Resource The ArmResource that provides these operations
|
|
234
238
|
* @template BaseParameters The http parameters that are part of the request
|
|
@@ -240,15 +244,17 @@ interface ResourceDeleteAsync<
|
|
|
240
244
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
241
245
|
> {
|
|
242
246
|
/**
|
|
243
|
-
*
|
|
247
|
+
* Delete a resource using the asynchronous call pattern.
|
|
244
248
|
* @template Resource The ArmResource to delete.
|
|
245
249
|
* @template BaseParameters The http parameters that are part of the request
|
|
246
250
|
*/
|
|
251
|
+
@doc("Delete a {name}", Resource)
|
|
247
252
|
delete is ArmResourceDeleteAsync<Resource, BaseParameters>;
|
|
248
253
|
}
|
|
249
254
|
|
|
250
255
|
/**
|
|
251
|
-
*
|
|
256
|
+
* A composite interface for resources that include a long-running delete operation
|
|
257
|
+
* without returning a final OK response.
|
|
252
258
|
* @template Resource The ArmResource that provides these operations
|
|
253
259
|
* @template BaseParameters The http parameters that are part of the request
|
|
254
260
|
*/
|
|
@@ -258,10 +264,11 @@ interface ResourceDeleteWithoutOkAsync<
|
|
|
258
264
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
259
265
|
> {
|
|
260
266
|
/**
|
|
261
|
-
*
|
|
267
|
+
* Delete a resource using the asynchronous call pattern.
|
|
262
268
|
* @template Resource The ArmResource to delete.
|
|
263
269
|
* @template BaseParameters The http parameters that are part of the request
|
|
264
270
|
*/
|
|
271
|
+
@doc("Delete a {name}", Resource)
|
|
265
272
|
delete is ArmResourceDeleteWithoutOkAsync<Resource, BaseParameters>;
|
|
266
273
|
}
|
|
267
274
|
|
|
@@ -276,15 +283,16 @@ interface ResourceDeleteSync<
|
|
|
276
283
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
277
284
|
> {
|
|
278
285
|
/**
|
|
279
|
-
*
|
|
286
|
+
* Delete a resource using the synchronous call pattern.
|
|
280
287
|
* @template Resource The ArmResource to delete.
|
|
281
288
|
* @template BaseParameters The http parameters that are part of the request
|
|
282
289
|
*/
|
|
290
|
+
@doc("Delete a {name}", Resource)
|
|
283
291
|
delete is ArmResourceDeleteSync<Resource, BaseParameters>;
|
|
284
292
|
}
|
|
285
293
|
|
|
286
294
|
/**
|
|
287
|
-
*
|
|
295
|
+
* A composite interface for resources that include a long-running update operation.
|
|
288
296
|
* @template Resource The ArmResource that provides these operations
|
|
289
297
|
* @template Properties RP-specific property bag for the resource
|
|
290
298
|
* @template BaseParameters The http parameters that are part of the request
|
|
@@ -296,11 +304,12 @@ interface ResourceUpdateAsync<
|
|
|
296
304
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
297
305
|
> {
|
|
298
306
|
/**
|
|
299
|
-
*
|
|
307
|
+
* Update a resource using the asynchronous call pattern.
|
|
300
308
|
* @template Resource The ArmResource to update.
|
|
301
309
|
* @template Properties RP-specific property bag for the resource
|
|
302
310
|
* @template BaseParameters The http parameters that are part of the request
|
|
303
311
|
*/
|
|
312
|
+
@doc("Update a {name}", Resource)
|
|
304
313
|
update is ArmCustomPatchAsync<
|
|
305
314
|
Resource,
|
|
306
315
|
ResourceUpdateModel<Resource, Properties>,
|
|
@@ -321,13 +330,14 @@ interface ResourceUpdateSync<
|
|
|
321
330
|
BaseParameters = DefaultBaseParameters<Resource>
|
|
322
331
|
> {
|
|
323
332
|
/**
|
|
324
|
-
*
|
|
333
|
+
* Update a resource using the synchronous call pattern.
|
|
325
334
|
* @template Resource The ArmResource to update.
|
|
326
335
|
* @template Properties RP-specific property bag for the resource
|
|
327
336
|
* @template BaseParameters The http parameters that are part of the request
|
|
328
337
|
*/
|
|
329
338
|
#suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
|
|
330
339
|
@patch(#{ implicitOptionality: true })
|
|
340
|
+
@doc("Update a {name}", Resource)
|
|
331
341
|
update is ArmCustomPatchSync<Resource, ResourceUpdateModel<Resource, Properties>, BaseParameters>;
|
|
332
342
|
}
|
|
333
343
|
|
|
@@ -215,7 +215,7 @@ interface ExtensionOperations<
|
|
|
215
215
|
>(...TargetParameters, ...ExtensionInstanceParameters, ...Parameters): Response | ErrorType;
|
|
216
216
|
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* Get a resource
|
|
219
219
|
* @template Resource The resource being read
|
|
220
220
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
221
221
|
* @template Response Optional. The success response for a get operation.
|
|
@@ -246,7 +246,7 @@ interface RoutedOperations<
|
|
|
246
246
|
>(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
|
|
247
247
|
|
|
248
248
|
/**
|
|
249
|
-
*
|
|
249
|
+
* Get a resource
|
|
250
250
|
* @template Resource The resource being read
|
|
251
251
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
252
252
|
* @template Response Optional. The success response for a get operation.
|
|
@@ -434,17 +434,19 @@ interface RoutedOperations<
|
|
|
434
434
|
): Response | OverrideErrorType;
|
|
435
435
|
}
|
|
436
436
|
/**
|
|
437
|
-
*
|
|
437
|
+
* DEPRECATED: Use ProviderParameter instead. Get the provider namespace key-value pair
|
|
438
438
|
* @template Resource Optional. The resource to get the provider namespace for.
|
|
439
439
|
*/
|
|
440
|
+
@doc("")
|
|
440
441
|
model Provider<Resource extends {} = TenantActionScope> {
|
|
441
442
|
...ProviderNamespace<Resource>;
|
|
442
443
|
}
|
|
443
444
|
|
|
444
445
|
/**
|
|
445
|
-
*
|
|
446
|
+
* Get the provider namespace key-value pair
|
|
446
447
|
* @template Resource The resource to get the provider namespace for.
|
|
447
448
|
*/
|
|
449
|
+
@doc("")
|
|
448
450
|
model ProviderParameter<Resource extends {}> {
|
|
449
451
|
...ProviderNamespace<Resource>;
|
|
450
452
|
}
|
|
@@ -709,13 +711,14 @@ op ArmListSinglePageByParent<
|
|
|
709
711
|
>;
|
|
710
712
|
|
|
711
713
|
/**
|
|
712
|
-
*
|
|
714
|
+
* The base template for Azure Resource Manager PUT Operations.
|
|
713
715
|
* @template HttpParameters The parameter object for the operation.
|
|
714
716
|
* @template BodyParameter The body parameter
|
|
715
717
|
* @template Response The response or union of responses for success.
|
|
716
718
|
* @template ErrorResponse The error response.
|
|
717
719
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
718
720
|
*/
|
|
721
|
+
@doc("")
|
|
719
722
|
op CreateOperation<
|
|
720
723
|
HttpParameters extends {},
|
|
721
724
|
BodyParameter extends {} | void,
|
|
@@ -731,13 +734,14 @@ op CreateOperation<
|
|
|
731
734
|
): Response | ErrorResponse;
|
|
732
735
|
|
|
733
736
|
/**
|
|
734
|
-
*
|
|
737
|
+
* The base template for Legacy Azure Resource Manager PATCH Operations.
|
|
735
738
|
* @template HttpParameters The parameter object for the operation.
|
|
736
739
|
* @template BodyParameter The body parameter
|
|
737
740
|
* @template Response The response or union of responses for success.
|
|
738
741
|
* @template ErrorResponse The error response.
|
|
739
742
|
* @template OptionalRequestBody Optional. Indicates whether the request body is optional
|
|
740
743
|
*/
|
|
744
|
+
@doc("")
|
|
741
745
|
op UpdateOperation<
|
|
742
746
|
HttpParameters extends {},
|
|
743
747
|
BodyParameter extends {} | void,
|
|
@@ -8,7 +8,7 @@ using Azure.ResourceManager.Foundations;
|
|
|
8
8
|
using Rest;
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* List the private endpoint connections over a resource
|
|
12
12
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
13
13
|
* @template Resource Optional. The PrivateEndpointConnection resource being listed
|
|
14
14
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -39,7 +39,7 @@ op ListSinglePageByParent<
|
|
|
39
39
|
>;
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Synchronous PUT operation for a Private endpoint connection to a resource
|
|
43
43
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
44
44
|
* @template Resource the PrivateEndpointConnection resource being created or updated
|
|
45
45
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -76,7 +76,7 @@ op CreateOrReplaceSync<
|
|
|
76
76
|
>;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource
|
|
80
80
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
81
81
|
* @template Resource the PrivateEndpointConnection resource being created or updated
|
|
82
82
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -161,7 +161,7 @@ op CustomPatchAsync<
|
|
|
161
161
|
>;
|
|
162
162
|
|
|
163
163
|
/**
|
|
164
|
-
*
|
|
164
|
+
* A resource update using a custom PATCH payload (synchronous) to update a PrivateEndpointConnection to a resource
|
|
165
165
|
* @template ParentResource The parent resource of the PrivateEndpointConnection
|
|
166
166
|
* @template Resource Optional. The PrivateEndpointConnection resource being patched
|
|
167
167
|
* @template PatchModel The input model for the PATCH request
|
package/lib/models.tsp
CHANGED
|
@@ -340,7 +340,7 @@ model ResourceKindProperty<Type extends string = string> {
|
|
|
340
340
|
model ResourceListResult<Resource extends Foundations.SimpleResource> is Azure.Core.Page<Resource>;
|
|
341
341
|
|
|
342
342
|
/**
|
|
343
|
-
* Paged response containing
|
|
343
|
+
* Paged response containing custom result types.
|
|
344
344
|
* @template Result The type of the values returned in the paged response
|
|
345
345
|
*/
|
|
346
346
|
@doc("The custom response of a list operation.")
|
package/lib/operations.tsp
CHANGED
|
@@ -302,7 +302,7 @@ op ArmResourceCreateOrReplaceSync<
|
|
|
302
302
|
>;
|
|
303
303
|
|
|
304
304
|
/**
|
|
305
|
-
*
|
|
305
|
+
* A long-running resource CreateOrUpdate (PUT)
|
|
306
306
|
* @template Resource the resource being created or replaced
|
|
307
307
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
308
308
|
* @template LroHeaders Optional. Allows overriding the lro headers returned on resource create
|
|
@@ -311,6 +311,7 @@ op ArmResourceCreateOrReplaceSync<
|
|
|
311
311
|
* @template Error Optional. The error response, if non-standard.
|
|
312
312
|
* @template Provider Optional. The provider namespace model for the resource.
|
|
313
313
|
*/
|
|
314
|
+
@doc("Create a {name}", Resource)
|
|
314
315
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
315
316
|
op ArmResourceCreateOrReplaceAsync<
|
|
316
317
|
Resource extends Foundations.SimpleResource,
|
|
@@ -334,7 +335,7 @@ op ArmResourceCreateOrReplaceAsync<
|
|
|
334
335
|
>;
|
|
335
336
|
|
|
336
337
|
/**
|
|
337
|
-
*
|
|
338
|
+
* A long-running resource update that only allows updating resource tags (the minimum)
|
|
338
339
|
* @template Resource the resource being patched
|
|
339
340
|
* @template Properties Optional. Exists for parallelism with ArmResourcePatch.
|
|
340
341
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -345,6 +346,7 @@ op ArmResourceCreateOrReplaceAsync<
|
|
|
345
346
|
#suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
|
|
346
347
|
@patch(#{ implicitOptionality: true })
|
|
347
348
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
349
|
+
@doc("Update a {name}", Resource)
|
|
348
350
|
op ArmTagsPatchAsync<
|
|
349
351
|
Resource extends Foundations.SimpleResource,
|
|
350
352
|
Properties extends {} = TagsUpdateModel<Resource>,
|
|
@@ -369,7 +371,7 @@ op ArmTagsPatchAsync<
|
|
|
369
371
|
>;
|
|
370
372
|
|
|
371
373
|
/**
|
|
372
|
-
*
|
|
374
|
+
* A long-running resource update using the items from the resource marked with Lifecycle.Update visibility
|
|
373
375
|
* @template Resource the resource being patched
|
|
374
376
|
* @template Properties The model type of the resource properties
|
|
375
377
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -380,6 +382,7 @@ op ArmTagsPatchAsync<
|
|
|
380
382
|
#suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
|
|
381
383
|
@patch(#{ implicitOptionality: true })
|
|
382
384
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
385
|
+
@doc("Update a {name}", Resource)
|
|
383
386
|
op ArmResourcePatchAsync<
|
|
384
387
|
Resource extends Foundations.SimpleResource,
|
|
385
388
|
Properties extends TypeSpec.Reflection.Model,
|
|
@@ -443,7 +446,7 @@ op ArmCustomPatchAsync<
|
|
|
443
446
|
>;
|
|
444
447
|
|
|
445
448
|
/**
|
|
446
|
-
*
|
|
449
|
+
* A resource update that only allows updating resource tags (the minimum)
|
|
447
450
|
* @template Resource the resource being patched
|
|
448
451
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
449
452
|
* @template Parameters Optional. Additional parameters after the path parameters
|
|
@@ -452,6 +455,7 @@ op ArmCustomPatchAsync<
|
|
|
452
455
|
#suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
|
|
453
456
|
@patch(#{ implicitOptionality: true })
|
|
454
457
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
458
|
+
@doc("Update a {name}", Resource)
|
|
455
459
|
op ArmTagsPatchSync<
|
|
456
460
|
Resource extends Foundations.SimpleResource,
|
|
457
461
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
@@ -468,7 +472,7 @@ op ArmTagsPatchSync<
|
|
|
468
472
|
>;
|
|
469
473
|
|
|
470
474
|
/**
|
|
471
|
-
*
|
|
475
|
+
* A resource update using the items from the resource marked with Lifecycle.Update visibility
|
|
472
476
|
* @template Resource the resource being patched
|
|
473
477
|
* @template Properties The model type of the resource properties
|
|
474
478
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -478,6 +482,7 @@ op ArmTagsPatchSync<
|
|
|
478
482
|
#suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
|
|
479
483
|
@patch(#{ implicitOptionality: true })
|
|
480
484
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
485
|
+
@doc("Update a {name}", Resource)
|
|
481
486
|
op ArmResourcePatchSync<
|
|
482
487
|
Resource extends Foundations.SimpleResource,
|
|
483
488
|
Properties extends TypeSpec.Reflection.Model,
|
|
@@ -525,7 +530,7 @@ op ArmCustomPatchSync<
|
|
|
525
530
|
>;
|
|
526
531
|
|
|
527
532
|
/**
|
|
528
|
-
*
|
|
533
|
+
* Delete a resource asynchronously
|
|
529
534
|
* @template Resource The resource being deleted
|
|
530
535
|
* @template Response The response type for the operation
|
|
531
536
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
@@ -550,7 +555,7 @@ op ArmResourceDeleteAsyncBase<
|
|
|
550
555
|
| Error;
|
|
551
556
|
|
|
552
557
|
/**
|
|
553
|
-
*
|
|
558
|
+
* Delete a resource asynchronously. DEPRECATED: Use ArmResourceDeleteWithoutOkAsync instead
|
|
554
559
|
* @template Resource The resource being deleted
|
|
555
560
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
556
561
|
* @template LroHeaders Optional. Allows overriding the headers in the Accepted response
|
|
@@ -561,6 +566,7 @@ op ArmResourceDeleteAsyncBase<
|
|
|
561
566
|
*/
|
|
562
567
|
#deprecated "Use 'ArmResourceDeleteWithoutOkAsync' instead"
|
|
563
568
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
569
|
+
@doc("Delete a {name}", Resource)
|
|
564
570
|
op ArmResourceDeleteAsync<
|
|
565
571
|
Resource extends Foundations.SimpleResource,
|
|
566
572
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
@@ -576,7 +582,7 @@ op ArmResourceDeleteAsync<
|
|
|
576
582
|
> is ArmResourceDeleteAsyncBase<Resource, Response, BaseParameters, Parameters, Error, Provider>;
|
|
577
583
|
|
|
578
584
|
/**
|
|
579
|
-
*
|
|
585
|
+
* Delete a resource asynchronously
|
|
580
586
|
* @template Resource The resource being deleted
|
|
581
587
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
582
588
|
* @template LroHeaders Optional. Allows overriding the headers returned in the Accepted response
|
|
@@ -586,6 +592,7 @@ op ArmResourceDeleteAsync<
|
|
|
586
592
|
* @template Provider Optional. The provider namespace model for the resource.
|
|
587
593
|
*/
|
|
588
594
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
595
|
+
@doc("Delete a {name}", Resource)
|
|
589
596
|
op ArmResourceDeleteWithoutOkAsync<
|
|
590
597
|
Resource extends Foundations.SimpleResource,
|
|
591
598
|
BaseParameters = DefaultBaseParameters<Resource>,
|
|
@@ -656,7 +663,7 @@ op ArmResourceActionAsyncBase<
|
|
|
656
663
|
): Response | Error;
|
|
657
664
|
|
|
658
665
|
/**
|
|
659
|
-
*
|
|
666
|
+
* A long-running resource action.
|
|
660
667
|
* @template Resource The resource being acted upon
|
|
661
668
|
* @template Request The request model for the action
|
|
662
669
|
* @template Response The response model for the action
|
|
@@ -669,6 +676,7 @@ op ArmResourceActionAsyncBase<
|
|
|
669
676
|
*/
|
|
670
677
|
@returnsDoc("Azure operation completed successfully.")
|
|
671
678
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
679
|
+
@doc("")
|
|
672
680
|
op ArmResourceActionAsync<
|
|
673
681
|
Resource extends Foundations.SimpleResource,
|
|
674
682
|
Request,
|
|
@@ -696,7 +704,7 @@ op ArmResourceActionAsync<
|
|
|
696
704
|
>;
|
|
697
705
|
|
|
698
706
|
/**
|
|
699
|
-
*
|
|
707
|
+
* The *standard* long-running resource action.
|
|
700
708
|
* @template Resource The resource being acted upon
|
|
701
709
|
* @template Request The request model for the action
|
|
702
710
|
* @template Response The response model for the action, returned after polling the long-running operation
|
|
@@ -709,6 +717,7 @@ op ArmResourceActionAsync<
|
|
|
709
717
|
*/
|
|
710
718
|
@returnsDoc("Azure operation completed successfully.")
|
|
711
719
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
720
|
+
@doc("")
|
|
712
721
|
op ActionAsync<
|
|
713
722
|
Resource extends Foundations.SimpleResource,
|
|
714
723
|
Request,
|
|
@@ -770,7 +779,7 @@ op ArmResourceActionSync<
|
|
|
770
779
|
): Response | Error;
|
|
771
780
|
|
|
772
781
|
/**
|
|
773
|
-
*
|
|
782
|
+
* A long-running resource action that returns no content. DEPRECATED: Use 'ArmResourceActionNoResponseContentAsync' instead
|
|
774
783
|
* @template Resource The resource being acted upon
|
|
775
784
|
* @template Request The request model for the action
|
|
776
785
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
@@ -781,6 +790,7 @@ op ArmResourceActionSync<
|
|
|
781
790
|
* @template Provider Optional. The provider namespace model for the resource.
|
|
782
791
|
*/
|
|
783
792
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
793
|
+
@doc("")
|
|
784
794
|
op ArmResourceActionNoContentAsync<
|
|
785
795
|
Resource extends Foundations.SimpleResource,
|
|
786
796
|
Request extends TypeSpec.Reflection.Model | void,
|
|
@@ -794,9 +804,8 @@ op ArmResourceActionNoContentAsync<
|
|
|
794
804
|
> is ArmResourceActionAsyncBase<
|
|
795
805
|
Resource,
|
|
796
806
|
Request,
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
| ArmNoContentResponse<"Action completed successfully.">,
|
|
807
|
+
| ArmAcceptedLroResponse<"Resource operation accepted.", LroHeaders>
|
|
808
|
+
| ArmNoContentResponse<"Action completed successfully.">,
|
|
800
809
|
BaseParameters,
|
|
801
810
|
Parameters,
|
|
802
811
|
Error,
|
|
@@ -805,7 +814,7 @@ op ArmResourceActionNoContentAsync<
|
|
|
805
814
|
>;
|
|
806
815
|
|
|
807
816
|
/**
|
|
808
|
-
*
|
|
817
|
+
* A long-running resource action that returns no content.
|
|
809
818
|
* @template Resource The resource being acted upon
|
|
810
819
|
* @template Request The request model for the action
|
|
811
820
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
@@ -816,6 +825,7 @@ op ArmResourceActionNoContentAsync<
|
|
|
816
825
|
* @template Provider Optional. The provider namespace model for the resource.
|
|
817
826
|
*/
|
|
818
827
|
@Private.enforceConstraint(Resource, Foundations.Resource)
|
|
828
|
+
@doc("")
|
|
819
829
|
op ArmResourceActionNoResponseContentAsync<
|
|
820
830
|
Resource extends Foundations.SimpleResource,
|
|
821
831
|
Request,
|
|
@@ -873,7 +883,7 @@ op ArmResourceActionNoContentSync<
|
|
|
873
883
|
): ArmNoContentResponse<"Action completed successfully."> | Error;
|
|
874
884
|
|
|
875
885
|
/**
|
|
876
|
-
*
|
|
886
|
+
* Adds check global name availability operation, normally used if
|
|
877
887
|
* a resource name must be globally unique (for example, if the resource
|
|
878
888
|
* exposes and endpoint that uses the resource name in the url)
|
|
879
889
|
* @template Request the availability request, defaults to the standard request, containing name and resource type
|
|
@@ -893,7 +903,7 @@ op checkGlobalNameAvailability<
|
|
|
893
903
|
>;
|
|
894
904
|
|
|
895
905
|
/**
|
|
896
|
-
*
|
|
906
|
+
* Adds check location-specific name availability operation, normally used if
|
|
897
907
|
* a resource name must be globally unique (for example, if the resource
|
|
898
908
|
* exposes and endpoint that uses the resource name in the url)
|
|
899
909
|
* @template Request the availability request, defaults to the standard request, containing name and resource type
|
|
@@ -913,7 +923,7 @@ op checkLocalNameAvailability<
|
|
|
913
923
|
>;
|
|
914
924
|
|
|
915
925
|
/**
|
|
916
|
-
*
|
|
926
|
+
* A provider action performed over a tenant
|
|
917
927
|
* @template Request The request model for the action
|
|
918
928
|
* @template Response The response type for the action
|
|
919
929
|
* @template Scope The scope of the action (SubscriptionActionScope, TenantActionScope, or ExtensionResourceActionScope)
|
|
@@ -925,6 +935,7 @@ op checkLocalNameAvailability<
|
|
|
925
935
|
@action
|
|
926
936
|
@armResourceCollectionAction
|
|
927
937
|
@Private.armUpdateProviderNamespace
|
|
938
|
+
@doc("")
|
|
928
939
|
op ArmProviderActionSync<
|
|
929
940
|
Request extends {} | unknown | void = void,
|
|
930
941
|
Response extends {} | unknown | void = void,
|
|
@@ -943,7 +954,7 @@ op ArmProviderActionSync<
|
|
|
943
954
|
): Response | Error;
|
|
944
955
|
|
|
945
956
|
/**
|
|
946
|
-
*
|
|
957
|
+
* A long-running provider action.
|
|
947
958
|
* @template Request The request model for the action
|
|
948
959
|
* @template Response The response type for the action
|
|
949
960
|
* @template Scope The scope of the action (SubscriptionActionScope, TenantActionScope, or ExtensionResourceActionScope)
|
|
@@ -956,6 +967,7 @@ op ArmProviderActionSync<
|
|
|
956
967
|
@action
|
|
957
968
|
@armResourceCollectionAction
|
|
958
969
|
@Private.armUpdateProviderNamespace
|
|
970
|
+
@doc("")
|
|
959
971
|
op ArmProviderActionAsync<
|
|
960
972
|
Request extends {} | unknown | void = void,
|
|
961
973
|
Response extends TypeSpec.Reflection.Model | unknown | void = void,
|
|
@@ -56,7 +56,7 @@ interface PrivateEndpoints<
|
|
|
56
56
|
ResourceParameter extends {} = CommonTypes.PrivateEndpointConnectionParameter
|
|
57
57
|
> {
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* List the private endpoint connections over a resource
|
|
60
60
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
61
61
|
* @template Resource Optional. The PrivateEndpointConnection resource being listed
|
|
62
62
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -90,7 +90,7 @@ interface PrivateEndpoints<
|
|
|
90
90
|
>;
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* GET the a private endpoint connection for a particular resource
|
|
94
94
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
95
95
|
* @template Resource the PrivateEndpointConnection resource being read
|
|
96
96
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -120,7 +120,7 @@ interface PrivateEndpoints<
|
|
|
120
120
|
>;
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
*
|
|
123
|
+
* A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource
|
|
124
124
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
125
125
|
* @template Resource the PrivateEndpointConnection resource being created or updated
|
|
126
126
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -158,7 +158,7 @@ interface PrivateEndpoints<
|
|
|
158
158
|
>;
|
|
159
159
|
|
|
160
160
|
/**
|
|
161
|
-
*
|
|
161
|
+
* Synchronous PUT operation for a Private endpoint connection to a resource
|
|
162
162
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
163
163
|
* @template Resource the PrivateEndpointConnection resource being created or updated
|
|
164
164
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -192,7 +192,7 @@ interface PrivateEndpoints<
|
|
|
192
192
|
>;
|
|
193
193
|
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource
|
|
196
196
|
* @template ParentResource the parent resource of the PrivateEndpointConnection
|
|
197
197
|
* @template Resource the PrivateEndpointConnection resource being created or updated
|
|
198
198
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -272,7 +272,7 @@ interface PrivateEndpoints<
|
|
|
272
272
|
>;
|
|
273
273
|
|
|
274
274
|
/**
|
|
275
|
-
*
|
|
275
|
+
* A resource update using a custom PATCH payload (synchronous) to update a PrivateEndpointConnection to a resource
|
|
276
276
|
* @template ParentResource The parent resource of the PrivateEndpointConnection
|
|
277
277
|
* @template Resource Optional. The PrivateEndpointConnection resource being patched
|
|
278
278
|
* @template PatchModel The input model for the PATCH request
|
|
@@ -306,7 +306,7 @@ interface PrivateEndpoints<
|
|
|
306
306
|
>;
|
|
307
307
|
|
|
308
308
|
/**
|
|
309
|
-
*
|
|
309
|
+
* Delete a PrivateEndpointConnection to a resource asynchronously
|
|
310
310
|
* @template ParentResource The parent resource of the PrivateEndpointConnection
|
|
311
311
|
* @template Resource Optional. The PrivateEndpointConnection resource being deleted
|
|
312
312
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
@@ -338,7 +338,7 @@ interface PrivateEndpoints<
|
|
|
338
338
|
): Response | Error;
|
|
339
339
|
|
|
340
340
|
/**
|
|
341
|
-
*
|
|
341
|
+
* Delete a PrivateEndpointConnection to a resource synchronously
|
|
342
342
|
* @template ParentResource The parent resource of the PrivateEndpointConnection
|
|
343
343
|
* @template Resource The PrivateEndpointConnection resource being deleted
|
|
344
344
|
* @template BaseParameters Optional. Allows overriding the parameters for the operation
|
|
@@ -367,7 +367,7 @@ interface PrivateEndpoints<
|
|
|
367
367
|
): Response | Error;
|
|
368
368
|
|
|
369
369
|
/**
|
|
370
|
-
*
|
|
370
|
+
* Delete a PrivateEndpointConnection to a resource asynchronously
|
|
371
371
|
* @template ParentResource The parent resource of the PrivateEndpointConnection
|
|
372
372
|
* @template Response The response type for the operation
|
|
373
373
|
* @template Resource Optional. The PrivateEndpointConnection resource being deleted
|
package/lib/private-links.tsp
CHANGED
|
@@ -57,7 +57,7 @@ interface PrivateLinks<
|
|
|
57
57
|
ResourceParameter extends {} = CommonTypes.PrivateLinkResourceParameter
|
|
58
58
|
> {
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* List the private links to a resource
|
|
61
61
|
* @template ParentResource the parent resource of the PrivateLink
|
|
62
62
|
* @template Resource Optional. The PrivateLink resource being listed
|
|
63
63
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -91,7 +91,7 @@ interface PrivateLinks<
|
|
|
91
91
|
>;
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* List the private links to a resource - this should only be used for legacy operations
|
|
95
95
|
* @template ParentResource the parent resource of the PrivateLink
|
|
96
96
|
* @template Resource Optional. The PrivateLink resource being listed
|
|
97
97
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|
|
@@ -125,7 +125,7 @@ interface PrivateLinks<
|
|
|
125
125
|
>;
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
|
-
*
|
|
128
|
+
* GET the a private link to a particular resource
|
|
129
129
|
* @template ParentResource the parent resource of the PrivateLink
|
|
130
130
|
* @template Resource the PrivateLink resource being read
|
|
131
131
|
* @template BaseParameters Optional. Allows overriding the operation parameters
|