diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/Connection.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/Connection.tsp new file mode 100644 index 000000000000..1302fd8bb48e --- /dev/null +++ b/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 { + ...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; + + /** + * Creates or updates the connection resource. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + /** + * 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 | (ArmAcceptedLroResponse & { + @bodyRoot + _: Connection; + }) + >; + + /** + * Deletes the connection resource. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Gets connections in a resource group. + */ + listByResourceGroup is ArmResourceListByParent; + + /** + * Gets connections in a subscription. + */ + listBySubscription is ArmListBySubscription; + + /** + * Links the connection to its pending connection. + */ + link is ArmResourceActionAsync< + Connection, + ResourceBody, + ArmResponse + >; + + /** + * 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> + >; + + /** + * 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> + >; +} + +@@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"); diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/Flow.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/Flow.tsp new file mode 100644 index 000000000000..3ac97c00686f --- /dev/null +++ b/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 { + ...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; + + /** + * Creates or updates the flow resource. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + /** + * 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 | (ArmAcceptedLroResponse & { + @bodyRoot + _: Flow; + }) + >; + + /** + * Deletes the flow resource. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Gets flows in a connection. + */ + listByConnection is ArmResourceListByParent; + + /** + * Disables the specified flow + */ + disable is ArmResourceActionAsync>; + + /** + * Enables the specified flow. + */ + enable is ArmResourceActionAsync>; + + /** + * Generate a compliant passphrase for the specified flow. + */ + generatePassphrase is ArmResourceActionAsync>; + + /** + * Get the destination endpoint ports for the specified flow. + */ + getDestinationEndpointPorts is ArmResourceActionSync< + Flow, + void, + ArmResponse + >; + + /** + * Get the destination endpoints for the specified flow. + */ + getDestinationEndpoints is ArmResourceActionSync< + Flow, + void, + ArmResponse + >; + + /** + * Get the source addresses for the specified flow. + */ + getSourceAddresses is ArmResourceActionSync< + Flow, + void, + ArmResponse + >; + + /** + * Get the connection string for the specified flow. + */ + getStreamConnectionString is ArmResourceActionSync< + Flow, + void, + ArmResponse + >; + + /** + * Links the specified flow. + */ + link is ArmResourceActionAsync>; + + /** + * Set the destination endpoint ports for the specified flow. + */ + setDestinationEndpointPorts is ArmResourceActionAsync< + Flow, + SetDestinationEndpointPorts, + ArmResponse + >; + + /** + * Set the destination endpoints for the specified flow. + */ + setDestinationEndpoints is ArmResourceActionAsync< + Flow, + SetDestinationEndpoints, + ArmResponse + >; + + /** + * Sets the passphrase of the specified flow. + */ + setPassphrase is ArmResourceActionAsync< + Flow, + SetStreamPassphrase, + ArmResponse + >; + + /** + * Set the source addresses for the specified flow. + */ + setSourceAddresses is ArmResourceActionAsync< + Flow, + SetSourceAddresses, + ArmResponse + >; +} + +@@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"); diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/Pipeline.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/Pipeline.tsp new file mode 100644 index 000000000000..23ce191b89aa --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/Pipeline.tsp @@ -0,0 +1,143 @@ +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"; + +using TypeSpec.Rest; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureDataTransfer; +/** + * The pipeline resource definition. + */ +model Pipeline is Azure.ResourceManager.TrackedResource { + ...ResourceNameParameter< + Resource = Pipeline, + KeyName = "pipelineName", + SegmentName = "pipelines", + NamePattern = "^[a-zA-Z0-9-]{3,64}$" + >; + ...Azure.ResourceManager.ManagedServiceIdentityProperty; +} + +@armResourceOperations +interface Pipelines { + /** + * Gets pipeline resource. + */ + get is ArmResourceRead; + + /** + * Creates or updates the pipeline resource. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + /** + * Updates the pipeline 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< + Pipeline, + PatchModel = PipelinesPatch, + Response = ArmResponse | (ArmAcceptedLroResponse & { + @bodyRoot + _: Pipeline; + }) + >; + + /** + * Deletes the pipeline resource. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Gets pipelines in a resource group. + */ + listByResourceGroup is ArmResourceListByParent; + + /** + * Gets pipelines in a subscription. + */ + listBySubscription is ArmListBySubscription; + + /** + * Approves the specified connection request in a pipeline. + */ + approveConnection is ArmResourceActionAsync< + Pipeline, + ResourceBody, + ArmResponse + >; + + /** + * Executes a privileged action for a pipeline. + */ + executeAction is ArmResourceActionAsync< + Pipeline, + Action, + ArmResponse + >; + + /** + * Lists the flows in a pipeline. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification." + @action("listFlows") + @operationId("ListFlowsByPipeline_List") + list is ArmResourceActionSync< + Pipeline, + { + /** + * Connection(s) to retrieve flows of + */ + @bodyRoot + connections?: ConnectionIdList; + }, + ArmResponse + >; + + /** + * Lists the schemas for the specified connection in a pipeline. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification." + @action("listSchemas") + @operationId("ListSchemas_List") + listSchemasList is ArmResourceActionSync< + Pipeline, + Schema, + ArmResponse + >; + + /** + * Rejects the specified connection request in a pipeline. + */ + rejectConnection is ArmResourceActionAsync< + Pipeline, + ResourceBody, + ArmResponse + >; +} + +@@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"); + +@@clientName(Pipelines.createOrUpdate::parameters.resource, "pipeline"); +@@clientName(Pipelines.update::parameters.properties, "pipeline"); +@@clientName(Pipelines.approveConnection::parameters.body, "connection"); +@@clientName(Pipelines.rejectConnection::parameters.body, "connection"); +@@clientName(Pipelines.executeAction::parameters.body, "action"); +@@clientName(Pipelines.listSchemasList::parameters.body, "schema"); diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/ProviderActions.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/ProviderActions.tsp new file mode 100644 index 000000000000..b2d342dec86b --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/ProviderActions.tsp @@ -0,0 +1,47 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +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.OpenAPI; + +namespace Microsoft.AzureDataTransfer; + +#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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification." + @operationId("AzureDataTransfer_listApprovedSchemas") + @autoRoute + listApprovedSchemas is ArmProviderActionSync< + Request = ListApprovedSchemasRequest, + Response = SchemasListResult + >; + /** + * Validates a schema for Azure Data Transfer. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Operation Id generated does not match original OpenAPIv2 JSON specification." + @operationId("AzureDataTransfer_validateSchema") + @autoRoute + validateSchema is ArmProviderActionSync< + Request = Schema, + Response = ValidateSchemaResult + >; +} + +@@clientName(AzureDataTransfer.listApprovedSchemas::parameters.body, + "pipeline" +); +@@clientName(AzureDataTransfer.validateSchema::parameters.body, "schema"); +@@doc(AzureDataTransfer.listApprovedSchemas::parameters.body, + "The request to list approved schemas." +); diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/approveConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/approveConnection.json new file mode 100644 index 000000000000..678b4c917680 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/approveConnection.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pipelines_ApproveConnection", + "parameters": { + "api-version": "2025-04-11-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-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateConnection.json new file mode 100644 index 000000000000..479f77269f5b --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateConnection.json @@ -0,0 +1,44 @@ +{ + "operationId": "Connections_CreateOrUpdate", + "parameters": { + "api-version": "2025-04-11-preview", + "connection": { + "location": "East US", + "properties": { + "justification": "justification", + "pipeline": "testdc", + "requirementId": "id" + } + }, + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Creates or updates the connection resource", + "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" + } + } + }, + "201": { + "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" + } + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateFlow.json new file mode 100644 index 000000000000..db6a0474d52a --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdateFlow.json @@ -0,0 +1,38 @@ +{ + "operationId": "Flows_CreateOrUpdate", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flow": { + "location": "East US", + "properties": { + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + }, + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Creates or updates the flow resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "201": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdatePipeline.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdatePipeline.json new file mode 100644 index 000000000000..0466b022f1dc --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/createOrUpdatePipeline.json @@ -0,0 +1,32 @@ +{ + "operationId": "Pipelines_CreateOrUpdate", + "parameters": { + "api-version": "2025-04-11-preview", + "pipeline": { + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Creates or updates the pipeline resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US" + } + }, + "201": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteConnection.json new file mode 100644 index 000000000000..43590f85b9bc --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteConnection.json @@ -0,0 +1,18 @@ +{ + "operationId": "Connections_Delete", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Deletes the connection resource", + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteFlow.json new file mode 100644 index 000000000000..d1935e28b5cf --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deleteFlow.json @@ -0,0 +1,19 @@ +{ + "operationId": "Flows_Delete", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Deletes the flow resource", + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deletePipeline.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deletePipeline.json new file mode 100644 index 000000000000..f15a787ee421 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/deletePipeline.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pipelines_Delete", + "parameters": { + "api-version": "2025-04-11-preview", + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Deletes the pipeline resource", + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/disableFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/disableFlow.json new file mode 100644 index 000000000000..b86f8ae89b16 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/disableFlow.json @@ -0,0 +1,25 @@ +{ + "operationId": "Flows_Disable", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Disables the specified flow", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableOrDisableFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/enableFlow.json similarity index 91% rename from specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableOrDisableFlow.json rename to specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/enableFlow.json index 3bb170d4ced5..2779b8273f1a 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableOrDisableFlow.json +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/enableFlow.json @@ -1,16 +1,18 @@ { + "operationId": "Flows_Enable", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Enables the specified flow", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/executeAction.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/executeAction.json new file mode 100644 index 000000000000..bd8aadb862d3 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/executeAction.json @@ -0,0 +1,31 @@ +{ + "operationId": "Pipelines_ExecuteAction", + "parameters": { + "action": { + "actionType": "ForceDisable", + "targetType": "Connection", + "targets": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + ] + }, + "api-version": "2025-04-11-preview", + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Executes action for a pipeline", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/generateFlowPassphrase.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/generateFlowPassphrase.json new file mode 100644 index 000000000000..40a395284925 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/generateFlowPassphrase.json @@ -0,0 +1,25 @@ +{ + "operationId": "Flows_GeneratePassphrase", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Generate a new compliant streaming passphrase", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getConnection.json new file mode 100644 index 000000000000..b2c0c3b54e41 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getConnection.json @@ -0,0 +1,19 @@ +{ + "operationId": "Connections_Get", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets connection resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlow.json new file mode 100644 index 000000000000..a826222b9871 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlow.json @@ -0,0 +1,20 @@ +{ + "operationId": "Flows_Get", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets flow resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpointPorts.json new file mode 100644 index 000000000000..f94d84de0d7a --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpointPorts.json @@ -0,0 +1,20 @@ +{ + "operationId": "Flows_GetDestinationEndpointPorts", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the flow stream destination endpoint ports", + "responses": { + "200": { + "body": { + "ports": [ + 1234 + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpoints.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpoints.json new file mode 100644 index 000000000000..e6617c71a1e5 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowDestinationEndpoints.json @@ -0,0 +1,20 @@ +{ + "operationId": "Flows_GetDestinationEndpoints", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the flow stream destination endpoints", + "responses": { + "200": { + "body": { + "endpoints": [ + "10.0.0.1" + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowSourceAddresses.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowSourceAddresses.json new file mode 100644 index 000000000000..61bca161c5f3 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getFlowSourceAddresses.json @@ -0,0 +1,21 @@ +{ + "operationId": "Flows_GetSourceAddresses", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the flow stream source addresses", + "responses": { + "200": { + "body": { + "sourceAddresses": [ + "0.0.0.0", + "1.0.0.0/24" + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getPipeline.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getPipeline.json new file mode 100644 index 000000000000..44bd421e5da0 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getPipeline.json @@ -0,0 +1,19 @@ +{ + "operationId": "Pipelines_Get", + "parameters": { + "api-version": "2025-04-11-preview", + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets pipeline resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getStreamConnectionString.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getStreamConnectionString.json new file mode 100644 index 000000000000..dab82f91a4fd --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/getStreamConnectionString.json @@ -0,0 +1,18 @@ +{ + "operationId": "Flows_GetStreamConnectionString", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the flow stream connection string", + "responses": { + "200": { + "body": { + "connectionString": "https://fmv.usgovirginia.adt.microsoft.com:1234/?passphrase=password123&streamid=1234" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkConnection.json new file mode 100644 index 000000000000..071f1bb3ab6f --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkConnection.json @@ -0,0 +1,27 @@ +{ + "operationId": "Connections_Link", + "parameters": { + "api-version": "2025-04-11-preview", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + }, + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Links the specified connection", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/connection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkFlow.json new file mode 100644 index 000000000000..0d35f330917b --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/linkFlow.json @@ -0,0 +1,28 @@ +{ + "operationId": "Flows_Link", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flow": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" + }, + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Links the specified flow", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsByResourceGroup.json new file mode 100644 index 000000000000..79082015f78c --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "operationId": "Connections_ListByResourceGroup", + "parameters": { + "api-version": "2025-04-11-preview", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets connections in a resource group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "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" + } + }, + { + "name": "testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "location": "East US", + "properties": { + "justification": "justification", + "pipeline": "testdc", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsBySubscription.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsBySubscription.json new file mode 100644 index 000000000000..3b483699209c --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listConnectionsBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "Connections_ListBySubscription", + "parameters": { + "api-version": "2025-04-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets connections in a subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "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" + } + }, + { + "name": "testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "location": "East US", + "properties": { + "justification": "justification", + "pipeline": "testdc", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByConnection.json new file mode 100644 index 000000000000..bbc9def5a90d --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByConnection.json @@ -0,0 +1,46 @@ +{ + "operationId": "Flows_ListByConnection", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets flows in a connection", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "properties": { + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + }, + { + "name": "testConnection2", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", + "location": "East US", + "properties": { + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByPipeline.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByPipeline.json new file mode 100644 index 000000000000..8a59c155d406 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listFlowsByPipeline.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-04-11-preview", + "connections": { + "value": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + ] + }, + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "flows": [ + { + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "properties": { + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + }, + { + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow2", + "location": "East US", + "properties": { + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + } + ], + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + ] + } + } + }, + "operationId": "ListFlowsByPipeline_List", + "title": "Lists flows for a pipeline" +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listOperations.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listOperations.json new file mode 100644 index 000000000000..c8de23845ce3 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listOperations.json @@ -0,0 +1,45 @@ +{ + "operationId": "Operations_List", + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-04-11-preview", + "resourceGroupName": "teleportalClient", + "subscriptionId": "subid" + }, + "title": "List operations", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureDataTransfer/read", + "display": { + "description": "Read flows", + "operation": "Read flows", + "provider": "CTS Experience", + "resource": "Flow" + } + }, + { + "name": "Microsoft.AzureDataTransfer/write", + "display": { + "description": "Update flows", + "operation": "Update flows", + "provider": "CTS Experience", + "resource": "Flow" + } + }, + { + "name": "Microsoft.AzureDataTransfer/delete", + "display": { + "description": "Delete flows", + "operation": "Delete flows", + "provider": "CTS Experience", + "resource": "Flow" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingConnections.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingConnections.json new file mode 100644 index 000000000000..71be1b749af5 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingConnections.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "justification": "justification", + "location": "East US", + "pipeline": "testdc", + "requirementId": "id", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "justification": "justification", + "location": "East US", + "pipeline": "testdc", + "requirementId": "id", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + ] + } + } + }, + "operationId": "ListPendingConnections_List", + "title": "Lists a list of pending connections" +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingFlows.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingFlows.json new file mode 100644 index 000000000000..1fce14cc1774 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPendingFlows.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "flowType": "Blob", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + }, + { + "name": "testInstallation2", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "flowType": "Blob", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + ] + } + } + }, + "operationId": "ListPendingFlows_List", + "title": "Lists a list of pending flows" +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesByResourceGroup.json new file mode 100644 index 000000000000..c61099271fd1 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "operationId": "Pipelines_ListByResourceGroup", + "parameters": { + "api-version": "2025-04-11-preview", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets pipelines in a resource group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesBySubscription.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesBySubscription.json new file mode 100644 index 000000000000..ad690e088d15 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listPipelinesBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "Pipelines_ListBySubscription", + "parameters": { + "api-version": "2025-04-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Gets pipelines in a subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listSchemas.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listSchemas.json new file mode 100644 index 000000000000..65798fa3ad19 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/listSchemas.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "schema": { + "name": "test.xsd", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + }, + "api-version": "2025-04-11-preview", + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + }, + "operationId": "ListSchemas_List", + "title": "Lists schemas for a pipeline" +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchConnection.json new file mode 100644 index 000000000000..864a9b841701 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchConnection.json @@ -0,0 +1,49 @@ +{ + "operationId": "Connections_Update", + "parameters": { + "api-version": "2025-04-11-preview", + "connection": {}, + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tags": { + "tag": "value" + } + }, + "title": "Updates the connection resource", + "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" + }, + "tags": { + "tag": "value" + } + } + }, + "202": { + "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" + }, + "tags": { + "tag": "value" + } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchFlow.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchFlow.json new file mode 100644 index 000000000000..6d126ac1e928 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchFlow.json @@ -0,0 +1,56 @@ +{ + "operationId": "Flows_Update", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flow": {}, + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tags": { + "tag": "value" + } + }, + "title": "Updates the flow resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "properties": { + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + }, + "tags": { + "tag": "value" + } + } + }, + "202": { + "body": { + "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US", + "properties": { + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + }, + "tags": { + "tag": "value" + } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchPipeline.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchPipeline.json new file mode 100644 index 000000000000..edbcb7be1e16 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/patchPipeline.json @@ -0,0 +1,45 @@ +{ + "operationId": "Pipelines_Update", + "parameters": { + "api-version": "2025-04-11-preview", + "pipeline": {}, + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tags": { + "tag": "value" + } + }, + "title": "Updates the pipeline resource", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + }, + "tags": { + "tag": "value" + } + } + }, + "202": { + "body": { + "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + }, + "tags": { + "tag": "value" + } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postListApprovedSchemas.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postListApprovedSchemas.json new file mode 100644 index 000000000000..8cd3adbeeabd --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postListApprovedSchemas.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-04-11-preview", + "pipeline": { + "direction": "Send", + "pipeline": "test" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "title": "Performs action request" +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postValidateSchema.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postValidateSchema.json new file mode 100644 index 000000000000..2e07d2b03489 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/postValidateSchema.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "schema": { + "name": "schema.xml" + }, + "api-version": "2025-04-11-preview" + }, + "responses": { + "200": { + "body": { + "message": "Validation failed", + "status": "Failed" + } + } + }, + "operationId": "AzureDataTransfer_validateSchema", + "title": "Performs action request" +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveOrRejectConnection.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/rejectConnection.json similarity index 85% rename from specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveOrRejectConnection.json rename to specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/rejectConnection.json index 2da25e16e0c0..2c4600b3c954 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveOrRejectConnection.json +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/rejectConnection.json @@ -1,31 +1,33 @@ { + "operationId": "Pipelines_RejectConnection", "parameters": { - "pipelineName": "testPipeline", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "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": "Rejects the specified connection in a pipeline", "responses": { - "202": { - "headers": { - "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } } } } diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpointPorts.json new file mode 100644 index 000000000000..f4c1a6e6718a --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpointPorts.json @@ -0,0 +1,30 @@ +{ + "operationId": "Flows_SetDestinationEndpointPorts", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "streamDestinationEndpointPorts": { + "ports": [ + 1234 + ] + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Set the flow stream destination endpoint ports", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpoints.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpoints.json new file mode 100644 index 000000000000..6b8be8c1d78a --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowDestinationEndpoints.json @@ -0,0 +1,30 @@ +{ + "operationId": "Flows_SetDestinationEndpoints", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "streamDestinationEndpoints": { + "endpoints": [ + "10.0.0.1" + ] + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Set the flow stream destination endpoints", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowPassphrase.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowPassphrase.json new file mode 100644 index 000000000000..0a785c1d8459 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowPassphrase.json @@ -0,0 +1,28 @@ +{ + "operationId": "Flows_SetPassphrase", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "passphrase": { + "value": "password123" + }, + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Set the flow stream passphrase", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowSourceAddresses.json b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowSourceAddresses.json new file mode 100644 index 000000000000..e75b7e908e98 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/examples/2025-04-11-preview/setFlowSourceAddresses.json @@ -0,0 +1,31 @@ +{ + "operationId": "Flows_SetSourceAddresses", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "sourceAddresses": { + "values": [ + "0.0.0.0", + "1.0.0.0/24" + ] + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Set the flow stream source addresses", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/main.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/main.tsp new file mode 100644 index 000000000000..d231b530cf52 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/main.tsp @@ -0,0 +1,47 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: false + * guessResourceKey: false + * Version: 0.11.0 + * Date: 2025-05-13T20:15:12.229Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./Connection.tsp"; +import "./Pipeline.tsp"; +import "./Flow.tsp"; +import "./ProviderActions.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Azure Data Transfer service resource provider + */ +@armProviderNamespace +@service(#{ title: "azuredatatransferrp" }) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AzureDataTransfer; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2025-04-11-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2025_04_11_preview: "2025-04-11-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/models.tsp b/specification/azuredatatransfer/AzureDataTransfer.Management/models.tsp new file mode 100644 index 000000000000..f2163e0d4ca7 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/models.tsp @@ -0,0 +1,1347 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.AzureDataTransfer; + +/** + * Direction of data movement + */ +union Direction { + string, + + /** + * The direction is on the sending side of a pipeline, connection, or flow. + */ + Send: "Send", + + /** + * The direction is on the receiving side side of a pipeline, connection, or flow. + */ + Receive: "Receive", +} + +/** + * Status of the schema. + */ +union SchemaStatus { + string, + + /** + * A schema that has not been approved and is awaiting review. + */ + New: "New", + + /** + * A schema that has been approved and is ready for use. + */ + Approved: "Approved", +} + +/** + * The Schema Type. + */ +union SchemaType { + string, + + /** + * The schema represents a single XML schema definition file. + */ + Xsd: "Xsd", + + /** + * The schema represents a ZIP file with multiple XML schema definition files within it. + */ + Zip: "Zip", +} + +/** + * Validation status of the schema + */ +union ValidateSchemaStatus { + string, + + /** + * Validation of the schema was successful. + */ + Succeeded: "Succeeded", + + /** + * The schema failed validation, whether due to error or an invalid schema. + */ + Failed: "Failed", +} + +/** + * Status of the connection + */ +union ConnectionStatus { + string, + + /** + * This connection has been created but is under review by the pipeline owner. + */ + InReview: "InReview", + + /** + * This connection has been approved by the pipeline owner and is ready for use. + */ + Approved: "Approved", + + /** + * This connection has been rejected by the pipeline owner and cannot be used. + */ + Rejected: "Rejected", + + /** + * Creation of the connection has been accepted. + */ + Accepted: "Accepted", +} + +/** + * Status of force disablement + */ +union ForceDisabledStatus { + string, + + /** + * This Flow has been disabled as the connection has been disabled. + */ + ConnectionForceDisabled: "ConnectionForceDisabled", + + /** + * This Flow has been disabled as the flow type this flow uses has been disabled. + */ + FlowTypeForceDisabled: "FlowTypeForceDisabled", +} + +/** + * Link status of the current pipeline, connection, flow. + */ +union LinkStatus { + string, + + /** + * The pipeline, connection, or flow is currently linked with another corresponding pipeline, + * connection, or flow, and can be used. + */ + Linked: "Linked", + + /** + * The pipeline, connection, or flow is not linked with another corresponding pipeline, + * connection, or flow, and cannot be used. + */ + Unlinked: "Unlinked", +} + +/** + * Flow type for the specified resource + */ +union FlowType { + string, + + /** + * This type of flow is not set. + */ + Unknown: "Unknown", + + /** + * This flow sends complex documents, such as Microsoft Office documents of Portable document format files. + */ + Complex: "Complex", + + /** + * This flow sends source code files and artifacts. + */ + DevSecOps: "DevSecOps", + + /** + * This flow over the Azure Data Transfer low latency messaging subsystem. + */ + Messaging: "Messaging", + + /** + * This flow sends data that will not be processed by any security system. + */ + Mission: "Mission", + + /** + * This flow is assigned to internal Microsoft use cases. + */ + MicrosoftInternal: "MicrosoftInternal", + + /** + * This flow sends blobs that can be used for multiple use cases. + */ + BasicFiles: "BasicFiles", + + /** + * This flow sends blobs that can be used for multiple use cases. + */ + Data: "Data", + + /** + * This flow sends blobs that can be used for multiple use cases. + */ + Standard: "Standard", + + /** + * This flow sends video streams. + */ + StreamingVideo: "StreamingVideo", + + /** + * This flow sends blobs that will not be processed by any security system. + */ + Opaque: "Opaque", + + /** + * This flow sends Extensible Markup Language that will not be processed by any security system. + */ + MissionOpaqueXML: "MissionOpaqueXML", + + /** + * This flow sends blobs that can be used for Virtual Machines. + */ + DiskImages: "DiskImages", + + /** + * This flow sends data via an Application Programmer Interface. + */ + API: "API", +} + +/** + * Provisioning state of the pipeline, connection, flow. + */ +union ProvisioningState { + string, + + /** + * Resource has been created. + */ + Succeeded: "Succeeded", + + /** + * Resource creation failed. + */ + Failed: "Failed", + + /** + * Resource creation was canceled. + */ + Canceled: "Canceled", + + /** + * Resource has been accepted for creation. + */ + Accepted: "Accepted", +} + +/** + * Operation status for the last patch request for this connection. + */ +union OperationStatusEnum { + string, + + /** + * The last patch request for this connection completed with an error. + */ + Failed: "Failed", + + /** + * The last patch request for this connection completed. + */ + Succeeded: "Succeeded", +} + +/** + * Status of the current pipeline + */ +union PipelineStatus { + string, + + /** + * The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. + */ + Enabled: "Enabled", + + /** + * The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. + */ + Disabled: "Disabled", +} + +/** + * Status of the current flow. + */ +union FlowStatus { + string, + + /** + * The flow is currently enabled and able to send or receive data. + */ + Enabled: "Enabled", + + /** + * The flow is currently disabled and cannot send or receive data. + */ + Disabled: "Disabled", +} + +/** + * Transfer Storage Blobs or Tables + */ +union DataType { + string, + + /** + * The flow uses Azure Storage blobs to send or receive data. + */ + Blob: "Blob", + + /** + * The flow uses Azure Storage tables to send or receive data. + */ + Table: "Table", +} + +/** + * Billing tier for this messaging flow. + */ +union FlowBillingTier { + string, + + /** + * Billing tier for messaging processing that charges based on how much data is transferred. + */ + BlobTransport: "BlobTransport", + + /** + * Billing tier for standard messaging processing that charges based on having the messaging resource allocated. + */ + Standard: "Standard", + + /** + * Billing tier for premium messaging processing that charges based on having the messaging resource allocated. + */ + Premium: "Premium", +} + +/** + * Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked + */ +union ApiMode { + string, + + /** + * The API flow will forward calls to a custom Software Development Kit implementation. + */ + SDK: "SDK", + + /** + * The API flow will forward calls to a specified endpoint. + */ + Endpoint: "Endpoint", +} + +/** + * Flag for if Azure Data Transfer API Flow should extract the user token + */ +union IdentityTranslation { + string, + + /** + * The API flow will make use of the user identity that called this API flow, and pass that token + * through the boundary. + */ + UserIdentity: "UserIdentity", + + /** + * The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. + */ + ServiceIdentity: "ServiceIdentity", +} + +/** + * The protocol of the stream + */ +union StreamProtocol { + string, + + /** + * This Flow is using User Datagram Protocol for the video stream. + */ + UDP: "UDP", + + /** + * This Flow is using Secure Reliable Transfer for the video stream. + */ + SRT: "SRT", + + /** + * This Flow is using Real-time Transport Protocol for the video stream. + */ + RTP: "RTP", +} + +/** + * Type of target to execute the action on + */ +union TargetType { + string, + + /** + * The action executing is targeting a pipeline. + */ + Pipeline: "Pipeline", + + /** + * The action executing is targeting a connection. + */ + Connection: "Connection", + + /** + * The action executing is targeting a flow type. + */ + FlowType: "FlowType", +} + +/** + * The request used to list approved schemas within the resource provider. + */ +model ListApprovedSchemasRequest { + /** + * The name of the pipeline to filter approved schemas. + */ + pipeline?: string; + + /** + * The direction pipeline to filter approved schemas. + */ + direction?: Direction; +} + +/** + * The schemas list result. + */ +model SchemasListResult { + /** + * Schemas array. + */ + value?: Schema[]; +} + +/** + * The schema object. + */ +model Schema { + /** + * ID associated with this schema + */ + id?: string; + + /** + * Connection ID associated with this schema + */ + connectionId?: string; + + /** + * Status of the schema + */ + status?: SchemaStatus; + + /** + * Name of the schema + */ + name?: string; + + /** + * Content of the schema + */ + content?: string; + + /** + * The direction of the schema. + */ + direction?: Direction; + + /** + * Uri containing SAS token for the zipped schema + */ + schemaUri?: url; + + /** + * The Schema Type + */ + schemaType?: SchemaType; +} + +/** + * Result of the schema validation. + */ +model ValidateSchemaResult { + /** + * Validation status of the schema + */ + status?: ValidateSchemaStatus; + + /** + * Message describing the schema validation + */ + message?: string; +} + +/** + * Properties of connection + */ +model ConnectionProperties { + /** + * Pipeline to use to transfer data + */ + pipeline: string; + + /** + * Direction of data movement + */ + direction?: Direction; + + /** + * Justification for the connection request + */ + justification?: string; + + /** + * Status of the connection + */ + @visibility(Lifecycle.Read) + status?: ConnectionStatus; + + /** + * Force disablement status of the current connection + */ + @visibility(Lifecycle.Read) + forceDisabledStatus?: ForceDisabledStatus[]; + + /** + * Reason for status + */ + @visibility(Lifecycle.Read) + statusReason?: string; + + /** + * Link status of the current connection + */ + @visibility(Lifecycle.Read) + linkStatus?: LinkStatus; + + /** + * Resource ID of the linked connection + */ + @visibility(Lifecycle.Read) + linkedConnectionId?: string; + + /** + * The flow types being requested for this connection + */ + flowTypes?: FlowType[]; + + /** + * Requirement ID of the connection + */ + requirementId?: string; + + /** + * Subscription ID to link cloud subscriptions together + */ + remoteSubscriptionId?: string; + + /** + * Approver of this connection request + */ + @visibility(Lifecycle.Read) + approver?: string; + + /** + * PIN to link requests together + */ + pin?: string; + + /** + * The timestamp that this connection request was submitted at + */ + @visibility(Lifecycle.Read) + dateSubmitted?: utcDateTime; + + /** + * The primary contact for this connection request + */ + primaryContact?: string; + + /** + * The secondary contacts for this connection request + */ + secondaryContacts?: string[]; + + /** + * Provisioning state of the connection + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policies for this connection + */ + policies?: string[]; + + /** + * The schemas for this connection + */ + schemas?: Schema[]; + + /** + * The schema URIs for this connection + */ + schemaUris?: url[]; +} + +/** + * Properties of pipeline + */ +model PipelineProperties { + /** + * Remote cloud of the data to be transferred or received + */ + remoteCloud: string; + + /** + * Display name of this pipeline + */ + displayName?: string; + + /** + * Connections associated with pipeline + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["id"]) + connections?: Read[]; + + /** + * Subscribers of this resource + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + subscribers?: Subscriber[]; + + /** + * Provisioning state of the pipeline + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policies for this pipeline + */ + policies?: string[]; + + /** + * The flow types allowed for this pipeline + */ + flowTypes?: FlowType[]; + + /** + * The flow types that are disabled for this pipeline + */ + disabledFlowTypes?: FlowType[]; + + /** + * Quarantine Download Storage Account + */ + quarantineDownloadStorageAccount?: string; + + /** + * Quarantine Download Storage Container + */ + quarantineDownloadStorageContainer?: string; + + /** + * Status of the current pipeline + */ + status?: PipelineStatus; +} + +/** + * Connection body inside a pipeline + */ +model PipelineConnection { + ...Record; + + /** + * Connection id inside pipeline + */ + @visibility(Lifecycle.Read) + id: string; + + /** + * Connection name inside pipeline + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Connection type inside pipeline + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * Connection location inside pipeline + */ + @visibility(Lifecycle.Read) + location?: string; + + /** + * Connection etag inside pipeline + */ + @visibility(Lifecycle.Read) + etag?: string; + + /** + * Metadata pertaining to creation and last modification of the resource. + */ + @visibility(Lifecycle.Read) + systemData?: SystemData; + + /** + * Connection properties inside pipeline + */ + @visibility(Lifecycle.Read) + properties?: PipelineConnectionProperties; +} + +/** + * Connection properties inside pipeline + */ +model PipelineConnectionProperties { + ...Record; + + /** + * Internal metadata of the connection inside pipeline. + */ + @visibility(Lifecycle.Read) + internalMetadata?: InternalMetadataProperties; +} + +/** + * Internal metadata of the connection inside pipeline. + */ +model InternalMetadataProperties { + ...Record; + + /** + * Operation status associated with the last patch request + */ + @visibility(Lifecycle.Read) + operationStatus?: OperationStatusProperties; + + /** + * User that last set the approved status for this connection + */ + @visibility(Lifecycle.Read) + statusSetBy?: string; +} + +/** + * Operation status associated with the last patch request + */ +model OperationStatusProperties { + /** + * Operation status for the last patch request for this connection. + */ + @visibility(Lifecycle.Read) + status?: OperationStatusEnum; + + /** + * Operation status ID of the last patch request for this connection. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * Message for the operation for the last patch request for this connection. + */ + @visibility(Lifecycle.Read) + message?: string; +} + +/** + * An individual that would like to subscribe to events that occur on a pipeline. + */ +model Subscriber { + /** + * Email of the subscriber + */ + email?: string; + + /** + * Number specifying what notifications to receive + */ + notifications?: int64; +} + +/** + * The connections resource patch definition. + */ +model ConnectionsPatch { + ...ManagedServiceIdentityProperty; + ...ArmTagsProperty; +} + +/** + * Properties of flow + */ +model FlowProperties { + /** + * The connection associated with this flow + */ + connection?: SelectedResource; + + /** + * Dataflow GUID associated with this flow + */ + @visibility(Lifecycle.Read) + flowId?: string; + + /** + * URI to a Key Vault Secret containing a SAS token. + */ + keyVaultUri?: string; + + /** + * Link status of the current flow + */ + @visibility(Lifecycle.Read) + linkStatus?: LinkStatus; + + /** + * Resource ID of the linked flow + */ + @visibility(Lifecycle.Read) + linkedFlowId?: string; + + /** + * Status of the current flow + */ + status?: FlowStatus; + + /** + * Force disablement status of the current flow + */ + @visibility(Lifecycle.Read) + forceDisabledStatus?: ForceDisabledStatus[]; + + /** + * Storage Account + */ + storageAccountName?: string; + + /** + * Storage Account ID + */ + storageAccountId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Storage/storageAccounts"; + } + ]>; + + /** + * Storage Container Name + */ + storageContainerName?: string; + + /** + * Storage Table Name + */ + storageTableName?: string; + + /** + * Service Bus Queue ID + */ + serviceBusQueueId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Storage/namespaces/queues"; + } + ]>; + + /** + * The flow type for this flow + */ + flowType?: FlowType; + + /** + * Type of data to transfer via the flow. + */ + dataType?: DataType; + + /** + * Provisioning state of the flow + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policies for this flow + */ + policies?: string[]; + + /** + * The selected schema for this flow + */ + schema?: Schema; + + /** + * The messaging options for this flow + */ + messagingOptions?: MessagingOptions; + + /** + * The API Flow configuration options for Azure Data Transfer API Flow type. + */ + apiFlowOptions?: ApiFlowOptions; + + /** + * The URI to the customer managed key for this flow + */ + customerManagedKeyVaultUri?: url; + + /** + * The flow stream identifier + */ + streamId?: string; + + /** + * The protocol of the stream + */ + streamProtocol?: StreamProtocol; + + /** + * The latency of the stream in milliseconds + */ + streamLatency?: int64; + + /** + * The passphrase used for SRT streams + */ + passphrase?: string; + + /** + * The source IP address and CIDR ranges of the stream + */ + sourceAddresses?: StreamSourceAddresses; + + /** + * The destination endpoints of the stream + */ + destinationEndpoints?: string[]; + + /** + * The destination endpoint ports of the stream + */ + destinationEndpointPorts?: int64[]; + + /** + * Event Hub ID + */ + eventHubId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.EventHub/namespaces/eventhubs"; + } + ]>; + + /** + * Event Hub Consumer Group + */ + consumerGroup?: string; +} + +/** + * A resource selected from ARM + */ +model SelectedResource { + /** + * Name of the connection + */ + name?: string; + + /** + * Id of the connection + */ + id: string; + + /** + * Location of the connection + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + location?: string; + + /** + * Name of the subscription with the connection + */ + subscriptionName?: string; +} + +/** + * The option associated with messaging flows. + */ +model MessagingOptions { + /** + * Billing tier for this messaging flow + */ + billingTier?: FlowBillingTier; +} + +/** + * Properties specific to API Flow Type + */ +model ApiFlowOptions { + /** + * Remote host to which communication needs to be made + */ + remoteEndpoint?: string; + + /** + * Unique CNAME to represent the Azure Data Transfer API Flow instance + */ + cname?: string; + + /** + * Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked + */ + apiMode?: ApiMode; + + /** + * Flag for if Azure Data Transfer API Flow should extract the user token + */ + identityTranslation?: IdentityTranslation; + + /** + * Sender's app user assigned Manage Identity client ID + */ + senderClientId?: string; + + /** + * Remote stub app registration Client ID + */ + remoteCallingModeClientId?: string; + + /** + * Optional field to override the audience of the remote endpoint + */ + audienceOverride?: string; +} + +/** + * The source IP address and CIDR ranges of the stream + */ +model StreamSourceAddresses { + /** + * A source IP address or CIDR range + */ + sourceAddresses?: string[]; +} + +/** + * Plan for the resource. + */ +model Plan { + /** + * A user defined name of the 3rd Party Artifact that is being procured. + */ + name: string; + + /** + * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic + */ + publisher: string; + + /** + * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + */ + product: string; + + /** + * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + */ + promotionCode?: string; + + /** + * The version of the desired product/artifact. + */ + version?: string; +} + +/** + * The flows resource patch definition. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/patch-envelope" "Supressing rule to match prior OpenAPI v2 JSON specification, consideration is given on adding the ResourcePlanProperty in future updates." +model FlowsPatch { + ...ManagedServiceIdentityProperty; + ...Azure.ResourceManager.Foundations.ArmTagsProperty; +} + +/** + * List of destination endpoint ports for the flow stream + */ +model GetDestinationEndpointPortsResult { + /** + * The destination endpoint port for the flow stream + */ + ports?: int64[]; +} + +/** + * List of destination endpoints for the flow stream + */ +model GetDestinationEndpointsResult { + /** + * The destination endpoints for the flow stream + */ + endpoints?: string[]; +} + +/** + * The connection string for the specified streaming flow + */ +model GetStreamConnectionStringResult { + /** + * The connection string for the specified streaming flow + */ + connectionString?: string; +} + +/** + * The resource to reference. + */ +model ResourceBody { + /** + * ID of the resource. + */ + id: string; + + /** + * Reason for resource operation. + */ + statusReason?: string; +} + +/** + * Set the destination endpoint ports for the specified flow. + */ +model SetDestinationEndpointPorts { + /** + * The specified flow destination endpoint ports + */ + ports?: int64[]; +} + +/** + * Set the destination endpoints for the specified flow. + */ +model SetDestinationEndpoints { + /** + * The specified flow destination endpoints. + */ + endpoints?: string[]; +} + +/** + * Set the passphrase used for SRT streams + */ +model SetStreamPassphrase { + /** + * The passphrase used for SRT streams + */ + value?: string; +} + +/** + * Set the source addresses for the specified flow. + */ +model SetSourceAddresses { + /** + * Source addresses + */ + values?: string[]; +} + +/** + * Pending connection object + */ +model PendingConnection { + /** + * Subscription ID of the pending connection. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + ...ConnectionProperties; + ...Azure.ResourceManager.CommonTypes.TrackedResource; +} + +/** + * Pending flow object + */ +model PendingFlow { + /** + * Subscription ID of the pending flow. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + /** + * Connection ID of the pending flow. + */ + @visibility(Lifecycle.Read) + connectionId?: string; + + ...FlowProperties; + ...Azure.ResourceManager.CommonTypes.TrackedResource; +} + +/** + * The pipelines resource patch definition. + */ +model PipelinesPatch { + /** + * Properties of pipelines patch body. + */ + properties?: PipelinesPatchProperties; + + ...Azure.ResourceManager.Foundations.ArmTagsProperty; + ...ManagedServiceIdentityProperty; +} + +/** + * Properties of pipelines patch body. + */ +model PipelinesPatchProperties { + /** + * The flow types allowed for this pipeline + */ + flowTypes?: FlowType[]; +} + +/** + * The action to be executed. + */ +model Action { + /** + * Type of action to be executed + */ + actionType: ActionType; + + /** + * Type of target to execute the action on + */ + targetType: TargetType; + + /** + * Targets for the action + */ + targets: string[]; + + /** + * Business justification for the action + */ + justification?: string; +} + +/** + * The type of action to be executed. + */ +union ActionType { + string, + + /** + * Allow a pipeline, connection, or flow to be updated. + */ + AllowUpdates: "AllowUpdates", + + /** + * Force disable a pipeline, connection, or flow. + */ + ForceDisable: "ForceDisable", +} + +/** + * An array of connection id resources. + */ +model ConnectionIdList { + /** + * Connection ID to target + */ + value?: string[]; +} + +/** + * An array of flow resources. + */ +model ListFlowsByPipelineResult { + /** + * List flows by pipeline result by connection + */ + @OpenAPI.extension("x-ms-identifiers", #["id"]) + value?: ListFlowsByPipelineConnection[]; +} + +/** + * A connection resource id in addition to all child flow resources under this connection. + */ +model ListFlowsByPipelineConnection { + /** + * ID of the connection. + */ + id?: string; + + /** + * List of flows associated with the connection. + */ + flows?: Flow[]; +} + +/** + * Azure operation completed successfully. + */ +model AzureResourceManagerArmResponseConnection { + /** + * The body type of the operation request or response. + */ + body: Connection; +} + +/** + * Azure operation completed successfully. + */ +model AzureResourceManagerArmResponseFlow { + /** + * The body type of the operation request or response. + */ + body: Flow; +} + +/** + * Azure operation completed successfully. + */ +model AzureResourceManagerArmResponsePipeline { + /** + * The body type of the operation request or response. + */ + body: Pipeline; +} diff --git a/specification/azuredatatransfer/AzureDataTransfer.Management/tspconfig.yaml b/specification/azuredatatransfer/AzureDataTransfer.Management/tspconfig.yaml new file mode 100644 index 000000000000..29b2884b5277 --- /dev/null +++ b/specification/azuredatatransfer/AzureDataTransfer.Management/tspconfig.yaml @@ -0,0 +1,14 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuredatatransfer.json" + examples-dir: "{project-root}/examples" + emit-lro-options: "all" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/azuredatatransfer.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/azuredatatransfer.json index 882868bdeaf6..6aca349aa961 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/azuredatatransfer.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/azuredatatransfer.json @@ -1,18 +1,23 @@ { "swagger": "2.0", "info": { - "version": "2025-04-11-preview", "title": "azuredatatransferrp", - "description": "Azure Data Transfer service resource provider" + "version": "2025-04-11-preview", + "description": "Azure Data Transfer service resource provider", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, - "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ + "host": "management.azure.com", + "produces": [ "application/json" ], - "produces": [ + "consumes": [ "application/json" ], "security": [ @@ -25,557 +30,649 @@ "securityDefinitions": { "azure_auth": { "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Connections" + }, + { + "name": "Pipelines" + }, + { + "name": "Flows" + } + ], "paths": { - "/providers/Microsoft.AzureDataTransfer/validateSchema": { + "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { "post": { - "description": "Validates a schema for Azure Data Transfer.", - "x-ms-examples": { - "Performs action request": { - "$ref": "examples/postValidateSchema.json" - } - }, - "operationId": "AzureDataTransfer_validateSchema", + "operationId": "AzureDataTransfer_listApprovedSchemas", + "description": "Lists approved schemas for Azure Data Transfer.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "name": "schema", + "name": "pipeline", "in": "body", + "description": "The request to list approved schemas.", "required": true, "schema": { - "$ref": "#/definitions/schema" - }, - "description": "The schema to validate" + "$ref": "#/definitions/ListApprovedSchemasRequest" + } } ], "responses": { "200": { - "description": "Result of the schema validation.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/validateSchemaResult" + "$ref": "#/definitions/SchemasListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Performs action request": { + "$ref": "./examples/postListApprovedSchemas.json" + } } } }, - "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { - "post": { - "description": "Lists approved schemas for Azure Data Transfer.", + "/providers/Microsoft.AzureDataTransfer/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, "x-ms-examples": { - "Performs action request": { - "$ref": "examples/postListApprovedSchemas.json" + "List operations": { + "$ref": "./examples/listOperations.json" } }, - "operationId": "AzureDataTransfer_listApprovedSchemas", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AzureDataTransfer/validateSchema": { + "post": { + "operationId": "AzureDataTransfer_validateSchema", + "description": "Validates a schema for Azure Data Transfer.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "name": "pipeline", + "name": "schema", "in": "body", + "description": "The request body", "required": true, "schema": { - "$ref": "#/definitions/listApprovedSchemasRequest" - }, - "description": "The request to list approved schemas." + "$ref": "#/definitions/Schema" + } } ], "responses": { "200": { - "description": "List of approved schemas.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/schemasListResult" + "$ref": "#/definitions/ValidateSchemaResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Performs action request": { + "$ref": "./examples/postValidateSchema.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections": { "get": { - "description": "Gets flow resource.", - "x-ms-examples": { - "Gets flow resource": { - "$ref": "examples/getFlow.json" - } - }, - "operationId": "Flows_Get", + "operationId": "Connections_ListBySubscription", + "tags": [ + "Connections" + ], + "description": "Gets connections in a subscription.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Retrieved the flows resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/ConnectionListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "put": { - "description": "Creates or updates the flow resource.", - "operationId": "Flows_CreateOrUpdate", + }, "x-ms-examples": { - "Creates or updates the flow resource": { - "$ref": "examples/createOrUpdateFlow.json" + "Gets connections in a subscription": { + "$ref": "./examples/listConnectionsBySubscription.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "operationId": "Pipelines_ListBySubscription", + "tags": [ + "Pipelines" + ], + "description": "Gets pipelines in a subscription.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PipelineListResult" + } }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets pipelines in a subscription": { + "$ref": "./examples/listPipelinesBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "operationId": "Connections_ListByResourceGroup", + "tags": [ + "Connections" + ], + "description": "Gets connections in a resource group.", + "parameters": [ { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "name": "flow", - "description": "Flow body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/flow" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Created the flows resource.", - "schema": { - "$ref": "#/definitions/flow" - } - }, - "201": { - "description": "Accepted creation the flows resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/ConnectionListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes the flow resource.", "x-ms-examples": { - "Deletes the flow resource": { - "$ref": "examples/deleteFlow.json" + "Gets connections in a resource group": { + "$ref": "./examples/listConnectionsByResourceGroup.json" } }, - "operationId": "Flows_Delete", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}": { + "get": { + "operationId": "Connections_Get", + "tags": [ + "Connections" + ], + "description": "Gets connection resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { - "202": { - "description": "Accepted delete the flows resource.", - "headers": { - "location": { - "description": "Location response header", - "type": "string" - } + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Connection" } }, - "204": { - "description": "Deleted the flows resource." - }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - }, - "patch": { - "description": "Updates the flow resource.", - "operationId": "Flows_Update", "x-ms-examples": { - "Updates the flow resource": { - "$ref": "examples/patchFlow.json" + "Gets connection resource": { + "$ref": "./examples/getConnection.json" } - }, + } + }, + "put": { + "operationId": "Connections_CreateOrUpdate", + "tags": [ + "Connections" + ], + "description": "Creates or updates the connection resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "flow", - "description": "Flow body", + "name": "connection", "in": "body", + "description": "Connection body", "required": true, "schema": { - "$ref": "#/definitions/flowsPatch" + "$ref": "#/definitions/Connection" } } ], "responses": { "200": { - "description": "Updated the flows resource.", + "description": "Resource 'Connection' update operation succeeded", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Connection" } }, - "202": { - "description": "Accepted update to the flows resource.", + "201": { + "description": "Resource 'Connection' create operation succeeded", + "schema": { + "$ref": "#/definitions/Connection" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/flow" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates the connection resource": { + "$ref": "./examples/createOrUpdateConnection.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable": { - "post": { - "description": "Enables the specified flow.", - "x-ms-examples": { - "Enables the specified flow": { - "$ref": "examples/enableOrDisableFlow.json" - } + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/Connection" }, - "operationId": "Flows_Enable", + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Connections_Update", + "tags": [ + "Connections" + ], + "description": "Updates the connection resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connection", + "in": "body", + "description": "Connection body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionsPatch" + } } ], "responses": { "200": { - "description": "Enables a flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Connection" } }, "202": { - "description": "Enables a flow.", + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Connection" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable": { - "post": { - "description": "Disables the specified flow", "x-ms-examples": { - "Disables the specified flow": { - "$ref": "examples/enableOrDisableFlow.json" + "Updates the connection resource": { + "$ref": "./examples/patchConnection.json" } }, - "operationId": "Flows_Disable", + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Connections_Delete", + "tags": [ + "Connections" + ], + "description": "Deletes the connection resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { - "200": { - "description": "Disables a flow.", - "schema": { - "$ref": "#/definitions/flow" - } - }, "202": { - "description": "Disables a flow.", + "description": "Resource deletion accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, + "204": { + "description": "Resource does not exist." + }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the connection resource": { + "$ref": "./examples/deleteConnection.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "location" - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link": { - "post": { - "description": "Links the specified flow.", - "x-ms-examples": { - "Links the specified flow": { - "$ref": "examples/linkFlow.json" - } - }, - "operationId": "Flows_Link", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows": { + "get": { + "operationId": "Flows_ListByConnection", + "tags": [ + "Flows" + ], + "description": "Gets flows in a connection.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "flow", - "description": "Flow body", - "in": "body", + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/resourceBody" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Links a flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" - } - }, - "202": { - "description": "Links a flow.", - "headers": { - "location": { - "description": "Location response header", - "type": "string" - } + "$ref": "#/definitions/FlowListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase": { - "post": { - "description": "Sets the passphrase of the specified flow.", "x-ms-examples": { - "Set the flow stream passphrase": { - "$ref": "examples/setFlowPassphrase.json" + "Gets flows in a connection": { + "$ref": "./examples/listFlowsByConnection.json" } }, - "operationId": "Flows_SetPassphrase", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}": { + "get": { + "operationId": "Flows_Get", + "tags": [ + "Flows" + ], + "description": "Gets flow resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "passphrase", - "description": "Passphrase to set", - "in": "body", + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/setStreamPassphrase" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Sets a flow passphrase.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" - } - }, - "202": { - "description": "Sets a flow passphrase.", - "headers": { - "location": { - "description": "Location response header", - "type": "string" - } + "$ref": "#/definitions/Flow" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/generatePassphrase": { - "post": { - "description": "Generate a compliant passphrase for the specified flow.", "x-ms-examples": { - "Generate a new compliant streaming passphrase": { - "$ref": "examples/generateFlowPassphrase.json" + "Gets flow resource": { + "$ref": "./examples/getFlow.json" } - }, - "operationId": "Flows_GeneratePassphrase", + } + }, + "put": { + "operationId": "Flows_CreateOrUpdate", + "tags": [ + "Flows" + ], + "description": "Creates or updates the flow resource.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -583,96 +680,87 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "#/parameters/flowNameParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flow", + "in": "body", + "description": "Flow body", + "required": true, + "schema": { + "$ref": "#/definitions/Flow" + } } ], "responses": { "200": { - "description": "Generate and set the flow passphrase.", + "description": "Resource 'Flow' update operation succeeded", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Flow" } }, - "202": { - "description": "Generate and set the flow passphrase.", + "201": { + "description": "Resource 'Flow' create operation succeeded", + "schema": { + "$ref": "#/definitions/Flow" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getSourceAddresses": { - "post": { - "description": "Get the source addresses for the specified flow.", "x-ms-examples": { - "Get the flow stream source addresses": { - "$ref": "examples/getFlowSourceAddresses.json" + "Creates or updates the flow resource": { + "$ref": "./examples/createOrUpdateFlow.json" } }, - "operationId": "Flows_GetSourceAddresses", + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/Flow" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Flows_Update", + "tags": [ + "Flows" + ], + "description": "Updates the flow resource.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/flowNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The source addresses of the flow.", - "schema": { - "$ref": "#/definitions/streamSourceAddresses" - } }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setSourceAddresses": { - "post": { - "description": "Set the source addresses for the specified flow.", - "x-ms-examples": { - "Set the flow stream source addresses": { - "$ref": "examples/setFlowSourceAddresses.json" - } - }, - "operationId": "Flows_SetSourceAddresses", - "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -680,317 +768,453 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/flowNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "sourceAddresses", - "description": "Source addresses wanted", + "name": "flow", "in": "body", + "description": "Flow body", "required": true, "schema": { - "$ref": "#/definitions/setSourceAddresses" + "$ref": "#/definitions/FlowsPatch" } } ], "responses": { "200": { - "description": "The source addresses of the flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Flow" } }, "202": { - "description": "The source addresses of the flow.", + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Flow" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpoints": { - "post": { - "description": "Get the destination endpoints for the specified flow and stream ID.", "x-ms-examples": { - "Get the flow stream destination endpoints": { - "$ref": "examples/getFlowDestinationEndpoints.json" + "Updates the flow resource": { + "$ref": "./examples/patchFlow.json" } }, - "operationId": "Flows_GetDestinationEndpoints", + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Flows_Delete", + "tags": [ + "Flows" + ], + "description": "Deletes the flow resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { - "200": { - "description": "The destination endpoints of the stream ID on this flow.", - "schema": { - "$ref": "#/definitions/getDestinationEndpointsResult" + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, + "204": { + "description": "Resource does not exist." + }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpoints": { - "post": { - "description": "Set the destination endpoints for the specified flow and stream ID.", + }, "x-ms-examples": { - "Set the flow stream destination endpoints": { - "$ref": "examples/setFlowDestinationEndpoints.json" + "Deletes the flow resource": { + "$ref": "./examples/deleteFlow.json" } }, - "operationId": "Flows_SetDestinationEndpoints", + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable": { + "post": { + "operationId": "Flows_Disable", + "tags": [ + "Flows" + ], + "description": "Disables the specified flow", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "streamDestinationEndpoints", - "description": "Stream ID destination endpoints wanted", - "in": "body", + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/setDestinationEndpoints" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "The destination endpoint of the stream ID on this flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Flow" } }, "202": { - "description": "The destination endpoint of the stream ID on this flow.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Disables the specified flow": { + "$ref": "./examples/disableFlow.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpointPorts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable": { "post": { - "description": "Get the destination endpoint ports for the specified flow and stream ID.", - "x-ms-examples": { - "Get the flow stream destination endpoint ports": { - "$ref": "examples/getFlowDestinationEndpointPorts.json" - } - }, - "operationId": "Flows_GetDestinationEndpointPorts", + "operationId": "Flows_Enable", + "tags": [ + "Flows" + ], + "description": "Enables the specified flow.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "The destination endpoint ports of the stream ID on this flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/getDestinationEndpointPortsResult" + "$ref": "#/definitions/Flow" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpointPorts": { - "post": { - "description": "Set the destination endpoint ports for the specified flow and stream ID.", + }, "x-ms-examples": { - "Set the flow stream destination endpoint ports": { - "$ref": "examples/setFlowDestinationEndpointPorts.json" + "Enables the specified flow": { + "$ref": "./examples/enableFlow.json" } }, - "operationId": "Flows_SetDestinationEndpointPorts", + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/generatePassphrase": { + "post": { + "operationId": "Flows_GeneratePassphrase", + "tags": [ + "Flows" + ], + "description": "Generate a compliant passphrase for the specified flow.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "streamDestinationEndpointPorts", - "description": "Stream ID destination endpoint ports wanted", - "in": "body", + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/setDestinationEndpointPorts" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "The destination endpoint ports of the stream ID on this flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flow" + "$ref": "#/definitions/Flow" } }, "202": { - "description": "The destination endpoint ports of the stream ID on this flow.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Generate a new compliant streaming passphrase": { + "$ref": "./examples/generateFlowPassphrase.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getStreamConnectionString": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpointPorts": { "post": { - "description": "Get the connection string for the specified flow.", - "x-ms-examples": { - "Get the flow stream connection string": { - "$ref": "examples/getStreamConnectionString.json" - } - }, - "operationId": "Flows_GetStreamConnectionString", + "operationId": "Flows_GetDestinationEndpointPorts", + "tags": [ + "Flows" + ], + "description": "Get the destination endpoint ports for the specified flow.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/flowNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Get the connection string for the specified flow.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/getStreamConnectionStringResult" + "$ref": "#/definitions/GetDestinationEndpointPortsResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Get the flow stream destination endpoint ports": { + "$ref": "./examples/getFlowDestinationEndpointPorts.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows": { - "get": { - "description": "Gets flows in a connection.", - "x-ms-examples": { - "Gets flows in a connection": { - "$ref": "examples/listFlowsByConnection.json" - } - }, - "operationId": "Flows_ListByConnection", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpoints": { + "post": { + "operationId": "Flows_GetDestinationEndpoints", + "tags": [ + "Flows" + ], + "description": "Get the destination endpoints for the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -998,41 +1222,58 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Listed all flows under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/flowsListResult" + "$ref": "#/definitions/GetDestinationEndpointsResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "Get the flow stream destination endpoints": { + "$ref": "./examples/getFlowDestinationEndpoints.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}": { - "get": { - "description": "Gets connection resource.", - "x-ms-examples": { - "Gets connection resource": { - "$ref": "examples/getConnection.json" - } - }, - "operationId": "Connections_Get", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getSourceAddresses": { + "post": { + "operationId": "Flows_GetSourceAddresses", + "tags": [ + "Flows" + ], + "description": "Get the source addresses for the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1040,92 +1281,117 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Retrieved the connections resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connection" + "$ref": "#/definitions/StreamSourceAddresses" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "put": { - "description": "Creates or updates the connection resource.", - "operationId": "Connections_CreateOrUpdate", + }, "x-ms-examples": { - "Creates or updates the connection resource": { - "$ref": "examples/createOrUpdateConnection.json" + "Get the flow stream source addresses": { + "$ref": "./examples/getFlowSourceAddresses.json" } - }, + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getStreamConnectionString": { + "post": { + "operationId": "Flows_GetStreamConnectionString", + "tags": [ + "Flows" + ], + "description": "Get the connection string for the specified flow.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "connection", - "description": "Connection body", - "in": "body", + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/connection" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Created the connections resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connection" + "$ref": "#/definitions/GetStreamConnectionStringResult" } }, - "201": { - "description": "Accepted create of the connections resource.", - "schema": { - "$ref": "#/definitions/connection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", + "default": { + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes the connection resource.", "x-ms-examples": { - "Deletes the connection resource": { - "$ref": "examples/deleteConnection.json" + "Get the flow stream connection string": { + "$ref": "./examples/getStreamConnectionString.json" } - }, - "operationId": "Connections_Delete", + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link": { + "post": { + "operationId": "Flows_Link", + "tags": [ + "Flows" + ], + "description": "Links the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1133,46 +1399,86 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "flow", + "in": "body", + "description": "Flow body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceBody" + } } ], "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Flow" + } + }, "202": { - "description": "Accepted delete the connections resource.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, - "204": { - "description": "Deleted the connections resource." - }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - }, - "patch": { - "description": "Updates the connection resource.", - "operationId": "Connections_Update", "x-ms-examples": { - "Updates the connection resource": { - "$ref": "examples/patchConnection.json" + "Links the specified flow": { + "$ref": "./examples/linkFlow.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpointPorts": { + "post": { + "operationId": "Flows_SetDestinationEndpointPorts", + "tags": [ + "Flows" + ], + "description": "Set the destination endpoint ports for the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1180,63 +1486,86 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "connection", - "description": "Connection body", + "name": "streamDestinationEndpointPorts", "in": "body", + "description": "The destination endpoint ports wanted", "required": true, "schema": { - "$ref": "#/definitions/connectionsPatch" + "$ref": "#/definitions/SetDestinationEndpointPorts" } } ], "responses": { "200": { - "description": "Updated the connections resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connection" + "$ref": "#/definitions/Flow" } }, "202": { - "description": "Accepted update to the connections resource.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/connection" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Set the flow stream destination endpoint ports": { + "$ref": "./examples/setFlowDestinationEndpointPorts.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpoints": { "post": { - "description": "Links the connection to its pending connection.", - "x-ms-examples": { - "Links the specified connection": { - "$ref": "examples/linkConnection.json" - } - }, - "operationId": "Connections_Link", + "operationId": "Flows_SetDestinationEndpoints", + "tags": [ + "Flows" + ], + "description": "Set the destination endpoints for the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1244,60 +1573,86 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "connection", - "description": "Connection body", + "name": "streamDestinationEndpoints", "in": "body", + "description": "Destination endpoints wanted.", "required": true, "schema": { - "$ref": "#/definitions/resourceBody" + "$ref": "#/definitions/SetDestinationEndpoints" } } ], "responses": { "200": { - "description": "Links a connection.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connection" + "$ref": "#/definitions/Flow" } }, "202": { - "description": "Links a connection.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Set the flow stream destination endpoints": { + "$ref": "./examples/setFlowDestinationEndpoints.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase": { "post": { - "description": "Lists all pending connections for a connection.", - "x-ms-examples": { - "Lists a list of pending connections": { - "$ref": "examples/listPendingConnections.json" - } - }, - "operationId": "ListPendingConnections_List", + "operationId": "Flows_SetPassphrase", + "tags": [ + "Flows" + ], + "description": "Sets the passphrase of the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1305,41 +1660,86 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "passphrase", + "in": "body", + "description": "Passphrase to set", + "required": true, + "schema": { + "$ref": "#/definitions/SetStreamPassphrase" + } } ], "responses": { "200": { - "description": "Listed all pending connections.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pendingConnectionsListResult" + "$ref": "#/definitions/Flow" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows": { - "post": { - "description": "Lists all pending flows for a connection.", "x-ms-examples": { - "Lists a list of pending flows": { - "$ref": "examples/listPendingFlows.json" + "Set the flow stream passphrase": { + "$ref": "./examples/setFlowPassphrase.json" } }, - "operationId": "ListPendingFlows_List", + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setSourceAddresses": { + "post": { + "operationId": "Flows_SetSourceAddresses", + "tags": [ + "Flows" + ], + "description": "Set the source addresses for the specified flow.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1347,41 +1747,86 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/connectionNameParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "flowName", + "in": "path", + "description": "The name for the flow to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "sourceAddresses", + "in": "body", + "description": "Source addresses wanted", + "required": true, + "schema": { + "$ref": "#/definitions/SetSourceAddresses" + } } ], "responses": { "200": { - "description": "Listed all connections under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pendingFlowsListResult" + "$ref": "#/definitions/Flow" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections": { - "get": { - "description": "Gets connections in a resource group.", "x-ms-examples": { - "Gets connections in a resource group": { - "$ref": "examples/listConnectionsByResourceGroup.json" + "Set the flow stream source addresses": { + "$ref": "./examples/setFlowSourceAddresses.json" } }, - "operationId": "Connections_ListByResourceGroup", + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CFlow%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "post": { + "operationId": "Connections_Link", + "tags": [ + "Connections" + ], + "description": "Links the connection to its pending connection.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1389,558 +1834,642 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "connection", + "in": "body", + "description": "Connection body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceBody" + } } ], "responses": { "200": { - "description": "Listed all connections under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connectionsListResult" + "$ref": "#/definitions/Connection" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections": { - "get": { - "description": "Gets connections in a subscription.", "x-ms-examples": { - "Gets connections in a subscription": { - "$ref": "examples/listConnectionsBySubscription.json" + "Links the specified connection": { + "$ref": "./examples/linkConnection.json" } }, - "operationId": "Connections_ListBySubscription", + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CConnection%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "post": { + "operationId": "ListPendingConnections_List", + "tags": [ + "Connections" + ], + "description": "Lists all pending remote connections that are linkable to this connection.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], "responses": { "200": { - "description": "Listed all connections under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connectionsListResult" + "$ref": "#/definitions/PendingConnectionListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Lists a list of pending connections": { + "$ref": "./examples/listPendingConnections.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}": { - "get": { - "description": "Gets pipeline resource.", - "x-ms-examples": { - "Gets pipeline resource": { - "$ref": "examples/getPipeline.json" - } - }, - "operationId": "Pipelines_Get", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows": { + "post": { + "operationId": "ListPendingFlows_List", + "tags": [ + "Connections" + ], + "description": "Lists all remote flows that have not yet been linked to local flows", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "connectionName", + "in": "path", + "description": "The name for the connection to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { "200": { - "description": "Retrieved the pipelines resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pipeline" + "$ref": "#/definitions/PendingFlowListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "put": { - "description": "Creates or updates the pipeline resource.", - "operationId": "Pipelines_CreateOrUpdate", + }, "x-ms-examples": { - "Creates or updates the pipeline resource": { - "$ref": "examples/createOrUpdatePipeline.json" + "Lists a list of pending flows": { + "$ref": "./examples/listPendingFlows.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "operationId": "Pipelines_ListByResourceGroup", + "tags": [ + "Pipelines" + ], + "description": "Gets pipelines in a resource group.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "name": "pipeline", - "description": "Pipeline body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/pipeline" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Created the pipelines resource.", - "schema": { - "$ref": "#/definitions/pipeline" - } - }, - "201": { - "description": "Accepted create of the pipelines resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pipeline" + "$ref": "#/definitions/PipelineListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes the pipeline resource.", "x-ms-examples": { - "Deletes the pipeline resource": { - "$ref": "examples/deletePipeline.json" + "Gets pipelines in a resource group": { + "$ref": "./examples/listPipelinesByResourceGroup.json" } }, - "operationId": "Pipelines_Delete", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}": { + "get": { + "operationId": "Pipelines_Get", + "tags": [ + "Pipelines" + ], + "description": "Gets pipeline resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { - "202": { - "description": "Accepted delete of the pipelines resource.", - "headers": { - "location": { - "description": "Location response header", - "type": "string" - } + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pipeline" } }, - "204": { - "description": "Deleted the pipelines resource." - }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - }, - "patch": { - "description": "Updates the pipeline resource.", - "operationId": "Pipelines_Update", "x-ms-examples": { - "Updates the pipeline resource": { - "$ref": "examples/patchPipeline.json" + "Gets pipeline resource": { + "$ref": "./examples/getPipeline.json" } - }, + } + }, + "put": { + "operationId": "Pipelines_CreateOrUpdate", + "tags": [ + "Pipelines" + ], + "description": "Creates or updates the pipeline resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "pipeline", - "description": "Pipeline body", "in": "body", + "description": "Pipeline body", "required": true, "schema": { - "$ref": "#/definitions/pipelinesPatch" + "$ref": "#/definitions/Pipeline" } } ], "responses": { "200": { - "description": "Updated the pipelines resource.", + "description": "Resource 'Pipeline' update operation succeeded", "schema": { - "$ref": "#/definitions/pipeline" + "$ref": "#/definitions/Pipeline" } }, - "202": { - "description": "Accepted update to the pipelines resource.", + "201": { + "description": "Resource 'Pipeline' create operation succeeded", + "schema": { + "$ref": "#/definitions/Pipeline" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/pipeline" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection": { - "post": { - "description": "Approves the specified connection in a pipeline.", "x-ms-examples": { - "Approves the specified connection in a pipeline": { - "$ref": "examples/approveOrRejectConnection.json" + "Creates or updates the pipeline resource": { + "$ref": "./examples/createOrUpdatePipeline.json" } }, - "operationId": "Pipelines_ApproveConnection", + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/Pipeline" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Pipelines_Update", + "tags": [ + "Pipelines" + ], + "description": "Updates the pipeline resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "connection", - "description": "Connection body", + "name": "pipeline", "in": "body", + "description": "Pipeline body", "required": true, "schema": { - "$ref": "#/definitions/resourceBody" + "$ref": "#/definitions/PipelinesPatch" } } ], "responses": { "200": { - "description": "Approves a connection.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/connection" + "$ref": "#/definitions/Pipeline" } }, "202": { - "description": "Approves a connection.", + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Pipeline" + }, "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection": { - "post": { - "description": "Rejects the specified connection in a pipeline.", "x-ms-examples": { - "Rejects the specified connection in a pipeline": { - "$ref": "examples/approveOrRejectConnection.json" + "Updates the pipeline resource": { + "$ref": "./examples/patchPipeline.json" } }, - "operationId": "Pipelines_RejectConnection", + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Pipelines_Delete", + "tags": [ + "Pipelines" + ], + "description": "Deletes the pipeline resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "connection", - "description": "Connection body", - "in": "body", + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", "required": true, - "schema": { - "$ref": "#/definitions/resourceBody" - } + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" } ], "responses": { - "200": { - "description": "Rejects a connection.", - "schema": { - "$ref": "#/definitions/connection" - } - }, "202": { - "description": "Rejects a connection.", + "description": "Resource deletion accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, + "204": { + "description": "Resource does not exist." + }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the pipeline resource": { + "$ref": "./examples/deletePipeline.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "location" - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection": { "post": { - "description": "Lists the schemas for the specified connection in a pipeline.", - "x-ms-examples": { - "Lists schemas for a pipeline": { - "$ref": "examples/listSchemas.json" - } - }, - "operationId": "ListSchemas_List", + "operationId": "Pipelines_ApproveConnection", + "tags": [ + "Pipelines" + ], + "description": "Approves the specified connection request in a pipeline.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { - "name": "schema", - "description": "Schema(s) to retrieve", + "name": "connection", "in": "body", + "description": "Connection body", "required": true, "schema": { - "$ref": "#/definitions/schema" + "$ref": "#/definitions/ResourceBody" } } ], "responses": { "200": { - "description": "Approves a connection.", + "description": "Azure operation completed successfully.", "schema": { - "description": "The schemas for this connection", - "$ref": "#/definitions/schemasListResult" + "$ref": "#/definitions/Connection" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listFlows": { - "post": { - "description": "Lists the flows in a pipeline.", + }, "x-ms-examples": { - "Lists flows for a pipeline": { - "$ref": "examples/listFlowsByPipeline.json" + "Approves the specified connection in a pipeline": { + "$ref": "./examples/approveConnection.json" } }, - "operationId": "ListFlowsByPipeline_List", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/pipelineNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "connections", - "description": "Connection(s) to retrieve flows of", - "in": "body", - "schema": { - "$ref": "#/definitions/connectionIdList" - } - } - ], - "responses": { - "200": { - "description": "List flows for a pipeline.", - "schema": { - "description": "The flows for this pipeline", - "$ref": "#/definitions/listFlowsByPipelineResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CConnection%3E" + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/executeAction": { "post": { - "description": "Executes a privileged action for a pipeline.", - "x-ms-examples": { - "Executes action for a pipeline": { - "$ref": "examples/executeAction.json" - } - }, "operationId": "Pipelines_ExecuteAction", + "tags": [ + "Pipelines" + ], + "description": "Executes a privileged action for a pipeline.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/pipelineNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" }, { "name": "action", - "description": "Action to execute", "in": "body", + "description": "Action to execute", "required": true, "schema": { - "$ref": "#/definitions/action" + "$ref": "#/definitions/Action" } } ], "responses": { "200": { - "description": "Executed the action.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pipeline" + "$ref": "#/definitions/Pipeline" } }, "202": { - "description": "Started execution of the action.", + "description": "Resource operation accepted.", "headers": { - "location": { - "description": "Location response header", - "type": "string" + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines": { - "get": { - "description": "Gets pipelines in a resource group.", "x-ms-examples": { - "Gets pipelines in a resource group": { - "$ref": "examples/listPipelinesByResourceGroup.json" + "Executes action for a pipeline": { + "$ref": "./examples/executeAction.json" } }, - "operationId": "Pipelines_ListByResourceGroup", + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CPipeline%3E" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listFlows": { + "post": { + "operationId": "ListFlowsByPipeline_List", + "tags": [ + "Pipelines" + ], + "description": "Lists the flows in a pipeline.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1948,522 +2477,418 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "connections", + "in": "body", + "description": "Connection(s) to retrieve flows of", + "required": false, + "schema": { + "$ref": "#/definitions/ConnectionIdList" + } } ], "responses": { "200": { - "description": "Listed all pipelines under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pipelinesListResult" + "$ref": "#/definitions/ListFlowsByPipelineResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "Lists flows for a pipeline": { + "$ref": "./examples/listFlowsByPipeline.json" + } } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines": { - "get": { - "description": "Gets pipelines in a subscription.", - "x-ms-examples": { - "Gets pipelines in a subscription": { - "$ref": "examples/listPipelinesBySubscription.json" - } - }, - "operationId": "Pipelines_ListBySubscription", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "post": { + "operationId": "ListSchemas_List", + "tags": [ + "Pipelines" + ], + "description": "Lists the schemas for the specified connection in a pipeline.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "schema", + "in": "body", + "description": "Schema(s) to retrieve", + "required": true, + "schema": { + "$ref": "#/definitions/Schema" + } } ], "responses": { "200": { - "description": "Listed all pipelines under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/pipelinesListResult" + "$ref": "#/definitions/SchemasListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "Lists schemas for a pipeline": { + "$ref": "./examples/listSchemas.json" + } } } }, - "/providers/Microsoft.AzureDataTransfer/operations": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection": { + "post": { + "operationId": "Pipelines_RejectConnection", "tags": [ - "Operations" + "Pipelines" ], - "operationId": "Operations_List", - "x-ms-examples": { - "List operations": { - "$ref": "./examples/listOperations.json" - } - }, - "description": "Lists all of the available Microsoft.AzureDataTransfer REST API operations.", + "description": "Rejects the specified connection request in a pipeline.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pipelineName", + "in": "path", + "description": "The name for the pipeline to perform the operation on.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "connection", + "in": "body", + "description": "Connection body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceBody" + } } ], "responses": { "200": { - "description": "Listed all of the available operations.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + "$ref": "#/definitions/Connection" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "x-ms-examples": { + "Rejects the specified connection in a pipeline": { + "$ref": "./examples/rejectConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Azure.ResourceManager.ArmResponse%3CConnection%3E" + }, + "x-ms-long-running-operation": true } } }, "definitions": { - "validateSchemaResult": { + "Action": { "type": "object", - "description": "Result of the schema validation.", + "description": "The action to be executed.", "properties": { - "status": { - "enum": [ - "Succeeded", - "Failed" - ], - "type": "string", - "x-ms-enum": { - "name": "validateSchemaStatus", - "modelAsString": true - }, - "description": "Validation status of the schema" + "actionType": { + "$ref": "#/definitions/ActionType", + "description": "Type of action to be executed" }, - "message": { + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Type of target to execute the action on" + }, + "targets": { + "type": "array", + "description": "Targets for the action", + "items": { + "type": "string" + } + }, + "justification": { "type": "string", - "description": "Message describing the schema validation" + "description": "Business justification for the action" } - } + }, + "required": [ + "actionType", + "targetType", + "targets" + ] }, - "listApprovedSchemasRequest": { - "type": "object", - "properties": { - "pipeline": { - "type": "string", - "description": "The name of the pipeline to filter approved schemas." - }, - "direction": { - "description": "The direction pipeline to filter approved schemas.", - "enum": [ - "Send", - "Receive" - ], - "type": "string", - "x-ms-enum": { - "name": "listApprovedSchemasDirection", - "modelAsString": true + "ActionType": { + "type": "string", + "description": "The type of action to be executed.", + "enum": [ + "AllowUpdates", + "ForceDisable" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "name": "AllowUpdates", + "value": "AllowUpdates", + "description": "Allow a pipeline, connection, or flow to be updated." + }, + { + "name": "ForceDisable", + "value": "ForceDisable", + "description": "Force disable a pipeline, connection, or flow." } - } + ] } }, - "selectedResource": { + "ApiFlowOptions": { "type": "object", - "description": "A resource selected from ARM", + "description": "Properties specific to API Flow Type", "properties": { - "name": { + "remoteEndpoint": { "type": "string", - "description": "Name of the connection" + "description": "Remote host to which communication needs to be made" }, - "id": { + "cname": { "type": "string", - "description": "Id of the connection" + "description": "Unique CNAME to represent the Azure Data Transfer API Flow instance" }, - "location": { - "type": "string", - "description": "Location of the connection", - "x-ms-mutability": [ - "create", - "read" - ] + "apiMode": { + "$ref": "#/definitions/ApiMode", + "description": "Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked" }, - "subscriptionName": { - "type": "string", - "description": "Name of the subscription with the connection" - } - }, - "required": [ - "id" - ] - }, - "flowProperties": { - "type": "object", - "properties": { - "connection": { - "$ref": "#/definitions/selectedResource", - "description": "The connection associated with this flow" + "identityTranslation": { + "$ref": "#/definitions/IdentityTranslation", + "description": "Flag for if Azure Data Transfer API Flow should extract the user token" }, - "flowId": { + "senderClientId": { "type": "string", - "description": "Dataflow GUID associated with this flow", - "readOnly": true + "description": "Sender's app user assigned Manage Identity client ID" }, - "keyVaultUri": { + "remoteCallingModeClientId": { "type": "string", - "description": "AME, PME, or TORUS only! AKV Chain Containing SAS Token" + "description": "Remote stub app registration Client ID" }, - "linkStatus": { - "enum": [ - "Linked", - "Unlinked" - ], + "audienceOverride": { "type": "string", - "x-ms-enum": { - "name": "linkStatusFlow", - "modelAsString": true - }, - "description": "Link status of the current flow", - "readOnly": true - }, - "linkedFlowId": { - "type": "string", - "description": "Resource ID of the linked flow", - "readOnly": true - }, - "status": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "flowStatus", - "modelAsString": true - }, - "description": "Status of the current flow" - }, - "forceDisabledStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/forceDisabledStatus" - }, - "description": "Force disablement status of the current flow", - "readOnly": true - }, - "storageAccountName": { - "type": "string", - "description": "Storage Account" - }, - "storageAccountId": { - "type": "string", - "format": "arm-id", - "description": "Storage Account ID", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "scopes": [ - "*" - ], - "type": "Microsoft.Storage/storageAccounts" - } - ] - } - }, - "storageContainerName": { - "type": "string", - "description": "Storage Container Name" - }, - "storageTableName": { - "type": "string", - "description": "Storage Table Name" - }, - "serviceBusQueueId": { - "type": "string", - "format": "arm-id", - "description": "Service Bus Queue ID", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "scopes": [ - "*" - ], - "type": "Microsoft.Storage/namespaces/queues" - } - ] - } - }, - "flowType": { - "$ref": "#/definitions/flowType", - "description": "The flow type for this flow" - }, - "dataType": { - "enum": [ - "Blob", - "Table" - ], - "type": "string", - "x-ms-enum": { - "name": "dataType", - "modelAsString": true - }, - "description": "Transfer Storage Blobs or Tables" - }, - "provisioningState": { - "description": "Provisioning state of the flow", - "enum": [ - "Failed", - "Succeeded", - "Canceled", - "Accepted" - ], - "type": "string", - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true + "description": "Optional field to override the audience of the remote endpoint" + } + } + }, + "ApiMode": { + "type": "string", + "description": "Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked", + "enum": [ + "SDK", + "Endpoint" + ], + "x-ms-enum": { + "name": "ApiMode", + "modelAsString": true, + "values": [ + { + "name": "SDK", + "value": "SDK", + "description": "The API flow will forward calls to a custom Software Development Kit implementation." }, - "readOnly": true - }, - "policies": { - "type": "array", - "description": "The policies for this flow", - "items": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/schema", - "description": "The selected schema for this flow" - }, - "messagingOptions": { - "$ref": "#/definitions/messagingOptions", - "description": "The messaging options for this flow" - }, - "apiFlowOptions": { - "$ref": "#/definitions/apiFlowOptions", - "description": "The API Flow configuration options for Azure Data Transfer API Flow type." - }, - "customerManagedKeyVaultUri": { - "type": "string", - "format": "url", - "description": "The URI to the customer managed key for this flow" - }, - "streamId": { - "type": "string", - "description": "The flow stream identifier" - }, - "streamProtocol": { - "description": "The protocol of the stream", - "enum": [ - "UDP", - "SRT", - "RTP" - ], - "type": "string", - "x-ms-enum": { - "name": "streamProtocol", - "modelAsString": true - } - }, - "streamLatency": { - "type": "integer", - "format": "int64", - "description": "The latency of the stream in milliseconds" - }, - "passphrase": { - "type": "string", - "description": "The passphrase used for SRT streams" - }, - "sourceAddresses": { - "$ref": "#/definitions/streamSourceAddresses", - "description": "The source IP address and CIDR ranges of the stream" - }, - "destinationEndpoints": { - "type": "array", - "description": "The destination endpoints of the stream", - "items": { - "type": "string" - } - }, - "destinationEndpointPorts": { - "type": "array", - "description": "The destination endpoint ports of the stream", - "items": { - "type": "integer", - "format": "int64" - } - }, - "eventHubId": { - "type": "string", - "format": "arm-id", - "description": "Event Hub ID", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "scopes": [ - "*" - ], - "type": "Microsoft.EventHub/namespaces/eventhubs" - } - ] + { + "name": "Endpoint", + "value": "Endpoint", + "description": "The API flow will forward calls to a specified endpoint." } - }, - "consumerGroup": { - "type": "string", - "description": "Event Hub Consumer Group" + ] + } + }, + "Azure.Core.armResourceType": { + "type": "string", + "description": "Represents an Azure Resource Type." + }, + "Azure.ResourceManager.ArmResponse": { + "type": "object", + "description": "Azure operation completed successfully.", + "properties": { + "body": { + "$ref": "#/definitions/Connection", + "description": "The body type of the operation request or response." } }, - "description": "Properties of flow" + "required": [ + "body" + ] }, - "flow": { + "Azure.ResourceManager.ArmResponse": { "type": "object", - "x-ms-azure-resource": true, + "description": "Azure operation completed successfully.", "properties": { - "properties": { - "$ref": "#/definitions/flowProperties" - }, - "plan": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan" - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the flow resource, if configured." + "body": { + "$ref": "#/definitions/Flow", + "description": "The body type of the operation request or response." } }, "required": [ - "location" - ], - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + "body" + ] + }, + "Azure.ResourceManager.ArmResponse": { + "type": "object", + "description": "Azure operation completed successfully.", + "properties": { + "body": { + "$ref": "#/definitions/Pipeline", + "description": "The body type of the operation request or response." } - ], - "description": "The flow resource definition." + }, + "required": [ + "body" + ] }, - "pendingFlow": { + "Connection": { "type": "object", - "description": "Pending flow object", + "description": "The connection resource definition.", "properties": { - "subscriptionId": { - "type": "string", - "description": "Subscription ID of the pending flow.", - "readOnly": true + "properties": { + "$ref": "#/definitions/ConnectionProperties", + "description": "Properties of connection" }, - "connectionId": { - "type": "string", - "description": "Connection ID of the pending flow.", - "readOnly": true + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." } }, "allOf": [ - { - "$ref": "#/definitions/flowProperties" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, - "flowsPatch": { + "ConnectionIdList": { "type": "object", + "description": "An array of connection id resources.", "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the flow resource, if configured." - }, - "tags": { - "type": "object", - "additionalProperties": { + "value": { + "type": "array", + "description": "Connection ID to target", + "items": { "type": "string" - }, - "description": "Resource tags" + } } - }, - "description": "The flows resource patch definition." + } }, - "flowsListResult": { + "ConnectionListResult": { "type": "object", + "description": "The response of a Connection list operation.", "properties": { "value": { "type": "array", + "description": "The Connection items on this page", "items": { - "$ref": "#/definitions/flow" - }, - "description": "Flows array.", - "x-ms-identifiers": [ - "id" - ] + "$ref": "#/definitions/Connection" + } }, "nextLink": { - "description": "Link to next results", - "type": "string" + "type": "string", + "format": "uri", + "description": "The link to the next page of items" } }, - "description": "The flows list result." + "required": [ + "value" + ] }, - "connectionProperties": { + "ConnectionProperties": { "type": "object", + "description": "Properties of connection", "properties": { "pipeline": { "type": "string", "description": "Pipeline to use to transfer data" }, "direction": { - "description": "Direction of data movement", - "enum": [ - "Send", - "Receive" - ], - "type": "string", - "x-ms-enum": { - "name": "direction", - "modelAsString": true - } + "$ref": "#/definitions/Direction", + "description": "Direction of data movement" }, "justification": { "type": "string", "description": "Justification for the connection request" }, "status": { + "$ref": "#/definitions/ConnectionStatus", "description": "Status of the connection", - "enum": [ - "InReview", - "Approved", - "Rejected", - "Accepted" - ], - "type": "string", - "x-ms-enum": { - "name": "status", - "modelAsString": true - }, "readOnly": true }, "forceDisabledStatus": { "type": "array", + "description": "Force disablement status of the current connection", "items": { - "$ref": "#/definitions/forceDisabledStatus" + "$ref": "#/definitions/ForceDisabledStatus" }, - "description": "Force disablement status of the current connection", "readOnly": true }, "statusReason": { @@ -2472,15 +2897,7 @@ "readOnly": true }, "linkStatus": { - "enum": [ - "Linked", - "Unlinked" - ], - "type": "string", - "x-ms-enum": { - "name": "linkStatus", - "modelAsString": true - }, + "$ref": "#/definitions/LinkStatus", "description": "Link status of the current connection", "readOnly": true }, @@ -2490,25 +2907,28 @@ "readOnly": true }, "flowTypes": { - "$ref": "#/definitions/flowTypes", - "description": "The flow types being requested for this connection" + "type": "array", + "description": "The flow types being requested for this connection", + "items": { + "$ref": "#/definitions/FlowType" + } }, "requirementId": { - "description": "Requirement ID of the connection", - "type": "string" + "type": "string", + "description": "Requirement ID of the connection" }, "remoteSubscriptionId": { - "description": "Subscription ID to link cloud subscriptions together", - "type": "string" + "type": "string", + "description": "Subscription ID to link cloud subscriptions together" }, "approver": { - "description": "Approver of this connection request", "type": "string", + "description": "Approver of this connection request", "readOnly": true }, "pin": { - "description": "PIN to link requests together", - "type": "string" + "type": "string", + "description": "PIN to link requests together" }, "dateSubmitted": { "type": "string", @@ -2528,18 +2948,8 @@ } }, "provisioningState": { + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the connection", - "enum": [ - "Failed", - "Succeeded", - "Canceled", - "Accepted" - ], - "type": "string", - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - }, "readOnly": true }, "policies": { @@ -2550,237 +2960,1151 @@ } }, "schemas": { + "type": "array", "description": "The schemas for this connection", - "$ref": "#/definitions/schemas" + "items": { + "$ref": "#/definitions/Schema" + } }, "schemaUris": { - "description": "The schema URIs for this connection", "type": "array", + "description": "The schema URIs for this connection", "items": { "type": "string", - "format": "url" + "format": "uri" } } }, "required": [ "pipeline" + ] + }, + "ConnectionStatus": { + "type": "string", + "description": "Status of the connection", + "enum": [ + "InReview", + "Approved", + "Rejected", + "Accepted" ], - "description": "Properties of connection" + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true, + "values": [ + { + "name": "InReview", + "value": "InReview", + "description": "This connection has been created but is under review by the pipeline owner." + }, + { + "name": "Approved", + "value": "Approved", + "description": "This connection has been approved by the pipeline owner and is ready for use." + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "This connection has been rejected by the pipeline owner and cannot be used." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Creation of the connection has been accepted." + } + ] + } }, - "connection": { + "ConnectionsPatch": { "type": "object", - "x-ms-azure-resource": true, + "description": "The connections resource patch definition.", "properties": { - "properties": { - "$ref": "#/definitions/connectionProperties" - }, "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the connection resource, if configured." + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } } - }, - "required": [ - "location" - ], - "allOf": [ + } + }, + "DataType": { + "type": "string", + "description": "Transfer Storage Blobs or Tables", + "enum": [ + "Blob", + "Table" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "name": "Blob", + "value": "Blob", + "description": "The flow uses Azure Storage blobs to send or receive data." + }, + { + "name": "Table", + "value": "Table", + "description": "The flow uses Azure Storage tables to send or receive data." + } + ] + } + }, + "Direction": { + "type": "string", + "description": "Direction of data movement", + "enum": [ + "Send", + "Receive" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "Send", + "value": "Send", + "description": "The direction is on the sending side of a pipeline, connection, or flow." + }, + { + "name": "Receive", + "value": "Receive", + "description": "The direction is on the receiving side side of a pipeline, connection, or flow." + } + ] + } + }, + "Flow": { + "type": "object", + "description": "The flow resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/FlowProperties", + "description": "Properties of flow" + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } + ] + }, + "FlowBillingTier": { + "type": "string", + "description": "Billing tier for this messaging flow.", + "enum": [ + "BlobTransport", + "Standard", + "Premium" ], - "description": "The connection resource definition." + "x-ms-enum": { + "name": "FlowBillingTier", + "modelAsString": true, + "values": [ + { + "name": "BlobTransport", + "value": "BlobTransport", + "description": "Billing tier for messaging processing that charges based on how much data is transferred." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Billing tier for standard messaging processing that charges based on having the messaging resource allocated." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Billing tier for premium messaging processing that charges based on having the messaging resource allocated." + } + ] + } }, - "pendingConnection": { + "FlowListResult": { "type": "object", - "description": "Pending connection object", + "description": "The response of a Flow list operation.", "properties": { - "subscriptionId": { + "value": { + "type": "array", + "description": "The Flow items on this page", + "items": { + "$ref": "#/definitions/Flow" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FlowProperties": { + "type": "object", + "description": "Properties of flow", + "properties": { + "connection": { + "$ref": "#/definitions/SelectedResource", + "description": "The connection associated with this flow" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "URI to a Key Vault Secret containing a SAS token." + }, + "linkStatus": { + "$ref": "#/definitions/LinkStatus", + "description": "Link status of the current flow", + "readOnly": true + }, + "linkedFlowId": { + "type": "string", + "description": "Resource ID of the linked flow", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FlowStatus", + "description": "Status of the current flow" + }, + "forceDisabledStatus": { + "type": "array", + "description": "Force disablement status of the current flow", + "items": { + "$ref": "#/definitions/ForceDisabledStatus" + }, + "readOnly": true + }, + "storageAccountName": { + "type": "string", + "description": "Storage Account" + }, + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Storage Account ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageContainerName": { + "type": "string", + "description": "Storage Container Name" + }, + "storageTableName": { + "type": "string", + "description": "Storage Table Name" + }, + "serviceBusQueueId": { + "type": "string", + "format": "arm-id", + "description": "Service Bus Queue ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/namespaces/queues" + } + ] + } + }, + "flowType": { + "$ref": "#/definitions/FlowType", + "description": "The flow type for this flow" + }, + "dataType": { + "$ref": "#/definitions/DataType", + "description": "Type of data to transfer via the flow." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the flow", + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this flow", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Schema", + "description": "The selected schema for this flow" + }, + "messagingOptions": { + "$ref": "#/definitions/MessagingOptions", + "description": "The messaging options for this flow" + }, + "apiFlowOptions": { + "$ref": "#/definitions/ApiFlowOptions", + "description": "The API Flow configuration options for Azure Data Transfer API Flow type." + }, + "customerManagedKeyVaultUri": { + "type": "string", + "format": "uri", + "description": "The URI to the customer managed key for this flow" + }, + "streamId": { + "type": "string", + "description": "The flow stream identifier" + }, + "streamProtocol": { + "$ref": "#/definitions/StreamProtocol", + "description": "The protocol of the stream" + }, + "streamLatency": { + "type": "integer", + "format": "int64", + "description": "The latency of the stream in milliseconds" + }, + "passphrase": { + "type": "string", + "description": "The passphrase used for SRT streams" + }, + "sourceAddresses": { + "$ref": "#/definitions/StreamSourceAddresses", + "description": "The source IP address and CIDR ranges of the stream" + }, + "destinationEndpoints": { + "type": "array", + "description": "The destination endpoints of the stream", + "items": { + "type": "string" + } + }, + "destinationEndpointPorts": { + "type": "array", + "description": "The destination endpoint ports of the stream", + "items": { + "type": "integer", + "format": "int64" + } + }, + "eventHubId": { + "type": "string", + "format": "arm-id", + "description": "Event Hub ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.EventHub/namespaces/eventhubs" + } + ] + } + }, + "consumerGroup": { + "type": "string", + "description": "Event Hub Consumer Group" + } + } + }, + "FlowStatus": { + "type": "string", + "description": "Status of the current flow.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "FlowStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The flow is currently enabled and able to send or receive data." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The flow is currently disabled and cannot send or receive data." + } + ] + } + }, + "FlowType": { + "type": "string", + "description": "Flow type for the specified resource", + "enum": [ + "Unknown", + "Complex", + "DevSecOps", + "Messaging", + "Mission", + "MicrosoftInternal", + "BasicFiles", + "Data", + "Standard", + "StreamingVideo", + "Opaque", + "MissionOpaqueXML", + "DiskImages", + "API" + ], + "x-ms-enum": { + "name": "FlowType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "This type of flow is not set." + }, + { + "name": "Complex", + "value": "Complex", + "description": "This flow sends complex documents, such as Microsoft Office documents of Portable document format files." + }, + { + "name": "DevSecOps", + "value": "DevSecOps", + "description": "This flow sends source code files and artifacts." + }, + { + "name": "Messaging", + "value": "Messaging", + "description": "This flow over the Azure Data Transfer low latency messaging subsystem." + }, + { + "name": "Mission", + "value": "Mission", + "description": "This flow sends data that will not be processed by any security system." + }, + { + "name": "MicrosoftInternal", + "value": "MicrosoftInternal", + "description": "This flow is assigned to internal Microsoft use cases." + }, + { + "name": "BasicFiles", + "value": "BasicFiles", + "description": "This flow sends blobs that can be used for multiple use cases." + }, + { + "name": "Data", + "value": "Data", + "description": "This flow sends blobs that can be used for multiple use cases." + }, + { + "name": "Standard", + "value": "Standard", + "description": "This flow sends blobs that can be used for multiple use cases." + }, + { + "name": "StreamingVideo", + "value": "StreamingVideo", + "description": "This flow sends video streams." + }, + { + "name": "Opaque", + "value": "Opaque", + "description": "This flow sends blobs that will not be processed by any security system." + }, + { + "name": "MissionOpaqueXML", + "value": "MissionOpaqueXML", + "description": "This flow sends Extensible Markup Language that will not be processed by any security system." + }, + { + "name": "DiskImages", + "value": "DiskImages", + "description": "This flow sends blobs that can be used for Virtual Machines." + }, + { + "name": "API", + "value": "API", + "description": "This flow sends data via an Application Programmer Interface." + } + ] + } + }, + "FlowsPatch": { + "type": "object", + "description": "The flows resource patch definition.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ForceDisabledStatus": { + "type": "string", + "description": "Status of force disablement", + "enum": [ + "ConnectionForceDisabled", + "FlowTypeForceDisabled" + ], + "x-ms-enum": { + "name": "ForceDisabledStatus", + "modelAsString": true, + "values": [ + { + "name": "ConnectionForceDisabled", + "value": "ConnectionForceDisabled", + "description": "This Flow has been disabled as the connection has been disabled." + }, + { + "name": "FlowTypeForceDisabled", + "value": "FlowTypeForceDisabled", + "description": "This Flow has been disabled as the flow type this flow uses has been disabled." + } + ] + } + }, + "GetDestinationEndpointPortsResult": { + "type": "object", + "description": "List of destination endpoint ports for the flow stream", + "properties": { + "ports": { + "type": "array", + "description": "The destination endpoint port for the flow stream", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "GetDestinationEndpointsResult": { + "type": "object", + "description": "List of destination endpoints for the flow stream", + "properties": { + "endpoints": { + "type": "array", + "description": "The destination endpoints for the flow stream", + "items": { + "type": "string" + } + } + } + }, + "GetStreamConnectionStringResult": { + "type": "object", + "description": "The connection string for the specified streaming flow", + "properties": { + "connectionString": { + "type": "string", + "description": "The connection string for the specified streaming flow" + } + } + }, + "IdentityTranslation": { + "type": "string", + "description": "Flag for if Azure Data Transfer API Flow should extract the user token", + "enum": [ + "UserIdentity", + "ServiceIdentity" + ], + "x-ms-enum": { + "name": "IdentityTranslation", + "modelAsString": true, + "values": [ + { + "name": "UserIdentity", + "value": "UserIdentity", + "description": "The API flow will make use of the user identity that called this API flow, and pass that token\nthrough the boundary." + }, + { + "name": "ServiceIdentity", + "value": "ServiceIdentity", + "description": "The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary." + } + ] + } + }, + "LinkStatus": { + "type": "string", + "description": "Link status of the current pipeline, connection, flow.", + "enum": [ + "Linked", + "Unlinked" + ], + "x-ms-enum": { + "name": "LinkStatus", + "modelAsString": true, + "values": [ + { + "name": "Linked", + "value": "Linked", + "description": "The pipeline, connection, or flow is currently linked with another corresponding pipeline,\nconnection, or flow, and can be used." + }, + { + "name": "Unlinked", + "value": "Unlinked", + "description": "The pipeline, connection, or flow is not linked with another corresponding pipeline,\nconnection, or flow, and cannot be used." + } + ] + } + }, + "ListApprovedSchemasRequest": { + "type": "object", + "description": "The request used to list approved schemas within the resource provider.", + "properties": { + "pipeline": { + "type": "string", + "description": "The name of the pipeline to filter approved schemas." + }, + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction pipeline to filter approved schemas." + } + } + }, + "ListFlowsByPipelineConnection": { + "type": "object", + "description": "A connection resource id in addition to all child flow resources under this connection.", + "properties": { + "id": { + "type": "string", + "description": "ID of the connection." + }, + "flows": { + "type": "array", + "description": "List of flows associated with the connection.", + "items": { + "$ref": "#/definitions/Flow" + } + } + } + }, + "ListFlowsByPipelineResult": { + "type": "object", + "description": "An array of flow resources.", + "properties": { + "value": { + "type": "array", + "description": "List flows by pipeline result by connection", + "items": { + "$ref": "#/definitions/ListFlowsByPipelineConnection" + }, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "MessagingOptions": { + "type": "object", + "description": "The option associated with messaging flows.", + "properties": { + "billingTier": { + "$ref": "#/definitions/FlowBillingTier", + "description": "Billing tier for this messaging flow" + } + } + }, + "OperationStatusEnum": { + "type": "string", + "description": "Operation status for the last patch request for this connection.", + "enum": [ + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "OperationStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Failed", + "value": "Failed", + "description": "The last patch request for this connection completed with an error." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The last patch request for this connection completed." + } + ] + }, + "readOnly": true + }, + "PendingConnection": { + "type": "object", + "description": "Pending connection object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending connection.", + "readOnly": true + }, + "pipeline": { + "type": "string", + "description": "Pipeline to use to transfer data" + }, + "direction": { + "$ref": "#/definitions/Direction", + "description": "Direction of data movement" + }, + "justification": { + "type": "string", + "description": "Justification for the connection request" + }, + "status": { + "$ref": "#/definitions/ConnectionStatus", + "description": "Status of the connection", + "readOnly": true + }, + "forceDisabledStatus": { + "type": "array", + "description": "Force disablement status of the current connection", + "items": { + "$ref": "#/definitions/ForceDisabledStatus" + }, + "readOnly": true + }, + "statusReason": { + "type": "string", + "description": "Reason for status", + "readOnly": true + }, + "linkStatus": { + "$ref": "#/definitions/LinkStatus", + "description": "Link status of the current connection", + "readOnly": true + }, + "linkedConnectionId": { + "type": "string", + "description": "Resource ID of the linked connection", + "readOnly": true + }, + "flowTypes": { + "type": "array", + "description": "The flow types being requested for this connection", + "items": { + "$ref": "#/definitions/FlowType" + } + }, + "requirementId": { + "type": "string", + "description": "Requirement ID of the connection" + }, + "remoteSubscriptionId": { + "type": "string", + "description": "Subscription ID to link cloud subscriptions together" + }, + "approver": { + "type": "string", + "description": "Approver of this connection request", + "readOnly": true + }, + "pin": { + "type": "string", + "description": "PIN to link requests together" + }, + "dateSubmitted": { + "type": "string", + "format": "date-time", + "description": "The timestamp that this connection request was submitted at", + "readOnly": true + }, + "primaryContact": { + "type": "string", + "description": "The primary contact for this connection request" + }, + "secondaryContacts": { + "type": "array", + "description": "The secondary contacts for this connection request", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the connection", + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this connection", + "items": { + "type": "string" + } + }, + "schemas": { + "type": "array", + "description": "The schemas for this connection", + "items": { + "$ref": "#/definitions/Schema" + } + }, + "schemaUris": { + "type": "array", + "description": "The schema URIs for this connection", + "items": { + "type": "string", + "format": "uri" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/Azure.Core.armResourceType", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "readOnly": true + } + }, + "required": [ + "pipeline", + "location" + ] + }, + "PendingConnectionListResult": { + "type": "object", + "description": "The custom response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The items on this page", + "items": { + "$ref": "#/definitions/PendingConnection" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PendingFlow": { + "type": "object", + "description": "Pending flow object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending flow.", + "readOnly": true + }, + "connectionId": { + "type": "string", + "description": "Connection ID of the pending flow.", + "readOnly": true + }, + "connection": { + "$ref": "#/definitions/SelectedResource", + "description": "The connection associated with this flow" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "URI to a Key Vault Secret containing a SAS token." + }, + "linkStatus": { + "$ref": "#/definitions/LinkStatus", + "description": "Link status of the current flow", + "readOnly": true + }, + "linkedFlowId": { + "type": "string", + "description": "Resource ID of the linked flow", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FlowStatus", + "description": "Status of the current flow" + }, + "forceDisabledStatus": { + "type": "array", + "description": "Force disablement status of the current flow", + "items": { + "$ref": "#/definitions/ForceDisabledStatus" + }, + "readOnly": true + }, + "storageAccountName": { + "type": "string", + "description": "Storage Account" + }, + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Storage Account ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageContainerName": { + "type": "string", + "description": "Storage Container Name" + }, + "storageTableName": { + "type": "string", + "description": "Storage Table Name" + }, + "serviceBusQueueId": { + "type": "string", + "format": "arm-id", + "description": "Service Bus Queue ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/namespaces/queues" + } + ] + } + }, + "flowType": { + "$ref": "#/definitions/FlowType", + "description": "The flow type for this flow" + }, + "dataType": { + "$ref": "#/definitions/DataType", + "description": "Type of data to transfer via the flow." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the flow", + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this flow", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Schema", + "description": "The selected schema for this flow" + }, + "messagingOptions": { + "$ref": "#/definitions/MessagingOptions", + "description": "The messaging options for this flow" + }, + "apiFlowOptions": { + "$ref": "#/definitions/ApiFlowOptions", + "description": "The API Flow configuration options for Azure Data Transfer API Flow type." + }, + "customerManagedKeyVaultUri": { + "type": "string", + "format": "uri", + "description": "The URI to the customer managed key for this flow" + }, + "streamId": { + "type": "string", + "description": "The flow stream identifier" + }, + "streamProtocol": { + "$ref": "#/definitions/StreamProtocol", + "description": "The protocol of the stream" + }, + "streamLatency": { + "type": "integer", + "format": "int64", + "description": "The latency of the stream in milliseconds" + }, + "passphrase": { + "type": "string", + "description": "The passphrase used for SRT streams" + }, + "sourceAddresses": { + "$ref": "#/definitions/StreamSourceAddresses", + "description": "The source IP address and CIDR ranges of the stream" + }, + "destinationEndpoints": { + "type": "array", + "description": "The destination endpoints of the stream", + "items": { + "type": "string" + } + }, + "destinationEndpointPorts": { + "type": "array", + "description": "The destination endpoint ports of the stream", + "items": { + "type": "integer", + "format": "int64" + } + }, + "eventHubId": { + "type": "string", + "format": "arm-id", + "description": "Event Hub ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.EventHub/namespaces/eventhubs" + } + ] + } + }, + "consumerGroup": { "type": "string", - "description": "Subscription ID of the pending connection.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/connectionProperties" + "description": "Event Hub Consumer Group" }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "connectionsPatch": { - "type": "object", - "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags" + } }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the connection resource, if configured." + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/Azure.Core.armResourceType", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "readOnly": true } }, - "description": "The connections resource patch definition." + "required": [ + "location" + ] }, - "connectionsListResult": { + "PendingFlowListResult": { "type": "object", + "description": "The custom response of a list operation.", "properties": { "value": { "type": "array", + "description": "The items on this page", "items": { - "$ref": "#/definitions/connection" - }, - "description": "Connections array.", - "x-ms-identifiers": [ - "id" - ] + "$ref": "#/definitions/PendingFlow" + } }, "nextLink": { - "description": "Link to next results", - "type": "string" + "type": "string", + "description": "The link to the next page of items" } }, - "description": "The connections list result." + "required": [ + "value" + ] }, - "pendingConnectionsListResult": { + "Pipeline": { "type": "object", + "description": "The pipeline resource definition.", "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/pendingConnection" - }, - "description": "Connections array.", - "x-ms-identifiers": [ - "id" - ] + "properties": { + "$ref": "#/definitions/PipelineProperties", + "description": "Properties of pipeline" }, - "nextLink": { - "description": "Link to next results", - "type": "string" + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." } }, - "description": "The connections list result." + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] }, - "pendingFlowsListResult": { + "PipelineListResult": { "type": "object", + "description": "The response of a Pipeline list operation.", "properties": { "value": { "type": "array", + "description": "The Pipeline items on this page", "items": { - "$ref": "#/definitions/pendingFlow" - }, - "description": "flows array.", - "x-ms-identifiers": [ - "id" - ] + "$ref": "#/definitions/Pipeline" + } }, "nextLink": { - "description": "Link to next results", - "type": "string" - } - }, - "description": "The connections list result." - }, - "operationStatusProperties": { - "type": "object", - "description": "Operation status associated with the last patch request", - "properties": { - "status": { - "enum": [ - "Failed", - "Succeeded" - ], - "type": "string", - "x-ms-enum": { - "name": "operationStatusEnum", - "modelAsString": true - }, - "description": "Operation status for the last patch request for this connection.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "Operation status ID of the last patch request for this connection.", - "readOnly": true - }, - "message": { - "type": "string", - "description": "Message for the operation for the last patch request for this connection.", - "readOnly": true - } - } - }, - "internalMetadataProperties": { - "type": "object", - "description": "Internal metadata of the connection inside pipeline.", - "properties": { - "operationStatus": { - "$ref": "#/definitions/operationStatusProperties" - }, - "statusSetBy": { - "type": "string", - "description": "User that last set the approved status for this connection", - "readOnly": true - } - }, - "additionalProperties": {} - }, - "pipelineConnection": { - "description": "Connection body inside a pipeline", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Connection id inside pipeline" - }, - "name": { - "type": "string", - "description": "Connection name inside pipeline", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Connection type inside pipeline", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Connection location inside pipeline", - "x-ms-mutability": [ - "read" - ], - "readOnly": true - }, - "etag": { "type": "string", - "description": "Connection etag inside pipeline", - "readOnly": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" - }, - "properties": { - "type": "object", - "description": "Connection properties inside pipeline", - "properties": { - "internalMetadata": { - "$ref": "#/definitions/internalMetadataProperties" - } - }, - "additionalProperties": {} + "format": "uri", + "description": "The link to the next page of items" } }, - "additionalProperties": {}, "required": [ - "id" + "value" ] }, - "pipelineProperties": { + "PipelineProperties": { "type": "object", + "description": "Properties of pipeline", "properties": { "remoteCloud": { "type": "string", @@ -2792,10 +4116,10 @@ }, "connections": { "type": "array", + "description": "Connections associated with pipeline", "items": { - "$ref": "#/definitions/pipelineConnection" + "$ref": "#/definitions/ReadPipelineConnection" }, - "description": "Connections associated with pipeline", "readOnly": true, "x-ms-identifiers": [ "id" @@ -2803,25 +4127,15 @@ }, "subscribers": { "type": "array", + "description": "Subscribers of this resource", "items": { - "$ref": "#/definitions/subscriber" + "$ref": "#/definitions/Subscriber" }, - "x-ms-identifiers": [], - "description": "Subscribers of this resource" + "x-ms-identifiers": [] }, "provisioningState": { + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the pipeline", - "enum": [ - "Failed", - "Succeeded", - "Canceled", - "Accepted" - ], - "type": "string", - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - }, "readOnly": true }, "policies": { @@ -2832,12 +4146,18 @@ } }, "flowTypes": { - "$ref": "#/definitions/flowTypes", - "description": "The flow types allowed for this pipeline" + "type": "array", + "description": "The flow types allowed for this pipeline", + "items": { + "$ref": "#/definitions/FlowType" + } }, "disabledFlowTypes": { - "$ref": "#/definitions/flowTypes", - "description": "The flow types that are disabled for this pipeline" + "type": "array", + "description": "The flow types that are disabled for this pipeline", + "items": { + "$ref": "#/definitions/FlowType" + } }, "quarantineDownloadStorageAccount": { "type": "string", @@ -2848,128 +4168,209 @@ "description": "Quarantine Download Storage Container" }, "status": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "pipelineStatus", - "modelAsString": true - }, + "$ref": "#/definitions/PipelineStatus", "description": "Status of the current pipeline" } }, "required": [ "remoteCloud" - ], - "description": "Properties of pipeline" + ] }, - "pipeline": { - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "properties": { - "$ref": "#/definitions/pipelineProperties" - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the pipeline resource, if configured." - } - }, - "required": [ - "location" - ], - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } + "PipelineStatus": { + "type": "string", + "description": "Status of the current pipeline", + "enum": [ + "Enabled", + "Disabled" ], - "description": "The pipeline resource definition." + "x-ms-enum": { + "name": "PipelineStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The pipeline is currently enabled and all child connection and flow resources below able to send or receive data." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data." + } + ] + } }, - "pipelinesPatch": { + "PipelinesPatch": { "type": "object", + "description": "The pipelines resource patch definition.", "properties": { "properties": { - "type": "object", - "properties": { - "connections": { - "type": "array", - "items": { - "$ref": "#/definitions/pipelineConnection" - }, - "description": "Connections associated with pipeline", - "x-ms-identifiers": [ - "id" - ] - }, - "flowTypes": { - "$ref": "#/definitions/flowTypes", - "description": "The flow types allowed for this pipeline" - } - }, + "$ref": "#/definitions/PipelinesPatchProperties", "description": "Properties of pipelines patch body." }, "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags" + } }, "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The managed identity of the pipeline resource, if configured." + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." } - }, - "description": "The pipelines resource patch definition." + } }, - "pipelinesListResult": { + "PipelinesPatchProperties": { "type": "object", + "description": "Properties of pipelines patch body.", "properties": { - "value": { + "flowTypes": { "type": "array", + "description": "The flow types allowed for this pipeline", "items": { - "$ref": "#/definitions/pipeline" + "$ref": "#/definitions/FlowType" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the pipeline, connection, flow.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." }, - "description": "Pipelines array.", - "x-ms-identifiers": [ - "id" - ] + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource has been accepted for creation." + } + ] + }, + "readOnly": true + }, + "ReadPipelineConnection": { + "type": "object", + "description": "", + "properties": { + "id": { + "type": "string", + "description": "Connection id inside pipeline" }, - "nextLink": { - "description": "Link to next results", - "type": "string" + "name": { + "type": "string", + "description": "Connection name inside pipeline" + }, + "type": { + "type": "string", + "description": "Connection type inside pipeline" + }, + "location": { + "type": "string", + "description": "Connection location inside pipeline" + }, + "etag": { + "type": "string", + "description": "Connection etag inside pipeline" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "$ref": "#/definitions/ReadReadPipelineConnectionProperties", + "description": "Connection properties inside pipeline" + } + }, + "required": [ + "id" + ], + "additionalProperties": {} + }, + "ReadReadInternalMetadataProperties": { + "type": "object", + "description": "Internal metadata of the connection inside pipeline.", + "properties": { + "operationStatus": { + "$ref": "#/definitions/ReadReadOperationStatusProperties", + "description": "Operation status associated with the last patch request" + }, + "statusSetBy": { + "type": "string", + "description": "User that last set the approved status for this connection" } }, - "description": "The pipelines list result." + "additionalProperties": {} }, - "subscriber": { + "ReadReadOperationStatusProperties": { "type": "object", + "description": "Operation status associated with the last patch request", "properties": { - "email": { + "status": { + "$ref": "#/definitions/OperationStatusEnum", + "description": "Operation status for the last patch request for this connection." + }, + "id": { + "type": "string", + "description": "Operation status ID of the last patch request for this connection." + }, + "message": { + "type": "string", + "description": "Message for the operation for the last patch request for this connection." + } + } + }, + "ReadReadPipelineConnectionProperties": { + "type": "object", + "description": "Connection properties inside pipeline", + "properties": { + "internalMetadata": { + "$ref": "#/definitions/ReadReadInternalMetadataProperties", + "description": "Internal metadata of the connection inside pipeline." + } + }, + "additionalProperties": {} + }, + "ResourceBody": { + "type": "object", + "description": "The resource to reference.", + "properties": { + "id": { "type": "string", - "description": "Email of the subscriber" + "description": "ID of the resource." }, - "notifications": { - "type": "integer", - "format": "int64", - "description": "Number specifying what notifications to receive" + "statusReason": { + "type": "string", + "description": "Reason for resource operation." } - } - }, - "schemas": { - "type": "array", - "description": "The schemas for this connection", - "x-ms-identifiers": [ - "connectionId", - "name" - ], - "items": { - "$ref": "#/definitions/schema" - } + }, + "required": [ + "id" + ] }, - "schema": { + "Schema": { "type": "object", "description": "The schema object.", "properties": { @@ -2982,15 +4383,7 @@ "description": "Connection ID associated with this schema" }, "status": { - "enum": [ - "New", - "Approved" - ], - "type": "string", - "x-ms-enum": { - "name": "schemaStatus", - "modelAsString": true - }, + "$ref": "#/definitions/SchemaStatus", "description": "Status of the schema" }, "name": { @@ -3002,273 +4395,151 @@ "description": "Content of the schema" }, "direction": { - "description": "The direction of the schema.", - "enum": [ - "Send", - "Receive" - ], - "type": "string", - "x-ms-enum": { - "name": "schemaDirection", - "modelAsString": true - } + "$ref": "#/definitions/Direction", + "description": "The direction of the schema." }, "schemaUri": { "type": "string", - "format": "url", + "format": "uri", "description": "Uri containing SAS token for the zipped schema" }, "schemaType": { - "description": "The Schema Type", - "enum": [ - "Xsd", - "Zip" - ], - "type": "string", - "x-ms-enum": { - "name": "SchemaType", - "modelAsString": true - } - } - } - }, - "schemasListResult": { - "type": "object", - "properties": { - "value": { - "description": "Schemas array.", - "$ref": "#/definitions/schemas" + "$ref": "#/definitions/SchemaType", + "description": "The Schema Type" } - }, - "description": "The schemas list result." - }, - "flowTypes": { - "type": "array", - "description": "The flow types that are allowed for this resource", - "items": { - "$ref": "#/definitions/flowType" } }, - "flowType": { + "SchemaStatus": { + "type": "string", + "description": "Status of the schema.", "enum": [ - "Unknown", - "Complex", - "DevSecOps", - "Messaging", - "Mission", - "MicrosoftInternal", - "BasicFiles", - "Data", - "Standard", - "StreamingVideo", - "Opaque", - "MissionOpaqueXML", - "DiskImages", - "API" + "New", + "Approved" ], - "type": "string", "x-ms-enum": { - "name": "flowType", - "modelAsString": true - }, - "description": "Flow type for the specified resource" + "name": "SchemaStatus", + "modelAsString": true, + "values": [ + { + "name": "New", + "value": "New", + "description": "A schema that has not been approved and is awaiting review." + }, + { + "name": "Approved", + "value": "Approved", + "description": "A schema that has been approved and is ready for use." + } + ] + } }, - "forceDisabledStatus": { + "SchemaType": { + "type": "string", + "description": "The Schema Type.", "enum": [ - "ConnectionForceDisabled", - "FlowTypeForceDisabled" + "Xsd", + "Zip" ], - "type": "string", "x-ms-enum": { - "name": "forceDisabledStatus", - "modelAsString": true - }, - "description": "Status of force disablement" - }, - "connectionIdList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "type": "string" + "name": "SchemaType", + "modelAsString": true, + "values": [ + { + "name": "Xsd", + "value": "Xsd", + "description": "The schema represents a single XML schema definition file." }, - "description": "Connection ID to target" - } + { + "name": "Zip", + "value": "Zip", + "description": "The schema represents a ZIP file with multiple XML schema definition files within it." + } + ] } }, - "listFlowsByPipelineResult": { + "SchemasListResult": { "type": "object", + "description": "The schemas list result.", "properties": { "value": { "type": "array", + "description": "Schemas array.", "items": { - "$ref": "#/definitions/listFlowsByPipelineConnection" - }, - "description": "List flows by pipeline result by connection", - "x-ms-identifiers": [ - "id" - ] + "$ref": "#/definitions/Schema" + } } } }, - "listFlowsByPipelineConnection": { + "SelectedResource": { "type": "object", + "description": "A resource selected from ARM", "properties": { - "id": { + "name": { "type": "string", - "description": "ID of the connection." + "description": "Name of the connection" }, - "flows": { - "type": "array", - "description": "List of flows associated with the connection.", - "items": { - "$ref": "#/definitions/flow" - } - } - } - }, - "resourceBody": { - "type": "object", - "properties": { "id": { "type": "string", - "description": "ID of the resource." + "description": "Id of the connection" }, - "statusReason": { + "location": { "type": "string", - "description": "Reason for resource operation." + "description": "Location of the connection", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "subscriptionName": { + "type": "string", + "description": "Name of the subscription with the connection" } }, "required": [ "id" - ], - "description": "The resource to reference." - }, - "messagingOptions": { - "type": "object", - "properties": { - "billingTier": { - "enum": [ - "BlobTransport", - "Standard", - "Premium" - ], - "type": "string", - "x-ms-enum": { - "name": "flowBillingTier", - "modelAsString": true - }, - "description": "Billing tier for this messaging flow" - } - }, - "description": "The option associated with messaging flows." - }, - "apiFlowOptions": { - "type": "object", - "description": "Properties specific to API Flow Type", - "properties": { - "remoteEndpoint": { - "type": "string", - "description": "Remote host to which communication needs to be made", - "example": "SDK - https://:/endpoint, EPC - https://:" - }, - "cname": { - "type": "string", - "description": "Unique CNAME to represent the Azure Data Transfer API Flow instance" - }, - "apiMode": { - "enum": [ - "SDK", - "Endpoint" - ], - "type": "string", - "description": "Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked", - "x-ms-enum": { - "name": "ApiMode", - "modelAsString": true - } - }, - "identityTranslation": { - "enum": [ - "UserIdentity", - "ServiceIdentity" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityTranslation", - "modelAsString": true - }, - "description": "Flag for if Azure Data Transfer API Flow should extract the user token" - }, - "senderClientId": { - "type": "string", - "description": "Sender's app user assigned Manage Identity client ID", - "example": "99b05d1c-0b68-467a-a6b9-52f3c5fd4b68" - }, - "remoteCallingModeClientId": { - "type": "string", - "description": "Remote stub app registration Client ID", - "example": "5232fefa-58c3-423d-8351-3b3bea745591" - }, - "audienceOverride": { - "type": "string", - "description": "Optional field to override the audience of the remote endpoint", - "example": "api://98ce6d91-7df4-4daa-b4a0-c3e6a9d6b846" - } - } + ] }, - "streamSourceAddresses": { + "SetDestinationEndpointPorts": { "type": "object", - "description": "The source IP address and CIDR ranges of the stream", + "description": "Set the destination endpoint ports for the specified flow.", "properties": { - "sourceAddresses": { + "ports": { "type": "array", - "description": "A source IP address or CIDR range", + "description": "The specified flow destination endpoint ports", "items": { - "type": "string" + "type": "integer", + "format": "int64" } } } }, - "getDestinationEndpointsResult": { + "SetDestinationEndpoints": { "type": "object", - "description": "List of destination endpoints for the flow stream", + "description": "Set the destination endpoints for the specified flow.", "properties": { "endpoints": { "type": "array", - "description": "The destination endpoints for the flow stream", + "description": "The specified flow destination endpoints.", "items": { "type": "string" } } } }, - "getDestinationEndpointPortsResult": { + "SetSourceAddresses": { "type": "object", - "description": "List of destination endpoint ports for the flow stream", + "description": "Set the source addresses for the specified flow.", "properties": { - "ports": { + "values": { "type": "array", - "description": "The destination endpoint port for the flow stream", + "description": "Source addresses", "items": { - "type": "integer", - "format": "int64" + "type": "string" } } } }, - "getStreamConnectionStringResult": { - "type": "object", - "description": "The connection string for the specified streaming flow", - "properties": { - "connectionString": { - "type": "string", - "description": "The connection string for the specified streaming flow" - } - } - }, - "setStreamPassphrase": { + "SetStreamPassphrase": { "type": "object", "description": "Set the passphrase used for SRT streams", "properties": { @@ -3278,127 +4549,133 @@ } } }, - "setSourceAddresses": { - "type": "object", - "description": "Set the source addresses for the specified stream ID", - "properties": { - "values": { - "type": "array", - "items": { - "type": "string" + "StreamProtocol": { + "type": "string", + "description": "The protocol of the stream", + "enum": [ + "UDP", + "SRT", + "RTP" + ], + "x-ms-enum": { + "name": "StreamProtocol", + "modelAsString": true, + "values": [ + { + "name": "UDP", + "value": "UDP", + "description": "This Flow is using User Datagram Protocol for the video stream." }, - "description": "Source addresses" - } + { + "name": "SRT", + "value": "SRT", + "description": "This Flow is using Secure Reliable Transfer for the video stream." + }, + { + "name": "RTP", + "value": "RTP", + "description": "This Flow is using Real-time Transport Protocol for the video stream." + } + ] } }, - "setDestinationEndpoints": { + "StreamSourceAddresses": { "type": "object", - "description": "Set the destination endpoints for the specified stream ID", + "description": "The source IP address and CIDR ranges of the stream", "properties": { - "endpoints": { + "sourceAddresses": { "type": "array", - "description": "The specified stream ID destination endpoints", + "description": "A source IP address or CIDR range", "items": { "type": "string" } } } }, - "setDestinationEndpointPorts": { + "Subscriber": { "type": "object", - "description": "Set the destination endpoint ports for the specified stream ID", + "description": "An individual that would like to subscribe to events that occur on a pipeline.", "properties": { - "ports": { - "type": "array", - "description": "The specified stream ID destination endpoint ports", - "items": { - "type": "integer", - "format": "int64" - } + "email": { + "type": "string", + "description": "Email of the subscriber" + }, + "notifications": { + "type": "integer", + "format": "int64", + "description": "Number specifying what notifications to receive" } } }, - "action": { - "type": "object", - "properties": { - "actionType": { - "enum": [ - "AllowUpdates", - "ForceDisable" - ], - "type": "string", - "x-ms-enum": { - "name": "actionType", - "modelAsString": true + "TargetType": { + "type": "string", + "description": "Type of target to execute the action on", + "enum": [ + "Pipeline", + "Connection", + "FlowType" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true, + "values": [ + { + "name": "Pipeline", + "value": "Pipeline", + "description": "The action executing is targeting a pipeline." }, - "description": "Type of action to be executed" - }, - "targetType": { - "enum": [ - "Pipeline", - "Connection", - "FlowType" - ], - "type": "string", - "x-ms-enum": { - "name": "targetType", - "modelAsString": true + { + "name": "Connection", + "value": "Connection", + "description": "The action executing is targeting a connection." }, - "description": "Type of target to execute the action on" - }, - "targets": { - "type": "array", - "description": "Targets for the action", - "items": { - "type": "string" + { + "name": "FlowType", + "value": "FlowType", + "description": "The action executing is targeting a flow type." } + ] + } + }, + "ValidateSchemaResult": { + "type": "object", + "description": "Result of the schema validation.", + "properties": { + "status": { + "$ref": "#/definitions/ValidateSchemaStatus", + "description": "Validation status of the schema" }, - "justification": { + "message": { "type": "string", - "description": "Business justification for the action" + "description": "Message describing the schema validation" } - }, - "required": [ - "actionType", - "targetType", - "targets" + } + }, + "ValidateSchemaStatus": { + "type": "string", + "description": "Validation status of the schema", + "enum": [ + "Succeeded", + "Failed" ], - "description": "The action to be executed." + "x-ms-enum": { + "name": "ValidateSchemaStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation of the schema was successful." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The schema failed validation, whether due to error or an invalid schema." + } + ] + }, + "readOnly": true } }, - "parameters": { - "flowNameParameter": { - "x-ms-parameter-location": "method", - "name": "flowName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,64}$", - "maxLength": 64, - "minLength": 3, - "description": "The name for the flow that is to be onboarded." - }, - "connectionNameParameter": { - "x-ms-parameter-location": "method", - "name": "connectionName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,64}$", - "maxLength": 64, - "minLength": 3, - "description": "The name for the connection that is to be requested." - }, - "pipelineNameParameter": { - "x-ms-parameter-location": "method", - "name": "pipelineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,64}$", - "maxLength": 64, - "minLength": 3, - "description": "The name for the pipeline that is to be requested." - } - } + "parameters": {} } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveConnection.json new file mode 100644 index 000000000000..678b4c917680 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/approveConnection.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pipelines_ApproveConnection", + "parameters": { + "api-version": "2025-04-11-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-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateConnection.json index 759d6127051b..479f77269f5b 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateConnection.json @@ -1,39 +1,41 @@ { + "operationId": "Connections_CreateOrUpdate", "parameters": { - "connectionName": "testConnection", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "connection": { + "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" - }, - "location": "East US" - } + } + }, + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Creates or updates the connection resource", "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateFlow.json index b4009acb7cfd..db6a0474d52a 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateFlow.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdateFlow.json @@ -1,34 +1,36 @@ { + "operationId": "Flows_CreateOrUpdate", "parameters": { - "connectionName": "testConnection", - "flowName": "testFlow", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connectionName": "testConnection", "flow": { + "location": "East US", "properties": { - "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" - } - }, - "location": "East US" - } + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + } + }, + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Creates or updates the flow resource", "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdatePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdatePipeline.json index 3c7c18d8bde3..0466b022f1dc 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdatePipeline.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/createOrUpdatePipeline.json @@ -1,28 +1,30 @@ { + "operationId": "Pipelines_CreateOrUpdate", "parameters": { - "pipelineName": "testPipeline", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "pipeline": { + "location": "East US", "properties": { "remoteCloud": "testdc" - }, - "location": "East US" - } + } + }, + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Creates or updates the pipeline resource", "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US" } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteConnection.json index 8dadb932c722..43590f85b9bc 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteConnection.json @@ -1,10 +1,12 @@ { + "operationId": "Connections_Delete", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Deletes the connection resource", "responses": { "202": { "headers": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteFlow.json index 93961313b323..d1935e28b5cf 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteFlow.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deleteFlow.json @@ -1,11 +1,13 @@ { + "operationId": "Flows_Delete", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Deletes the flow resource", "responses": { "202": { "headers": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deletePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deletePipeline.json index ce47904a35ab..f15a787ee421 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deletePipeline.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/deletePipeline.json @@ -1,10 +1,12 @@ { + "operationId": "Pipelines_Delete", "parameters": { + "api-version": "2025-04-11-preview", "pipelineName": "testPipeline", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Deletes the pipeline resource", "responses": { "202": { "headers": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/disableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/disableFlow.json new file mode 100644 index 000000000000..b86f8ae89b16 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/disableFlow.json @@ -0,0 +1,25 @@ +{ + "operationId": "Flows_Disable", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Disables the specified flow", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableFlow.json new file mode 100644 index 000000000000..2779b8273f1a --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/enableFlow.json @@ -0,0 +1,25 @@ +{ + "operationId": "Flows_Enable", + "parameters": { + "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Enables the specified flow", + "responses": { + "200": { + "body": { + "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/executeAction.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/executeAction.json index d5ed5638dfef..bd8aadb862d3 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/executeAction.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/executeAction.json @@ -1,22 +1,24 @@ { + "operationId": "Pipelines_ExecuteAction", "parameters": { - "pipelineName": "testPipeline", - "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "action": { "actionType": "ForceDisable", "targetType": "Connection", "targets": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" ] - } + }, + "api-version": "2025-04-11-preview", + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Executes action for a pipeline", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/generateFlowPassphrase.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/generateFlowPassphrase.json index 3bb170d4ced5..40a395284925 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/generateFlowPassphrase.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/generateFlowPassphrase.json @@ -1,16 +1,18 @@ { + "operationId": "Flows_GeneratePassphrase", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Generate a new compliant streaming passphrase", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getConnection.json index 3ef8387438f4..b2c0c3b54e41 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getConnection.json @@ -1,15 +1,17 @@ { + "operationId": "Connections_Get", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets connection resource", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", "location": "East US" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlow.json index 4e5453a71dde..a826222b9871 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlow.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlow.json @@ -1,16 +1,18 @@ { + "operationId": "Flows_Get", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets flow resource", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpointPorts.json index dc4f0427312e..f94d84de0d7a 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpointPorts.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpointPorts.json @@ -1,11 +1,13 @@ { + "operationId": "Flows_GetDestinationEndpointPorts", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Get the flow stream destination endpoint ports", "responses": { "200": { "body": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpoints.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpoints.json index 8a383496a50d..e6617c71a1e5 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpoints.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowDestinationEndpoints.json @@ -1,11 +1,13 @@ { + "operationId": "Flows_GetDestinationEndpoints", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Get the flow stream destination endpoints", "responses": { "200": { "body": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowSourceAddresses.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowSourceAddresses.json index 18f381c14f43..61bca161c5f3 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowSourceAddresses.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getFlowSourceAddresses.json @@ -1,11 +1,13 @@ { + "operationId": "Flows_GetSourceAddresses", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Get the flow stream source addresses", "responses": { "200": { "body": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getPipeline.json index 99d3bb247bd5..44bd421e5da0 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getPipeline.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getPipeline.json @@ -1,15 +1,17 @@ { + "operationId": "Pipelines_Get", "parameters": { + "api-version": "2025-04-11-preview", "pipelineName": "testPipeline", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets pipeline resource", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getStreamConnectionString.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getStreamConnectionString.json index e906ce1d644e..dab82f91a4fd 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getStreamConnectionString.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/getStreamConnectionString.json @@ -1,11 +1,13 @@ { + "operationId": "Flows_GetStreamConnectionString", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Get the flow stream connection string", "responses": { "200": { "body": { diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkConnection.json index 4e6d09b1d991..071f1bb3ab6f 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkConnection.json @@ -1,18 +1,20 @@ { + "operationId": "Connections_Link", "parameters": { - "connectionName": "testConnection", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" - } + }, + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Links the specified connection", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkFlow.json index 226103257207..0d35f330917b 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkFlow.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/linkFlow.json @@ -1,19 +1,21 @@ { + "operationId": "Flows_Link", "parameters": { - "connectionName": "testConnection", - "flowName": "testFlow", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connectionName": "testConnection", "flow": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" - } + }, + "flowName": "testFlow", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Links the specified flow", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsByResourceGroup.json index 13bd4fdfbd1f..79082015f78c 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsByResourceGroup.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsByResourceGroup.json @@ -1,32 +1,34 @@ { + "operationId": "Connections_ListByResourceGroup", "parameters": { - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", + "resourceGroupName": "testRG", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets connections in a resource group", "responses": { "200": { "body": { "value": [ { "name": "testConnection", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } }, { "name": "testConnection2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsBySubscription.json index ad4ad17458a2..3b483699209c 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsBySubscription.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listConnectionsBySubscription.json @@ -1,31 +1,33 @@ { + "operationId": "Connections_ListBySubscription", "parameters": { "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets connections in a subscription", "responses": { "200": { "body": { "value": [ { "name": "testConnection", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } }, { "name": "testConnection2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByConnection.json index dde4fccfb7ca..bbc9def5a90d 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByConnection.json @@ -1,40 +1,42 @@ { + "operationId": "Flows_ListByConnection", "parameters": { - "resourceGroupName": "testRG", - "connectionName": "testConnection", "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets flows in a connection", "responses": { "200": { "body": { "value": [ { "name": "testConnection", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "properties": { - "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" - } + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" } }, { "name": "testConnection2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", "location": "East US", "properties": { - "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" - } + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" } } ] diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByPipeline.json index f23b9eb12f8b..8a59c155d406 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByPipeline.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listFlowsByPipeline.json @@ -1,46 +1,48 @@ { "parameters": { - "pipelineName": "testPipeline", - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "connections": { "value": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" ] - } + }, + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "flows": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "properties": { + "flowType": "Standard", "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard" + "storageContainerName": "testcontainer" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow2", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow2", "location": "East US", "properties": { + "flowType": "Standard", "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard" + "storageContainerName": "testcontainer" } } - ] + ], + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" } ] } } - } + }, + "operationId": "ListFlowsByPipeline_List", + "title": "Lists flows for a pipeline" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listOperations.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listOperations.json index 7fb6dccd40a9..c8de23845ce3 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listOperations.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listOperations.json @@ -1,10 +1,12 @@ { + "operationId": "Operations_List", "parameters": { "accountName": "sampleacct", - "resourceGroupName": "teleportalClient", "api-version": "2025-04-11-preview", + "resourceGroupName": "teleportalClient", "subscriptionId": "subid" }, + "title": "List operations", "responses": { "200": { "body": { @@ -12,28 +14,28 @@ { "name": "Microsoft.AzureDataTransfer/read", "display": { - "provider": "CTS Experience", - "resource": "Flow", + "description": "Read flows", "operation": "Read flows", - "description": "Read flows" + "provider": "CTS Experience", + "resource": "Flow" } }, { "name": "Microsoft.AzureDataTransfer/write", "display": { - "provider": "CTS Experience", - "resource": "Flow", + "description": "Update flows", "operation": "Update flows", - "description": "Update flows" + "provider": "CTS Experience", + "resource": "Flow" } }, { "name": "Microsoft.AzureDataTransfer/delete", "display": { - "provider": "CTS Experience", - "resource": "Flow", + "description": "Delete flows", "operation": "Delete flows", - "description": "Delete flows" + "provider": "CTS Experience", + "resource": "Flow" } } ] diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingConnections.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingConnections.json index 1c3090215f6f..71be1b749af5 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingConnections.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingConnections.json @@ -1,8 +1,8 @@ { "parameters": { - "resourceGroupName": "testRG", - "connectionName": "testConnection", "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -12,23 +12,25 @@ { "name": "testConnection", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "justification": "justification", "location": "East US", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "pipeline": "testdc", - "justification": "justification", - "requirementId": "id" + "requirementId": "id", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, { "name": "testConnection", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "justification": "justification", "location": "East US", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "pipeline": "testdc", - "justification": "justification", - "requirementId": "id" + "requirementId": "id", + "subscriptionId": "00000000-0000-0000-0000-000000000000" } ] } } - } + }, + "operationId": "ListPendingConnections_List", + "title": "Lists a list of pending connections" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingFlows.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingFlows.json index 6ef4fa40cd5b..1fce14cc1774 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingFlows.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPendingFlows.json @@ -1,8 +1,8 @@ { "parameters": { - "resourceGroupName": "testRG", - "connectionName": "testConnection", "api-version": "2025-04-11-preview", + "connectionName": "testConnection", + "resourceGroupName": "testRG", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,24 +11,26 @@ "value": [ { "name": "testFlow", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "flowType": "Blob", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Blob" + "storageContainerName": "testcontainer" }, { "name": "testInstallation2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "flowType": "Blob", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Blob" + "storageContainerName": "testcontainer" } ] } } - } + }, + "operationId": "ListPendingFlows_List", + "title": "Lists a list of pending flows" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesByResourceGroup.json index df5c76733187..c61099271fd1 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesByResourceGroup.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesByResourceGroup.json @@ -1,17 +1,19 @@ { + "operationId": "Pipelines_ListByResourceGroup", "parameters": { - "resourceGroupName": "testRG", "api-version": "2025-04-11-preview", + "resourceGroupName": "testRG", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets pipelines in a resource group", "responses": { "200": { "body": { "value": [ { "name": "testPipeline", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US", "properties": { "remoteCloud": "testdc" @@ -19,8 +21,8 @@ }, { "name": "testPipeline2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", "location": "East US", "properties": { "remoteCloud": "testdc" diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesBySubscription.json index febe5a759492..ad690e088d15 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesBySubscription.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listPipelinesBySubscription.json @@ -1,16 +1,18 @@ { + "operationId": "Pipelines_ListBySubscription", "parameters": { "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Gets pipelines in a subscription", "responses": { "200": { "body": { "value": [ { "name": "testPipeline", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US", "properties": { "remoteCloud": "testdc" @@ -18,8 +20,8 @@ }, { "name": "testPipeline2", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", "location": "East US", "properties": { "remoteCloud": "testdc" diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listSchemas.json index 881e64d3de0c..65798fa3ad19 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listSchemas.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/listSchemas.json @@ -1,13 +1,13 @@ { "parameters": { + "schema": { + "name": "test.xsd", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + }, + "api-version": "2025-04-11-preview", "pipelineName": "testPipeline", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schema": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", - "name": "test.xsd" - } + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -20,5 +20,7 @@ ] } } - } + }, + "operationId": "ListSchemas_List", + "title": "Lists schemas for a pipeline" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchConnection.json index 4bdb716e6bbc..864a9b841701 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchConnection.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchConnection.json @@ -1,46 +1,48 @@ { + "operationId": "Connections_Update", "parameters": { + "api-version": "2025-04-11-preview", + "connection": {}, "connectionName": "testConnection", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "connection": {}, "tags": { "tag": "value" } }, + "title": "Updates the connection resource", "responses": { - "202": { - "headers": { - "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" - }, + "200": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" + }, + "tags": { + "tag": "value" } } }, - "200": { + "202": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "type": "Microsoft.AzureDataTransfer/connections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", "location": "East US", "properties": { - "pipeline": "testdc", "justification": "justification", + "pipeline": "testdc", "requirementId": "id" + }, + "tags": { + "tag": "value" } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" } } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchFlow.json index f4669a7108bf..6d126ac1e928 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchFlow.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchFlow.json @@ -1,53 +1,55 @@ { + "operationId": "Flows_Update", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", + "flow": {}, "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "flow": {}, "tags": { "tag": "value" } }, + "title": "Updates the flow resource", "responses": { - "202": { - "headers": { - "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" - }, + "200": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "properties": { - "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" - } + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + }, + "tags": { + "tag": "value" } } }, - "200": { + "202": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/connections/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US", "properties": { - "storageAccountName": "testsa", - "storageContainerName": "testcontainer", - "flowType": "Standard", "connection": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" - } + }, + "flowType": "Standard", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer" + }, + "tags": { + "tag": "value" } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" } } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchPipeline.json index a6b14c31aa6e..edbcb7be1e16 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchPipeline.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/patchPipeline.json @@ -1,42 +1,44 @@ { + "operationId": "Pipelines_Update", "parameters": { + "api-version": "2025-04-11-preview", + "pipeline": {}, "pipelineName": "testPipeline", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "pipeline": {}, "tags": { "tag": "value" } }, + "title": "Updates the pipeline resource", "responses": { - "202": { - "headers": { - "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" - }, + "200": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US", "properties": { "remoteCloud": "testdc" + }, + "tags": { + "tag": "value" } } }, - "200": { + "202": { "body": { - "tags": { - "tag": "value" - }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "type": "Microsoft.AzureDataTransfer/pipelines", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", "location": "East US", "properties": { "remoteCloud": "testdc" + }, + "tags": { + "tag": "value" } + }, + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2025-04-11-preview" } } } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postListApprovedSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postListApprovedSchemas.json index 9a1e8a9a4542..8cd3adbeeabd 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postListApprovedSchemas.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postListApprovedSchemas.json @@ -2,8 +2,8 @@ "parameters": { "api-version": "2025-04-11-preview", "pipeline": { - "pipeline": "test", - "direction": "Send" + "direction": "Send", + "pipeline": "test" } }, "responses": { @@ -17,5 +17,7 @@ ] } } - } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "title": "Performs action request" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postValidateSchema.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postValidateSchema.json index 5f5e3b1108c2..2e07d2b03489 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postValidateSchema.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/postValidateSchema.json @@ -1,16 +1,18 @@ { "parameters": { - "api-version": "2025-04-11-preview", "schema": { "name": "schema.xml" - } + }, + "api-version": "2025-04-11-preview" }, "responses": { "200": { "body": { - "status": "Failed", - "message": "Validation failed" + "message": "Validation failed", + "status": "Failed" } } - } + }, + "operationId": "AzureDataTransfer_validateSchema", + "title": "Performs action request" } diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/rejectConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/rejectConnection.json new file mode 100644 index 000000000000..2c4600b3c954 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/rejectConnection.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pipelines_RejectConnection", + "parameters": { + "api-version": "2025-04-11-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": "Rejects 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-04-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpointPorts.json index de9004399131..f4c1a6e6718a 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpointPorts.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpointPorts.json @@ -1,21 +1,23 @@ { + "operationId": "Flows_SetDestinationEndpointPorts", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "streamDestinationEndpointPorts": { "ports": [ 1234 ] - } + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Set the flow stream destination endpoint ports", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpoints.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpoints.json index ce0cfa9e01f9..6b8be8c1d78a 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpoints.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowDestinationEndpoints.json @@ -1,21 +1,23 @@ { + "operationId": "Flows_SetDestinationEndpoints", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "streamDestinationEndpoints": { "endpoints": [ "10.0.0.1" ] - } + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Set the flow stream destination endpoints", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowPassphrase.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowPassphrase.json index dd8f6bce2a9f..0a785c1d8459 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowPassphrase.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowPassphrase.json @@ -1,19 +1,21 @@ { + "operationId": "Flows_SetPassphrase", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", - "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "passphrase": { "value": "password123" - } + }, + "resourceGroupName": "testRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Set the flow stream passphrase", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowSourceAddresses.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowSourceAddresses.json index 3bcb8be56f18..e75b7e908e98 100644 --- a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowSourceAddresses.json +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-04-11-preview/examples/setFlowSourceAddresses.json @@ -1,22 +1,24 @@ { + "operationId": "Flows_SetSourceAddresses", "parameters": { + "api-version": "2025-04-11-preview", "connectionName": "testConnection", "flowName": "testFlow", "resourceGroupName": "testRG", - "api-version": "2025-04-11-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "sourceAddresses": { "values": [ "0.0.0.0", "1.0.0.0/24" ] - } + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Set the flow stream source addresses", "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "type": "Microsoft.AzureDataTransfer/flows", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", "location": "East US" } }, diff --git a/specification/azuredatatransfer/resource-manager/readme.md b/specification/azuredatatransfer/resource-manager/readme.md index 88875d28ddd4..c9a8dd715e83 100644 --- a/specification/azuredatatransfer/resource-manager/readme.md +++ b/specification/azuredatatransfer/resource-manager/readme.md @@ -93,6 +93,39 @@ input-file: - Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.json ``` +## Suppressions + +```yaml +suppressions: + - code: AvoidAdditionalProperties + from: azuredatatransfer.json + where: $.definitions.ReadPipelineConnection + reason: + This is due to the migration to make use of [lifecycle visibility transforms](https://typespec.io/docs/language-basics/visibility/#lifecycle-visibility-transforms) + typespec (which changed the name), the old OpenAPI v2 JSON spec had this property already in the original model. + This is required as the Pipeline and Connection that this references exist across ARM Subscription(s) and Entra Id + Tenant boundaries. This metadata is meant to be readOnly and exposed as information to a user. i.e. + This connection exists as in tenant id 11111111-1111-1111-1111-111111111111. + - code: AvoidAdditionalProperties + from: azuredatatransfer.json + where: $.definitions.ReadReadPipelineConnectionProperties + reason: + This was inherited from a new model being created in typespec, the old OpenAPI v2 JSON spec had this + property in the original model (just it was an inline model). This is required as the Pipeline and Connection + that this references exist across ARM Subscription and Entra Id Tenant boundaries. This metadata is meant to be + readOnly and exposed as information to a user. i.e. This connection exists as in tenant id + 11111111-1111-1111-1111-111111111111. + - code: AvoidAdditionalProperties + from: azuredatatransfer.json + where: $.definitions.ReadReadInternalMetadataProperties + reason: + This is due to the migration to make use of [lifecycle visibility transforms](https://typespec.io/docs/language-basics/visibility/#lifecycle-visibility-transforms) + typespec (which changed the name), the old OpenAPI v2 JSON spec had this property already in the original model. + This is required as the Pipeline and Connection that this references exist across ARM Subscription(s) and Entra Id + Tenant boundaries. This metadata is meant to be readOnly and exposed as information to a user. i.e. + This connection exists as in tenant id 11111111-1111-1111-1111-111111111111. +``` + --- # Code Generation