@azure-tools/typespec-azure-resource-manager 0.70.0-dev.0 → 0.70.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.
Files changed (83) hide show
  1. package/README.md +150 -10
  2. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.d.ts +35 -0
  3. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.d.ts.map +1 -0
  4. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.js +2 -0
  5. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.js.map +1 -0
  6. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.ts-test.d.ts +2 -0
  7. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.ts-test.d.ts.map +1 -0
  8. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.ts-test.js +8 -0
  9. package/dist/generated-defs/Azure.ResourceManager.BaseTypes.ts-test.js.map +1 -0
  10. package/dist/generated-defs/Azure.ResourceManager.Private.d.ts +12 -0
  11. package/dist/generated-defs/Azure.ResourceManager.Private.d.ts.map +1 -1
  12. package/dist/generated-defs/Azure.ResourceManager.d.ts +66 -25
  13. package/dist/generated-defs/Azure.ResourceManager.d.ts.map +1 -1
  14. package/dist/src/base-types.d.ts +16 -0
  15. package/dist/src/base-types.d.ts.map +1 -0
  16. package/dist/src/base-types.js +30 -0
  17. package/dist/src/base-types.js.map +1 -0
  18. package/dist/src/index.d.ts +1 -0
  19. package/dist/src/index.d.ts.map +1 -1
  20. package/dist/src/index.js +1 -0
  21. package/dist/src/index.js.map +1 -1
  22. package/dist/src/lib.d.ts +17 -2
  23. package/dist/src/lib.d.ts.map +1 -1
  24. package/dist/src/lib.js +6 -0
  25. package/dist/src/lib.js.map +1 -1
  26. package/dist/src/linter.d.ts.map +1 -1
  27. package/dist/src/linter.js +8 -0
  28. package/dist/src/linter.js.map +1 -1
  29. package/dist/src/private.decorators.d.ts.map +1 -1
  30. package/dist/src/private.decorators.js +20 -2
  31. package/dist/src/private.decorators.js.map +1 -1
  32. package/dist/src/resource.d.ts +6 -2
  33. package/dist/src/resource.d.ts.map +1 -1
  34. package/dist/src/resource.js +8 -0
  35. package/dist/src/resource.js.map +1 -1
  36. package/dist/src/rules/arm-agent-base-type-child-resources.d.ts +4 -0
  37. package/dist/src/rules/arm-agent-base-type-child-resources.d.ts.map +1 -0
  38. package/dist/src/rules/arm-agent-base-type-child-resources.js +94 -0
  39. package/dist/src/rules/arm-agent-base-type-child-resources.js.map +1 -0
  40. package/dist/src/rules/arm-agent-base-type-lifecycle-operations.d.ts +4 -0
  41. package/dist/src/rules/arm-agent-base-type-lifecycle-operations.d.ts.map +1 -0
  42. package/dist/src/rules/arm-agent-base-type-lifecycle-operations.js +99 -0
  43. package/dist/src/rules/arm-agent-base-type-lifecycle-operations.js.map +1 -0
  44. package/dist/src/rules/arm-custom-resource-usage-discourage.d.ts.map +1 -1
  45. package/dist/src/rules/arm-custom-resource-usage-discourage.js +44 -2
  46. package/dist/src/rules/arm-custom-resource-usage-discourage.js.map +1 -1
  47. package/dist/src/rules/arm-feature-file-usage-discourage.d.ts +4 -0
  48. package/dist/src/rules/arm-feature-file-usage-discourage.d.ts.map +1 -0
  49. package/dist/src/rules/arm-feature-file-usage-discourage.js +24 -0
  50. package/dist/src/rules/arm-feature-file-usage-discourage.js.map +1 -0
  51. package/dist/src/rules/no-reserved-resource-property.d.ts +4 -0
  52. package/dist/src/rules/no-reserved-resource-property.d.ts.map +1 -0
  53. package/dist/src/rules/no-reserved-resource-property.js +50 -0
  54. package/dist/src/rules/no-reserved-resource-property.js.map +1 -0
  55. package/dist/src/state.d.ts +2 -0
  56. package/dist/src/state.d.ts.map +1 -1
  57. package/dist/src/state.js +3 -0
  58. package/dist/src/state.js.map +1 -1
  59. package/dist/src/tsp-index.d.ts.map +1 -1
  60. package/dist/src/tsp-index.js +8 -1
  61. package/dist/src/tsp-index.js.map +1 -1
  62. package/lib/arm.tsp +2 -0
  63. package/lib/base-types/agent.tsp +425 -0
  64. package/lib/base-types/base-types.tsp +45 -0
  65. package/lib/common-types/common-types.tsp +1 -1
  66. package/lib/common-types/nsp-operations.tsp +5 -5
  67. package/lib/common-types/types.tsp +2 -3
  68. package/lib/decorators.tsp +81 -11
  69. package/lib/extension/operations.tsp +8 -6
  70. package/lib/foundations/arm.foundations.tsp +22 -11
  71. package/lib/interfaces.tsp +24 -14
  72. package/lib/legacy-types/extension.tsp +1 -1
  73. package/lib/legacy-types/operations.tsp +9 -5
  74. package/lib/legacy-types/private-endpoints.tsp +4 -4
  75. package/lib/models.tsp +1 -1
  76. package/lib/operations.tsp +31 -19
  77. package/lib/parameters.tsp +3 -3
  78. package/lib/private-endpoints.tsp +9 -9
  79. package/lib/private-links.tsp +3 -3
  80. package/lib/private.decorators.tsp +16 -0
  81. package/lib/responses.tsp +17 -12
  82. package/package.json +4 -4
  83. package/lib/common-types/customer-managed-keys-ref.tsp +0 -43
@@ -302,7 +302,7 @@ op ArmResourceCreateOrReplaceSync<
302
302
  >;
303
303
 
304
304
  /**
305
- * @dev A long-running resource CreateOrUpdate (PUT)
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
- * @dev A long-running resource update that only allows updating resource tags (the minimum)
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
- * @dev A long-running resource update using the items from the resource marked with Lifecycle.Update visibility
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
- * @dev A resource update that only allows updating resource tags (the minimum)
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
- * @dev A resource update using the items from the resource marked with Lifecycle.Update visibility
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
- * @dev Delete a resource asynchronously
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
- * @dev Delete a resource asynchronously. DEPRECATED: Use ArmResourceDeleteWithoutOkAsync instead
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
- * @dev Delete a resource asynchronously
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
- * @dev A long-running resource action.
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
- * @dev The *standard* long-running resource action.
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
- * @dev A long-running resource action that returns no content. DEPRECATED: Use 'ArmResourceActionNoResponseContentAsync' instead
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
- | ArmAcceptedLroResponse<"Resource operation accepted.", LroHeaders>
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
- * @dev A long-running resource action that returns no content.
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
- * @dev Adds check global name availability operation, normally used if
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
- * @dev Adds check location-specific name availability operation, normally used if
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
- * @dev A provider action performed over a tenant
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
- * @dev A long-running provider action.
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,
@@ -284,7 +284,7 @@ model ExtensionActionScope<StringType extends string = string>
284
284
  model ArmTopParameter {
285
285
  @query("$top")
286
286
  @doc("The total number of items to return.")
287
- top: int64;
287
+ top?: int64;
288
288
  }
289
289
 
290
290
  /**
@@ -293,7 +293,7 @@ model ArmTopParameter {
293
293
  model ArmFilterParameter {
294
294
  @query("$filter")
295
295
  @doc("The OData filter expression to apply to the list operation.")
296
- filter: string;
296
+ filter?: string;
297
297
  }
298
298
 
299
299
  /**
@@ -302,7 +302,7 @@ model ArmFilterParameter {
302
302
  model ArmSkipParameter {
303
303
  @query("$skip")
304
304
  @doc("The number of items to skip before starting to collect the result set.")
305
- skip: int64;
305
+ skip?: int64;
306
306
  }
307
307
 
308
308
  /**
@@ -56,7 +56,7 @@ interface PrivateEndpoints<
56
56
  ResourceParameter extends {} = CommonTypes.PrivateEndpointConnectionParameter
57
57
  > {
58
58
  /**
59
- * @dev List the private endpoint connections over a resource
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
- * @dev GET the a private endpoint connection for a particular resource
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
- * @dev A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource
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
- * @dev Synchronous PUT operation for a Private endpoint connection to a resource
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
- * @dev A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource
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
- * @dev A resource update using a custom PATCH payload (synchronous) to update a PrivateEndpointConnection to a resource
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
- * @dev Delete a PrivateEndpointConnection to a resource asynchronously
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
- * @dev Delete a PrivateEndpointConnection to a resource synchronously
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
- * @dev Delete a PrivateEndpointConnection to a resource asynchronously
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
@@ -57,7 +57,7 @@ interface PrivateLinks<
57
57
  ResourceParameter extends {} = CommonTypes.PrivateLinkResourceParameter
58
58
  > {
59
59
  /**
60
- * @dev List the private links to a resource
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
- * @dev List the private links to a resource - this should only be used for legacy operations
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
- * @dev GET the a private link to a particular resource
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
@@ -119,6 +119,22 @@ extern dec armResourcePropertiesOptionality(target: ModelProperty, isOptional: v
119
119
  /** designates a parameter as an explicit bodyRoot and sets the optionality of the parameter */
120
120
  extern dec armBodyRoot(target: ModelProperty, isOptional: valueof boolean);
121
121
 
122
+ /**
123
+ * Controls visibility of a base type property based on whether the property is present
124
+ * and whether the deployment model is Appliance or Platform.
125
+ *
126
+ * If `isPresent` is false, the property is made invisible (removed from all lifecycle visibility).
127
+ * If `isAppliance` is true, the property is made read-only.
128
+ *
129
+ * @param isPresent Whether this property is present in the current template instantiation.
130
+ * @param isAppliance Whether the current deployment model is Appliance (true) or Platform (false).
131
+ */
132
+ extern dec baseTypeOptional(
133
+ target: ModelProperty,
134
+ isPresent: valueof boolean,
135
+ isAppliance: valueof boolean
136
+ );
137
+
122
138
  /** designates a type as a legacy type and emits a warning diagnostic when used */
123
139
  extern dec legacyType(target: Model | Operation | Interface | Scalar);
124
140
 
package/lib/responses.tsp CHANGED
@@ -66,7 +66,7 @@ model ArmDeletedResponse {
66
66
  }
67
67
 
68
68
  /**
69
- * @dev The response for asynchronous Azure Resource Manager delete ACCEPTED
69
+ * The response for asynchronous Azure Resource Manager delete ACCEPTED
70
70
  * @template LroHeaders Optional. Allows overriding the Lro headers returned in the response.
71
71
  *
72
72
  * @example
@@ -77,17 +77,21 @@ model ArmDeletedResponse {
77
77
  *>;
78
78
  * ```
79
79
  */
80
+ @doc("Resource deletion accepted.")
80
81
  model ArmDeleteAcceptedLroResponse<LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
81
- Azure.Core.Foundations.RetryAfterHeader>
82
- is ArmAcceptedLroResponse<"Resource deletion accepted.", LroHeaders>;
82
+ Azure.Core.Foundations.RetryAfterHeader> is ArmAcceptedLroResponse<
83
+ "Resource deletion accepted.",
84
+ LroHeaders
85
+ >;
83
86
 
84
87
  /**
85
- * @dev The response for synchronous Azure Resource Manager delete ACCEPTED
88
+ * The response for synchronous Azure Resource Manager delete ACCEPTED
86
89
  */
90
+ @doc("Resource deletion accepted.")
87
91
  model ArmDeleteAcceptedResponse is ArmAcceptedResponse<"Resource deletion accepted.">;
88
92
 
89
93
  /**
90
- * @dev The standard ACCEPTED response
94
+ * The standard ACCEPTED response
91
95
  * @template Message The description of the response status (defaults to `Resource operation accepted`)
92
96
  * @template ExtraHeaders Additional headers in the response. Default includes Retry-After header
93
97
  *
@@ -110,7 +114,7 @@ model ArmAcceptedResponse<
110
114
  }
111
115
 
112
116
  /**
113
- * @dev The standard Azure Resource Manager response for asynchronous PATCH, POST, and DELETE operations
117
+ * The standard Azure Resource Manager response for asynchronous PATCH, POST, and DELETE operations
114
118
  * @template Description The description of the response status (defaults to `Resource operation accepted`)
115
119
  * @template LroHeaders Optional. The lro headers that appear in the Accepted response
116
120
  *
@@ -270,7 +274,7 @@ model ArmCombinedLroHeaders<
270
274
  }
271
275
 
272
276
  /**
273
- * @dev Azure Resource Manager response for a properly formed delete request, with no resource found
277
+ * Azure Resource Manager response for a properly formed delete request, with no resource found
274
278
  *
275
279
  * @example
276
280
  * ```typespec
@@ -280,6 +284,7 @@ model ArmCombinedLroHeaders<
280
284
  * >;
281
285
  * ```
282
286
  */
287
+ @doc("Resource does not exist.")
283
288
  model ArmDeletedNoContentResponse is ArmNoContentResponse<"Resource does not exist.">;
284
289
 
285
290
  /**
@@ -298,7 +303,7 @@ model ArmNoContentResponse<Message extends valueof string = "Operation completed
298
303
  }
299
304
 
300
305
  /**
301
- * @dev Resource update operation succeeded
306
+ * Resource update operation succeeded
302
307
  * @template Resource The resource being updated
303
308
  *
304
309
  * @example
@@ -314,7 +319,7 @@ model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundati
314
319
  is ArmResponse<Resource>;
315
320
 
316
321
  /**
317
- * @dev Resource create operation succeeded
322
+ * Resource create operation succeeded
318
323
  * @template Resource The resource being updated
319
324
  * @template LroHeaders Optional. The lro headers returned with a Created response
320
325
  *
@@ -344,7 +349,7 @@ model ArmResourceCreatedResponse<
344
349
  }
345
350
 
346
351
  /**
347
- * @dev Resource synchronous create operation succeeded
352
+ * Resource synchronous create operation succeeded
348
353
  * @template Resource The resource being updated
349
354
  *
350
355
  * @example
@@ -365,7 +370,7 @@ model ArmResourceCreatedSyncResponse<Resource extends Azure.ResourceManager.Foun
365
370
  }
366
371
 
367
372
  /**
368
- * @dev Resource exists response
373
+ * Resource exists response
369
374
  *
370
375
  * @example
371
376
  * ```typespec
@@ -379,7 +384,7 @@ model ArmResourceExistsResponse {
379
384
  }
380
385
 
381
386
  /**
382
- * @dev Resource is not found response
387
+ * Resource is not found response
383
388
  * ```typespec
384
389
  * @head
385
390
  * op head(...ResourceInstanceParameters<Employee>): ArmResponse<Employee> | ArmResourceNotFoundResponse;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure-tools/typespec-azure-resource-manager",
3
- "version": "0.70.0-dev.0",
3
+ "version": "0.70.0-dev.10",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec Azure Resource Manager library",
6
6
  "homepage": "https://azure.github.io/typespec-azure",
@@ -56,7 +56,7 @@
56
56
  },
57
57
  "devDependencies": {
58
58
  "@azure-tools/typespec-azure-core": "^0.69.0 || >=0.70.0-dev <0.70.0",
59
- "@types/node": "^25.5.2",
59
+ "@types/node": "^26.0.0",
60
60
  "@types/pluralize": "^0.0.33",
61
61
  "@typespec/compiler": "^1.13.0",
62
62
  "@typespec/http": "^1.13.0",
@@ -81,8 +81,8 @@
81
81
  "test:watch": "vitest -w",
82
82
  "test:ui": "vitest --ui",
83
83
  "test:ci": "vitest run --coverage --reporter=junit --reporter=default",
84
- "lint": "eslint . --max-warnings=0",
85
- "lint:fix": "eslint . --fix ",
84
+ "lint": "oxlint . --deny-warnings",
85
+ "lint:fix": "oxlint . --fix",
86
86
  "regen-docs": "tspd doc . --enable-experimental --llmstxt --output-dir ../../website/src/content/docs/docs/libraries/azure-resource-manager/reference"
87
87
  }
88
88
  }
@@ -1,43 +0,0 @@
1
- import "./customer-managed-keys.tsp";
2
-
3
- using Azure.ResourceManager.CommonTypes.Private;
4
-
5
- namespace Azure.ResourceManager.CommonTypes;
6
-
7
- @@armCommonDefinition(
8
- Encryption,
9
- "encryption",
10
- #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
11
- "customermanagedkeys.json"
12
- );
13
- @@armCommonDefinition(
14
- Encryption,
15
- "encryption",
16
- Azure.ResourceManager.CommonTypes.Versions.v5,
17
- "customermanagedkeys.json"
18
- );
19
- @@armCommonDefinition(
20
- Encryption,
21
- "encryption",
22
- Azure.ResourceManager.CommonTypes.Versions.v6,
23
- "customermanagedkeys.json"
24
- );
25
-
26
- @@armCommonDefinition(
27
- CustomerManagedKeyEncryption,
28
- "customerManagedKeyEncryption",
29
- #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
30
- "customermanagedkeys.json"
31
- );
32
- @@armCommonDefinition(
33
- CustomerManagedKeyEncryption,
34
- "customerManagedKeyEncryption",
35
- Azure.ResourceManager.CommonTypes.Versions.v5,
36
- "customermanagedkeys.json"
37
- );
38
- @@armCommonDefinition(
39
- CustomerManagedKeyEncryption,
40
- "customerManagedKeyEncryption",
41
- Azure.ResourceManager.CommonTypes.Versions.v6,
42
- "customermanagedkeys.json"
43
- );