@azure-tools/typespec-azure-resource-manager 0.30.0-dev.11 → 0.30.0-dev.12

package/lib/interfaces.tsp

@@ -138,6 +138,10 @@ interface ResourceCollectionOperations<
  * @template TResource The ArmResource that provides these operations
  */
 interface ResourceListBySubscription<TResource extends ArmResource> {
+  /**
+   * List resources by subscription.
+   * @template TResource The ArmResource to list.
+   */
   listBySubscription is ArmListBySubscription<TResource>;
 }
 
@@ -154,6 +158,13 @@ interface ResourceListByParent<
   TParentName = "",
   TParentFriendlyName = ""
 > {
+  /**
+   * List resources by parent.
+   * @template TResource The ArmResource to list.
+   * @template TBaseParameters The http parameters that are part of the request
+   * @template TParentName The name of the parent resource
+   * @template TParentFriendlyName The friendly name of the parent resource
+   */
   listByParent is ArmResourceListByParent<
     TResource,
     TBaseParameters,
@@ -168,6 +179,11 @@ interface ResourceListByParent<
  * @template TBaseParameters The http parameters that are part of the request
  */
 interface ResourceRead<TResource extends ArmResource, TBaseParameters = BaseParameters<TResource>> {
+  /**
+   * Retrieve a resource.
+   * @template TResource The ArmResource to retrieve.
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   get is ArmResourceRead<TResource, TBaseParameters>;
 }
 
@@ -180,6 +196,11 @@ interface ResourceCreateSync<
   TResource extends ArmResource,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Create or update a resource using the synchronous call pattern.
+   * @template TResource The ArmResource to create or update.
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   createOrUpdate is ArmResourceCreateOrUpdateSync<TResource, TBaseParameters>;
 }
 
@@ -192,6 +213,11 @@ interface ResourceCreateAsync<
   TResource extends ArmResource,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Create or update a resource using the asynchronous call pattern.
+   * @template TResource The ArmResource to create or update.
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   createOrUpdate is ArmResourceCreateOrUpdateAsync<TResource, TBaseParameters>;
 }
 
@@ -205,6 +231,11 @@ interface ResourceDeleteAsync<
   TResource extends ArmResource,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Delete a resource using the asynchronous call pattern.
+   * @template TResource The ArmResource to delete.
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   delete is ArmResourceDeleteAsync<TResource, TBaseParameters>;
 }
 
@@ -218,6 +249,11 @@ interface ResourceDeleteSync<
   TResource extends ArmResource,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Delete a resource using the synchronous call pattern.
+   * @template TResource The ArmResource to delete.
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   delete is ArmResourceDeleteSync<TResource, TBaseParameters>;
 }
 
@@ -233,6 +269,12 @@ interface ResourceUpdateAsync<
   TProperties extends object,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Update a resource using the asynchronous call pattern.
+   * @template TResource The ArmResource to update.
+   * @template TProperties RP-specific property bag for the resource
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   update is ArmCustomPatchAsync<
     TResource,
     ResourceUpdateModel<TResource, TProperties>,
@@ -252,6 +294,12 @@ interface ResourceUpdateSync<
   TProperties extends object,
   TBaseParameters = BaseParameters<TResource>
 > {
+  /**
+   * Update a resource using the synchronous call pattern.
+   * @template TResource The ArmResource to update.
+   * @template TProperties RP-specific property bag for the resource
+   * @template TBaseParameters The http parameters that are part of the request
+   */
   update is ArmCustomPatchSync<
     TResource,
     ResourceUpdateModel<TResource, TProperties>,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.30.0-dev.11",
+  "version": "0.30.0-dev.12",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",