[AzureDataTransfer] Introduce 2025-05-30-Preview version with TypeSpec (#36400)

* init

* doc update

* readme

* spell check

* spell check + examples

* sdk build fail

* avocado

* avocado + modelvalidation + sdk

* update

* model validation + prettier check

* prettier

* updates

* readme

* lint diff -1

* lint diff - 2

* lint diff - 3

* sdk validation - js - 1

* sdk validation - js - 2

* sdk validation - js - 3

* sdk validation - js - 4

* sdk validation - js - 5

* init

* get rid of armresponse

* Updated the description of Authentication properties within apiFlowOptions and remoteEndpointSettings

* pipeline update

* readmin

* readme - 2

* reintroduce responsbe wrapper

* done

* reintroduce response wrapper and response model + dont remove old properties

* missed connectionresponse

* missing another connectionresponse

* examples update

* prettier

* remove suppressions

* remove readme suppresion 1

* remove readme suppresion 2

* reintroduce readme suppresion 2

* disabled flow types and dataclass

* readme

* format

* remove unnecessary models

* remove suppressions

* suppression fix

* connection?

* @list?

* lint

* example

* fixes

* please fix everything

* omg yes

* remove breaking changes T.T

* examples

* example ref

* Updated the description of fields in the apiFlowOptions

---------

Co-authored-by: Steven Kim <[email protected]>

Author: joschung

specification/azuredatatransfer/AzureDataTransfer.Management/FlowProfile.tsp

@@ -0,0 +1,79 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./Pipeline.tsp";
+import "./models.flowprofile.tsp";
+
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+@versioned(Versions)
+namespace Microsoft.AzureDataTransfer;
+
+/**
+ * Represents a FlowProfile Azure resource, which defines a data replication scenario with a specific data classification and a set of configurable policy rules.
+ */
+@added(Versions.v2025_05_30_preview)
+@parentResource(Pipeline)
+model FlowProfile
+  is Azure.ResourceManager.TrackedResource<FlowProfileProperties> {
+  ...ResourceNameParameter<
+    Resource = FlowProfile,
+    KeyName = "flowProfileName",
+    SegmentName = "flowProfiles",
+    NamePattern = "^[a-zA-Z0-9-]{3,64}$"
+  >;
+  ...Azure.ResourceManager.ManagedServiceIdentityProperty;
+}
+
+/**
+ * Defines the set of operations available for managing FlowProfile resources.
+ */
+@added(Versions.v2025_05_30_preview)
+@armResourceOperations
+interface FlowProfiles {
+  /**
+   * Retrieves the specified FlowProfile resource.
+   */
+  get is ArmResourceRead<FlowProfile>;
+
+  /**
+   * Creates a new FlowProfile or updates an existing one.
+   */
+  createOrUpdate is ArmResourceCreateOrReplaceAsync<FlowProfile>;
+
+  /**
+   * Applies partial updates to an existing FlowProfile resource.
+   */
+  @patch(#{ implicitOptionality: false })
+  update is ArmCustomPatchAsync<FlowProfile, PatchModel = FlowProfilePatch>;
+
+  /**
+   * Deletes the specified FlowProfile resource.
+   */
+  delete is ArmResourceDeleteWithoutOkAsync<FlowProfile>;
+
+  /**
+   * Lists all FlowProfiles under a given Pipeline.
+   */
+  listByPipeline is ArmResourceListByParent<FlowProfile>;
+}
+
+@@maxLength(FlowProfile.name, 64);
+@@minLength(FlowProfile.name, 3);
+@@doc(FlowProfile.name,
+  "The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens."
+);
+@@doc(FlowProfile.properties,
+  "The set of configuration properties that define the behavior and rules of the FlowProfile."
+);
+@@doc(FlowProfiles.createOrUpdate::parameters.resource,
+  "The FlowProfile resource definition to create or update."
+);
+@@doc(FlowProfiles.update::parameters.properties,
+  "The FlowProfile patch definition containing the properties to update."
+);

specification/azuredatatransfer/AzureDataTransfer.Management/Pipeline.tsp

@@ -10,10 +10,12 @@ using Azure.ClientGenerator.Core;
 using Azure.ResourceManager;
 using TypeSpec.Http;
 using TypeSpec.OpenAPI;
+using TypeSpec.Versioning;
 
 namespace Microsoft.AzureDataTransfer;
+
 /**
- * The pipeline resource definition.
+ * The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.
  */
 model Pipeline is Azure.ResourceManager.TrackedResource<PipelineProperties> {
   ...ResourceNameParameter<
@@ -27,20 +29,23 @@ model Pipeline is Azure.ResourceManager.TrackedResource<PipelineProperties> {
 
 model ArmPipelineResponse is ArmResponse<Pipeline>;
 
+/**
+ * Defines the set of operations available for managing Pipeline resources.
+ */
 @armResourceOperations
 interface Pipelines {
   /**
-   * Gets pipeline resource.
+   * Retrieves the specified Pipeline resource.
    */
   get is ArmResourceRead<Pipeline>;
 
   /**
-   * Creates or updates the pipeline resource.
+   * Creates a new Pipeline resource or updates an existing one. This operation is asynchronous and returns the resulting Pipeline.
    */
   createOrUpdate is ArmResourceCreateOrReplaceAsync<Pipeline>;
 
   /**
-   * Updates the pipeline resource.
+   * Applies partial updates to an existing Pipeline resource. This operation supports patch semantics and returns the updated Pipeline.
    */
   #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "Prior OpenAPI2 Json spec provides the resource back in the LRO response."
   @patch(#{ implicitOptionality: false })
@@ -54,22 +59,22 @@ interface Pipelines {
   >;
 
   /**
-   * Deletes the pipeline resource.
+   * Deletes the specified Pipeline resource.
    */
   delete is ArmResourceDeleteWithoutOkAsync<Pipeline>;
 
   /**
-   * Gets pipelines in a resource group.
+   * Lists all Pipeline resources within the specified resource group.
    */
   listByResourceGroup is ArmResourceListByParent<Pipeline>;
 
   /**
-   * Gets pipelines in a subscription.
+   * Lists all Pipeline resources within the current subscription.
    */
   listBySubscription is ArmListBySubscription<Pipeline>;
 
   /**
-   * Approves the specified connection request in a pipeline.
+   * Approves a pending connection request associated with the specified Pipeline.
    */
   approveConnection is ArmResourceActionAsync<
     Pipeline,
@@ -78,7 +83,7 @@ interface Pipelines {
   >;
 
   /**
-   * Executes a privileged action for a pipeline.
+   * Executes a privileged or administrative action on the specified Pipeline.
    */
   executeAction is ArmResourceActionAsync<
     Pipeline,
@@ -87,17 +92,16 @@ interface Pipelines {
   >;
 
   /**
-   * Lists the flows in a pipeline.
+   * Lists all Flows associated with the specified Pipeline.
    */
   #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
-  #suppress "@azure-tools/typespec-client-generator-core/no-unnamed-types" "Backwards compatibility with existing clients."
   @action("listFlows")
   @operationId("ListFlowsByPipeline_List")
   list is ArmResourceActionSync<
     Pipeline,
     {
       /**
-       * Connection(s) to retrieve flows of
+       * A list of connection identifiers used to filter the Flows to be retrieved.
        */
       @bodyRoot
       connections?: ConnectionIdList;
@@ -106,7 +110,7 @@ interface Pipelines {
   >;
 
   /**
-   * Lists the schemas for the specified connection in a pipeline.
+   * Lists the schemas associated with a specific connection in the Pipeline. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
    */
   #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
   @action("listSchemas")
@@ -118,7 +122,7 @@ interface Pipelines {
   >;
 
   /**
-   * Rejects the specified connection request in a pipeline.
+   * Rejects a pending connection request associated with the specified Pipeline.
    */
   rejectConnection is ArmResourceActionAsync<
     Pipeline,
@@ -129,14 +133,28 @@ interface Pipelines {
 
 @@maxLength(Pipeline.name, 64);
 @@minLength(Pipeline.name, 3);
-@@doc(Pipeline.name, "The name for the pipeline to perform the operation on.");
-@@doc(Pipeline.properties, "Properties of pipeline");
-@@doc(Pipelines.createOrUpdate::parameters.resource, "Pipeline body");
-@@doc(Pipelines.update::parameters.properties, "Pipeline body");
-@@doc(Pipelines.approveConnection::parameters.body, "Connection body");
-@@doc(Pipelines.executeAction::parameters.body, "Action to execute");
-@@doc(Pipelines.listSchemasList::parameters.body, "Schema(s) to retrieve");
-@@doc(Pipelines.rejectConnection::parameters.body, "Connection body");
+@@doc(Pipeline.name, "The name of the pipeline on which to operate.");
+@@doc(Pipeline.properties,
+  "The set of configurable properties for the Pipeline resource."
+);
+@@doc(Pipelines.createOrUpdate::parameters.resource,
+  "The request body containing the Pipeline definition."
+);
+@@doc(Pipelines.update::parameters.properties,
+  "The request body containing the updated Pipeline properties."
+);
+@@doc(Pipelines.approveConnection::parameters.body,
+  "The request body containing the connection to approve."
+);
+@@doc(Pipelines.executeAction::parameters.body,
+  "The action to be executed on the Pipeline."
+);
+@@doc(Pipelines.listSchemasList::parameters.body,
+  "The schema(s) to retrieve for the specified connection."
+);
+@@doc(Pipelines.rejectConnection::parameters.body,
+  "The request body containing the connection to reject."
+);
 
 @@clientName(Pipelines.createOrUpdate::parameters.resource, "pipeline");
 @@clientName(Pipelines.update::parameters.properties, "pipeline");

specification/azuredatatransfer/AzureDataTransfer.Management/ProviderActions.tsp

@@ -7,17 +7,23 @@ import "@azure-tools/typespec-azure-resource-manager";
 import "@azure-tools/typespec-client-generator-core";
 import "@typespec/openapi";
 
-using TypeSpec.Rest;
 using Azure.ResourceManager;
 using Azure.ClientGenerator.Core;
+using TypeSpec.Http;
 using TypeSpec.OpenAPI;
+using TypeSpec.Versioning;
+using TypeSpec.Rest;
 
 namespace Microsoft.AzureDataTransfer;
 
+/**
+ * AzureDataTransfer interface defines provider-level operations for managing
+ * schemas and FlowProfiles in Azure Data Transfer.
+ */
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "This interface corresponds to our Provider level actions, no decorator exists for that."
 interface AzureDataTransfer {
   /**
-   * Lists approved schemas for Azure Data Transfer.
+   * Retrieves the list of approved schemas available for Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
    */
   #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
   @operationId("AzureDataTransfer_listApprovedSchemas")
@@ -26,8 +32,26 @@ interface AzureDataTransfer {
     Request = ListApprovedSchemasRequest,
     Response = SchemasListResult
   >;
+
+  /**
+   * Retrieves a list of FlowProfile resources associated with a specified pipeline.
+   */
+  @added(Versions.v2025_05_30_preview)
+  @autoRoute
+  listFlowProfiles is ArmProviderActionSync<
+    Request = ListFlowProfilesRequest,
+    Response = {
+      /**
+       * A list of FlowProfile metadata created under the specified pipeline.
+       */
+      @added(Versions.v2025_05_30_preview)
+      @bodyRoot
+      flowProfileList?: FlowProfileMetadata[];
+    }
+  >;
+
   /**
-   * Validates a schema for Azure Data Transfer.
+   * Validates the structure and content of a schema for use in Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
    */
   #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
   @operationId("AzureDataTransfer_validateSchema")
@@ -43,5 +67,5 @@ interface AzureDataTransfer {
 );
 @@clientName(AzureDataTransfer.validateSchema::parameters.body, "schema");
 @@doc(AzureDataTransfer.listApprovedSchemas::parameters.body,
-  "The request to list approved schemas."
+  "The request payload for listing approved schemas."
 );

specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-05-30-preview/AzureDataTransfer_ListFlowProfiles_MaximumSet_Gen.json

@@ -0,0 +1,22 @@
+{
+  "title": "AzureDataTransfer_ListFlowProfiles_MaximumSet_Gen - generated by [MaximumSet] rule",
+  "operationId": "AzureDataTransfer_ListFlowProfiles",
+  "parameters": {
+    "api-version": "2025-05-30-preview",
+    "body": {}
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "pipeline": "testPipeline",
+          "name": "testFlowProfileA",
+          "replicationScenario": "Messaging",
+          "flowProfileId": "00000000-0000-0000-0000-000000000000",
+          "status": "Obsolete",
+          "description": "Testing 123"
+        }
+      ]
+    }
+  }
+}

specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-05-30-preview/approveConnection.json

@@ -0,0 +1,33 @@
+{
+  "operationId": "Pipelines_ApproveConnection",
+  "parameters": {
+    "api-version": "2025-05-30-preview",
+    "connection": {
+      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection",
+      "statusReason": "Example reason"
+    },
+    "pipelineName": "testPipeline",
+    "resourceGroupName": "testRG",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000"
+  },
+  "title": "Approves the specified connection in a pipeline",
+  "responses": {
+    "200": {
+      "body": {
+        "type": "Microsoft.AzureDataTransfer/connections",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection",
+        "location": "East US",
+        "properties": {
+          "justification": "justification",
+          "pipeline": "testdc",
+          "requirementId": "id"
+        }
+      }
+    },
+    "202": {
+      "headers": {
+        "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-05-30-preview"
+      }
+    }
+  }
+}