diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json new file mode 100644 index 000000000000..f70189067610 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json @@ -0,0 +1,2400 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-07", + "title": "azuredatatransferrp", + "description": "Azure Data Transfer service resource provider" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AzureDataTransfer/validateSchema": { + "post": { + "description": "Validates a schema for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postValidateSchema.json" + } + }, + "operationId": "AzureDataTransfer_validateSchema", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + }, + "description": "The schema to validate" + } + ], + "responses": { + "200": { + "description": "Result of the schema validation.", + "schema": { + "$ref": "#/definitions/validateSchemaResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { + "post": { + "description": "Lists approved schemas for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postListApprovedSchemas.json" + } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/listApprovedSchemasRequest" + }, + "description": "The request to list approved schemas." + } + ], + "responses": { + "200": { + "description": "List of approved schemas.", + "schema": { + "$ref": "#/definitions/schemasListResult" + } + }, + "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}": { + "get": { + "description": "Gets flow resource.", + "x-ms-examples": { + "Gets flow resource": { + "$ref": "examples/getFlow.json" + } + }, + "operationId": "Flows_Get", + "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": "Retrieved the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "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" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flow" + } + } + ], + "responses": { + "200": { + "description": "Created the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "201": { + "description": "Accepted creation the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "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": 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" + } + }, + "operationId": "Flows_Delete", + "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": { + "202": { + "description": "Accepted delete the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the flows resource." + }, + "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": 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" + } + }, + "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" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flowsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Accepted update to the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/flow" + } + }, + "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": true, + "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" + } + }, + "operationId": "Flows_Enable", + "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": "Enables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Enables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": 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" + } + }, + "operationId": "Flows_Disable", + "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": "Disables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Disables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/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", + "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" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Links a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/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", + "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" + } + ], + "responses": { + "200": { + "description": "Listed all flows under the resource group.", + "schema": { + "$ref": "#/definitions/flowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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}": { + "get": { + "description": "Gets connection resource.", + "x-ms-examples": { + "Gets connection resource": { + "$ref": "examples/getConnection.json" + } + }, + "operationId": "Connections_Get", + "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" + } + ], + "responses": { + "200": { + "description": "Retrieved the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "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" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connection" + } + } + ], + "responses": { + "200": { + "description": "Created the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "201": { + "description": "Accepted create of the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "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": 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" + } + }, + "operationId": "Connections_Delete", + "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" + } + ], + "responses": { + "202": { + "description": "Accepted delete the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the connections resource." + }, + "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": 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" + } + }, + "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" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connectionsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Accepted update to the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/connection" + } + }, + "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": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "post": { + "description": "Links the connection to its pending connection.", + "x-ms-examples": { + "Links the specified connection": { + "$ref": "examples/linkConnection.json" + } + }, + "operationId": "Connections_Link", + "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" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Links a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "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", + "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" + } + ], + "responses": { + "200": { + "description": "Listed all pending connections.", + "schema": { + "$ref": "#/definitions/pendingConnectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "operationId": "ListPendingFlows_List", + "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" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/pendingFlowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "operationId": "Connections_ListByResourceGroup", + "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" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "operationId": "Connections_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the subscription.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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", + "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" + } + ], + "responses": { + "200": { + "description": "Retrieved the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "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" + } + }, + "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": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipeline" + } + } + ], + "responses": { + "200": { + "description": "Created the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "201": { + "description": "Accepted create of the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "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": 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" + } + }, + "operationId": "Pipelines_Delete", + "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" + } + ], + "responses": { + "202": { + "description": "Accepted delete of the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the pipelines resource." + }, + "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": 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" + } + }, + "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": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipelinesPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "202": { + "description": "Accepted update to the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "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": 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" + } + }, + "operationId": "Pipelines_ApproveConnection", + "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": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Approves a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": 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" + } + }, + "operationId": "Pipelines_RejectConnection", + "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": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Rejects a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Rejects a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "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": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "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", + "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": "schema", + "description": "Schema(s) to retrieve", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemasListResult" + } + }, + "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/pipelines": { + "get": { + "description": "Gets pipelines in a resource group.", + "x-ms-examples": { + "Gets pipelines in a resource group": { + "$ref": "examples/listPipelinesByResourceGroup.json" + } + }, + "operationId": "Pipelines_ListByResourceGroup", + "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" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the resource group.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the subscription.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AzureDataTransfer/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/listOperations.json" + } + }, + "description": "Lists all of the available Microsoft.AzureDataTransfer REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all of the available operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "validateSchemaResult": { + "type": "object", + "description": "Result of the schema validation.", + "properties": { + "status": { + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "validateSchemaStatus", + "modelAsString": true + }, + "description": "Validation status of the schema" + }, + "message": { + "type": "string", + "description": "Message describing the schema validation" + } + } + }, + "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 + } + } + } + }, + "selectedResource": { + "type": "object", + "description": "A resource selected from ARM", + "properties": { + "name": { + "type": "string", + "description": "Name of the connection" + }, + "id": { + "type": "string", + "description": "Id of the connection" + }, + "location": { + "type": "string", + "description": "Location of the connection", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "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" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "AME, PME, or TORUS only! AKV Chain Containing SAS Token" + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "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" + }, + "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" + }, + "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 + }, + "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" + } + }, + "description": "Properties of flow" + }, + "flow": { + "type": "object", + "x-ms-azure-resource": true, + "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." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The flow resource definition." + }, + "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 + } + }, + "allOf": [ + { + "$ref": "#/definitions/flowProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "flowsPatch": { + "type": "object", + "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": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The flows resource patch definition." + }, + "flowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/flow" + }, + "description": "Flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The flows list result." + }, + "connectionProperties": { + "type": "object", + "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 + } + }, + "justification": { + "type": "string", + "description": "Justification for the connection request" + }, + "status": { + "description": "Status of the connection", + "enum": [ + "InReview", + "Approved", + "Rejected", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "readOnly": true + }, + "statusReason": { + "type": "string", + "description": "Reason for status", + "readOnly": true + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatus", + "modelAsString": true + }, + "description": "Link status of the current connection", + "readOnly": true + }, + "linkedConnectionId": { + "type": "string", + "description": "Resource ID of the linked connection", + "readOnly": true + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types being requested for this connection" + }, + "requirementId": { + "description": "Requirement ID of the connection", + "type": "string" + }, + "remoteSubscriptionId": { + "description": "Subscription ID to link cloud subscriptions together", + "type": "string" + }, + "approver": { + "description": "Approver of this connection request", + "type": "string", + "readOnly": true + }, + "pin": { + "description": "PIN to link requests together", + "type": "string" + }, + "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": { + "description": "Provisioning state of the connection", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this connection", + "items": { + "type": "string" + } + }, + "schemas": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemas" + } + }, + "required": [ + "pipeline" + ], + "description": "Properties of connection" + }, + "connection": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/connectionProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The connection resource definition." + }, + "pendingConnection": { + "type": "object", + "description": "Pending connection object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending connection.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/connectionProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "connectionsPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The connections resource patch definition." + }, + "connectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/connection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingConnectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingConnection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingFlowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingFlow" + }, + "description": "flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "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": {} + } + }, + "additionalProperties": {}, + "required": [ + "id" + ] + }, + "pipelineProperties": { + "type": "object", + "properties": { + "remoteCloud": { + "type": "string", + "description": "Remote cloud of the data to be transferred or received" + }, + "displayName": { + "type": "string", + "description": "Display name of this pipeline" + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + }, + "subscribers": { + "type": "array", + "items": { + "$ref": "#/definitions/subscriber" + }, + "x-ms-identifiers": [], + "description": "Subscribers of this resource" + }, + "provisioningState": { + "description": "Provisioning state of the pipeline", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this pipeline", + "items": { + "type": "string" + } + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "required": [ + "remoteCloud" + ], + "description": "Properties of pipeline" + }, + "pipeline": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/pipelineProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The pipeline resource definition." + }, + "pipelinesPatch": { + "type": "object", + "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" + } + }, + "description": "Properties of pipelines patch body." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The pipelines resource patch definition." + }, + "pipelinesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pipeline" + }, + "description": "Pipelines array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The pipelines list result." + }, + "subscriber": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email of the subscriber" + }, + "notifications": { + "type": "integer", + "format": "int64", + "description": "Number specifying what notifications to receive" + } + } + }, + "schemas": { + "type": "array", + "description": "The schemas for this connection", + "x-ms-identifiers": [ + "connectionId", + "name" + ], + "items": { + "$ref": "#/definitions/schema" + } + }, + "schema": { + "type": "object", + "description": "The schema object.", + "properties": { + "id": { + "type": "string", + "description": "ID associated with this schema" + }, + "connectionId": { + "type": "string", + "description": "Connection ID associated with this schema" + }, + "status": { + "enum": [ + "New", + "Approved" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaStatus", + "modelAsString": true + }, + "description": "Status of the schema" + }, + "name": { + "type": "string", + "description": "Name of the schema" + }, + "content": { + "type": "string", + "description": "Content of the schema" + }, + "direction": { + "description": "The direction of the schema.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaDirection", + "modelAsString": true + } + } + } + }, + "schemasListResult": { + "type": "object", + "properties": { + "value": { + "description": "Schemas array.", + "$ref": "#/definitions/schemas" + } + }, + "description": "The schemas list result." + }, + "flowTypes": { + "type": "array", + "description": "The flow types that are allowed for this resource", + "items": { + "$ref": "#/definitions/flowType" + } + }, + "flowType": { + "enum": [ + "Unknown", + "Complex", + "DevSecOps", + "Messaging", + "Mission", + "MicrosoftInternal", + "BasicFiles", + "Data", + "Standard", + "StreamingVideo", + "Opaque", + "MissionOpaqueXML" + ], + "type": "string", + "x-ms-enum": { + "name": "flowType", + "modelAsString": true + }, + "description": "Flow type for the specified resource" + }, + "resourceBody": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the resource." + }, + "statusReason": { + "type": "string", + "description": "Reason for resource operation." + } + }, + "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." + } + }, + "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." + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json new file mode 100644 index 000000000000..e3d72dc8dd90 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "statusReason": "Example reason" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json new file mode 100644 index 000000000000..319f0db0e75c --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json new file mode 100644 index 000000000000..56f3179a2f64 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "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" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json new file mode 100644 index 000000000000..265c5695e3fd --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": { + "properties": { + "remoteCloud": "testdc" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json new file mode 100644 index 000000000000..11ba85eddd3e --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json new file mode 100644 index 000000000000..f9ef8d7853f9 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json new file mode 100644 index 000000000000..c9a9ff7bdbc9 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json new file mode 100644 index 000000000000..b256b3b9425d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json new file mode 100644 index 000000000000..720b677100ff --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json new file mode 100644 index 000000000000..9c8b4e0ccfa6 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json new file mode 100644 index 000000000000..d0b8a32bdbef --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json new file mode 100644 index 000000000000..752823ea5b0f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connection", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json new file mode 100644 index 000000000000..4f39abfc5385 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json new file mode 100644 index 000000000000..c266030c70c0 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "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", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json new file mode 100644 index 000000000000..34432d1b8a73 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "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", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json new file mode 100644 index 000000000000..9a87876e7792 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "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/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "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" + } + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "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" + } + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json new file mode 100644 index 000000000000..3034f110a90e --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "teleportalClient", + "api-version": "2024-05-07", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureDataTransfer/read", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Read flows", + "description": "Read flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/write", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Update flows", + "description": "Update flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/delete", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Delete flows", + "description": "Delete flows" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json new file mode 100644 index 000000000000..37357e5953c7 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "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", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json new file mode 100644 index 000000000000..133d21a90312 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testFlow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + }, + { + "name": "testInstallation2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json new file mode 100644 index 000000000000..56dece17d741 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json new file mode 100644 index 000000000000..db2e706c6ba4 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json new file mode 100644 index 000000000000..fc625b991ce5 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schema": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "name": "test.xsd" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json new file mode 100644 index 000000000000..60e92ca408c6 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json new file mode 100644 index 000000000000..b6f94cb4e9d3 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "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", + "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" + } + } + } + }, + "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", + "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" + } + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json new file mode 100644 index 000000000000..e4fee607cd51 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json new file mode 100644 index 000000000000..112204607668 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "pipeline": { + "pipeline": "test", + "direction": "Send" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json new file mode 100644 index 000000000000..9b2c3871b48f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "schema": { + "name": "schema.xml" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "message": "Validation failed" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/readme.md b/specification/azuredatatransfer/resource-manager/readme.md index ef5fc181349f..4fa16a5b3e8e 100644 --- a/specification/azuredatatransfer/resource-manager/readme.md +++ b/specification/azuredatatransfer/resource-manager/readme.md @@ -27,10 +27,19 @@ These are the global settings for the azuredatatransfer. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-2024-05 ``` +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-05' +input-file: + - Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line.