Convert Azure Data Transfer to typespec (2025-04-11-preview)

specification/azuredatatransfer/AzureDataTransfer.Management/Connection.tsp

@@ -0,0 +1,115 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+
+using TypeSpec.Rest;
+using Azure.ClientGenerator.Core;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.AzureDataTransfer;
+/**
+ * The connection resource definition.
+ */
+model Connection
+  is Azure.ResourceManager.TrackedResource<ConnectionProperties> {
+  ...ResourceNameParameter<
+    Resource = Connection,
+    KeyName = "connectionName",
+    SegmentName = "connections",
+    NamePattern = "^[a-zA-Z0-9-]{3,64}$"
+  >;
+  ...Azure.ResourceManager.ManagedServiceIdentityProperty;
+}
+
+@armResourceOperations
+interface Connections {
+  /**
+   * Gets connection resource.
+   */
+  get is ArmResourceRead<Connection>;
+
+  /**
+   * Creates or updates the connection resource.
+   */
+  createOrUpdate is ArmResourceCreateOrReplaceAsync<Connection>;
+
+  /**
+   * Updates the connection resource.
+   */
+  #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 })
+  update is ArmCustomPatchAsync<
+    Connection,
+    PatchModel = ConnectionsPatch,
+    Response = ArmResponse<Connection> | (ArmAcceptedLroResponse & {
+      @bodyRoot
+      _: Connection;
+    })
+  >;
+
+  /**
+   * Deletes the connection resource.
+   */
+  delete is ArmResourceDeleteWithoutOkAsync<Connection>;
+
+  /**
+   * Gets connections in a resource group.
+   */
+  listByResourceGroup is ArmResourceListByParent<Connection>;
+
+  /**
+   * Gets connections in a subscription.
+   */
+  listBySubscription is ArmListBySubscription<Connection>;
+
+  /**
+   * Links the connection to its pending connection.
+   */
+  link is ArmResourceActionAsync<
+    Connection,
+    ResourceBody,
+    ArmResponse<Connection>
+  >;
+
+  /**
+   * Lists all pending remote connections that are linkable to this connection.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
+  @action("listPendingConnections")
+  @operationId("ListPendingConnections_List")
+  list is ArmResourceActionSync<
+    Connection,
+    void,
+    ArmResponse<ResourceListCustomResult<PendingConnection>>
+  >;
+
+  /**
+   * Lists all remote flows that have not yet been linked to local flows
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification."
+  @action("listPendingFlows")
+  @operationId("ListPendingFlows_List")
+  listPendingFlowsList is ArmResourceActionSync<
+    Connection,
+    void,
+    ArmResponse<ResourceListCustomResult<PendingFlow>>
+  >;
+}
+
+@@maxLength(Connection.name, 64);
+@@minLength(Connection.name, 3);
+@@doc(Connection.name,
+  "The name for the connection to perform the operation on."
+);
+@@doc(Connection.properties, "Properties of connection");
+@@doc(Connections.createOrUpdate::parameters.resource, "Connection body");
+@@doc(Connections.update::parameters.properties, "Connection body");
+@@doc(Connections.link::parameters.body, "Connection body");
+
+@@clientName(Connections.createOrUpdate::parameters.resource, "connection");
+@@clientName(Connections.update::parameters.properties, "connection");
+@@clientName(Connections.link::parameters.body, "connection");

specification/azuredatatransfer/AzureDataTransfer.Management/Flow.tsp

@@ -0,0 +1,185 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@azure-tools/typespec-client-generator-core";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./Connection.tsp";
+
+using TypeSpec.Rest;
+using Azure.ClientGenerator.Core;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.AzureDataTransfer;
+/**
+ * The flow resource definition.
+ */
+@parentResource(Connection)
+model Flow is Azure.ResourceManager.TrackedResource<FlowProperties> {
+  ...ResourceNameParameter<
+    Resource = Flow,
+    KeyName = "flowName",
+    SegmentName = "flows",
+    NamePattern = "^[a-zA-Z0-9-]{3,64}$"
+  >;
+  ...Azure.ResourceManager.ResourcePlanProperty;
+  ...Azure.ResourceManager.ManagedServiceIdentityProperty;
+}
+
+@armResourceOperations
+interface Flows {
+  /**
+   * Gets flow resource.
+   */
+  get is ArmResourceRead<Flow>;
+
+  /**
+   * Creates or updates the flow resource.
+   */
+  createOrUpdate is ArmResourceCreateOrReplaceAsync<Flow>;
+
+  /**
+   * Updates the flow resource.
+   */
+  #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 })
+  update is ArmCustomPatchAsync<
+    Flow,
+    PatchModel = FlowsPatch,
+    Response = ArmResponse<Flow> | (ArmAcceptedLroResponse & {
+      @bodyRoot
+      _: Flow;
+    })
+  >;
+
+  /**
+   * Deletes the flow resource.
+   */
+  delete is ArmResourceDeleteWithoutOkAsync<Flow>;
+
+  /**
+   * Gets flows in a connection.
+   */
+  listByConnection is ArmResourceListByParent<Flow>;
+
+  /**
+   * Disables the specified flow
+   */
+  disable is ArmResourceActionAsync<Flow, void, ArmResponse<Flow>>;
+
+  /**
+   * Enables the specified flow.
+   */
+  enable is ArmResourceActionAsync<Flow, void, ArmResponse<Flow>>;
+
+  /**
+   * Generate a compliant passphrase for the specified flow.
+   */
+  generatePassphrase is ArmResourceActionAsync<Flow, void, ArmResponse<Flow>>;
+
+  /**
+   * Get the destination endpoint ports for the specified flow.
+   */
+  getDestinationEndpointPorts is ArmResourceActionSync<
+    Flow,
+    void,
+    ArmResponse<GetDestinationEndpointPortsResult>
+  >;
+
+  /**
+   * Get the destination endpoints for the specified flow.
+   */
+  getDestinationEndpoints is ArmResourceActionSync<
+    Flow,
+    void,
+    ArmResponse<GetDestinationEndpointsResult>
+  >;
+
+  /**
+   * Get the source addresses for the specified flow.
+   */
+  getSourceAddresses is ArmResourceActionSync<
+    Flow,
+    void,
+    ArmResponse<StreamSourceAddresses>
+  >;
+
+  /**
+   * Get the connection string for the specified flow.
+   */
+  getStreamConnectionString is ArmResourceActionSync<
+    Flow,
+    void,
+    ArmResponse<GetStreamConnectionStringResult>
+  >;
+
+  /**
+   * Links the specified flow.
+   */
+  link is ArmResourceActionAsync<Flow, ResourceBody, ArmResponse<Flow>>;
+
+  /**
+   * Set the destination endpoint ports for the specified flow.
+   */
+  setDestinationEndpointPorts is ArmResourceActionAsync<
+    Flow,
+    SetDestinationEndpointPorts,
+    ArmResponse<Flow>
+  >;
+
+  /**
+   * Set the destination endpoints for the specified flow.
+   */
+  setDestinationEndpoints is ArmResourceActionAsync<
+    Flow,
+    SetDestinationEndpoints,
+    ArmResponse<Flow>
+  >;
+
+  /**
+   * Sets the passphrase of the specified flow.
+   */
+  setPassphrase is ArmResourceActionAsync<
+    Flow,
+    SetStreamPassphrase,
+    ArmResponse<Flow>
+  >;
+
+  /**
+   * Set the source addresses for the specified flow.
+   */
+  setSourceAddresses is ArmResourceActionAsync<
+    Flow,
+    SetSourceAddresses,
+    ArmResponse<Flow>
+  >;
+}
+
+@@maxLength(Flow.name, 64);
+@@minLength(Flow.name, 3);
+@@doc(Flow.name, "The name for the flow to perform the operation on.");
+@@doc(Flow.properties, "Properties of flow");
+@@doc(Flows.createOrUpdate::parameters.resource, "Flow body");
+@@doc(Flows.update::parameters.properties, "Flow body");
+@@doc(Flows.link::parameters.body, "Flow body");
+@@doc(Flows.setDestinationEndpointPorts::parameters.body,
+  "The destination endpoint ports wanted"
+);
+@@doc(Flows.setDestinationEndpoints::parameters.body,
+  "Destination endpoints wanted."
+);
+@@doc(Flows.setPassphrase::parameters.body, "Passphrase to set");
+@@doc(Flows.setSourceAddresses::parameters.body, "Source addresses wanted");
+@@clientName(Flows.createOrUpdate::parameters.resource, "flow");
+@@clientName(Flows.update::parameters.properties, "flow");
+@@clientName(Flows.link::parameters.body, "flow");
+@@clientName(Flows.setDestinationEndpointPorts::parameters.body,
+  "streamDestinationEndpointPorts"
+);
+@@clientName(Flows.setDestinationEndpoints::parameters.body,
+  "streamDestinationEndpoints"
+);
+@@clientName(Flows.setPassphrase::parameters.body, "passphrase");
+@@clientName(Flows.setSourceAddresses::parameters.body, "sourceAddresses");