swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SqlMigrationServices API
schemes:
- https
tags:
- name: SqlMigrationServices
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}
  : get:
      tags:
      - SqlMigrationServices
      description: Retrieve the Database Migration Service
      operationId: microsoftAzureSqlmigrationservicesGet
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the Migration Service.
          schema:
            $ref: '#/definitions/SqlMigrationService'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-examples:
        Get Migration Service.:
          $ref: ./examples/GetSqlMigrationService.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename
    put:
      tags:
      - SqlMigrationServices
      description: Create or Update Database Migration Service.
      operationId: microsoftAzureSqlmigrationservicesCreateorupdate
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - name: parameters
        in: body
        description: Details of SqlMigrationService resource.
        required: true
        schema:
          $ref: '#/definitions/SqlMigrationService'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the SQL migration Service.
          schema:
            $ref: '#/definitions/SqlMigrationService'
        '201':
          description: Successfully created the SQL migration Service.
          schema:
            $ref: '#/definitions/SqlMigrationService'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-long-running-operation: true
      x-ms-examples:
        Create or Update SQL Migration Service with minimum parameters.:
          $ref: ./examples/CreateOrUpdateSqlMigrationServiceMIN.json
        Create or Update SQL Migration Service with maximum parameters.:
          $ref: ./examples/CreateOrUpdateSqlMigrationServiceMAX.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename
    delete:
      tags:
      - SqlMigrationServices
      description: Delete Database Migration Service.
      operationId: microsoftAzureSqlmigrationservicesDelete
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the SQL migration Service.
        '202':
          description: Deleting the SQL migration Service.
        '204':
          description: The specified SQL migration Service does not exist.
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete SQL Migration Service.:
          $ref: ./examples/DeleteSqlMigrationService.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename
    patch:
      tags:
      - SqlMigrationServices
      description: Update Database Migration Service.
      operationId: microsoftAzureSqlmigrationservicesUpdate
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - name: parameters
        in: body
        description: Details of SqlMigrationService resource.
        required: true
        schema:
          $ref: '#/definitions/SqlMigrationServiceUpdate'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the SQL migration Service.
          schema:
            $ref: '#/definitions/SqlMigrationService'
        '201':
          description: Successfully created the SQL migration Service.
          schema:
            $ref: '#/definitions/SqlMigrationService'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-long-running-operation: true
      x-ms-examples:
        Update SQL Migration Service.:
          $ref: ./examples/UpdateSqlMigrationService.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices:
    get:
      tags:
      - SqlMigrationServices
      description: Retrieve all SQL migration services in the resource group.
      operationId: microsoftAzureSqlmigrationservicesListbyresourcegroup
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the Migration SErvices in the resource group.
          schema:
            $ref: '#/definitions/SqlMigrationListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get Migration Services in the Resource Group.:
          $ref: ./examples/ListByResourceGroupSqlMigrationService.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listAuthKeys
  : post:
      tags:
      - SqlMigrationServices
      description: Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.
      operationId: microsoftAzureSqlmigrationservicesListauthkeys
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully return of List Authentication Keys.
          schema:
            $ref: '#/definitions/AuthenticationKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-examples:
        Retrieve the List of Authentication Keys.:
          $ref: ./examples/ListAuthKeysSqlMigrationService.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename Listauthkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/regenerateAuthKeys
  : post:
      tags:
      - SqlMigrationServices
      description: Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.
      operationId: microsoftAzureSqlmigrationservicesRegenerateauthkeys
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - name: parameters
        in: body
        description: Details of SqlMigrationService resource.
        required: true
        schema:
          $ref: '#/definitions/RegenAuthKeys'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully regenerate of Authentication Keys.
          schema:
            $ref: '#/definitions/RegenAuthKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-examples:
        Regenerate the of Authentication Keys.:
          $ref: ./examples/RegenAuthKeysSqlMigrationService.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename Regenerateauthkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/deleteNode
  : post:
      tags:
      - SqlMigrationServices
      description: Delete the integration runtime node.
      operationId: microsoftAzureSqlmigrationservicesDeletenode
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - name: parameters
        in: body
        description: Details of SqlMigrationService resource.
        required: true
        schema:
          $ref: '#/definitions/deleteNode'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully delete the integration runtime node.
          schema:
            $ref: '#/definitions/deleteNode'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-examples:
        Delete the integration runtime node.:
          $ref: ./examples/DeleteIntegrationRuntimeNode.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename Deletenode
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listMigrations
  : get:
      tags:
      - SqlMigrationServices
      description: Retrieve the List of database migrations attached to the service.
      operationId: microsoftAzureSqlmigrationservicesListmigrations
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully return of migrations attached to the service.
          schema:
            $ref: '#/definitions/DatabaseMigrationListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List database migrations attached to the service.:
          $ref: ./examples/ListMigrationsBySqlMigrationService.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename Listmigrations
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataMigration/sqlMigrationServices/{sqlMigrationServiceName}/listMonitoringData
  : post:
      tags:
      - SqlMigrationServices
      description: Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.
      operationId: microsoftAzureSqlmigrationservicesListmonitoringdata
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/SqlMigrationServiceNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the monitoring data.
          schema:
            $ref: '#/definitions/IntegrationRuntimeMonitoringData'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-examples:
        Retrieve the Monitoring Data.:
          $ref: ./examples/GetMonitorDataSqlMigrationService.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datamigration Sqlmigrationservices Sqlmigrationservicename Listmonitoringdata
  /subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/sqlMigrationServices:
    get:
      tags:
      - SqlMigrationServices
      description: Retrieve all SQL migration services in the subscriptions.
      operationId: microsoftAzureSqlmigrationservicesListbysubscription
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the Migration Services in the Subscription.
          schema:
            $ref: '#/definitions/SqlMigrationListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was provided for parameter '{0}'.\n\n * 400 GenericUser - User Failure when calling other Resource Provider.\n\n * 400 OperationIdNotFound - Operation ID '{0}' not found.\n\n * 400 OperationTypeNotFound - Operation Type '{0}' not found.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 RegenerateAuthenticationKeyNameInvalid - Key name '{0}' is invalid. Valid key names are authKey1 and authKey2.\n\n * 400 DeleteServiceNotAllowed - One or more migrations attached to the migration service '{0}' are currently running. To delete the migration service, please wait until all migrations have completed or cancel the migrations manually and retry deleting the service. Running migrations are: '{1}'\n\n * 400 IntegrationRuntimeIsNotSelfHosted - Integration Runtime is not self-hosted for subscription '{0}' resource group '{1}' and name '{2}'\n\n * 400 SerializationError - There was an error while processing response from RP Service : '{0}'\n\n * 400 ServiceNameInvalid - Service name '{0}' is not valid. Please refer https://aka.ms/dmsv2naming for naming rules.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 GenericSystem - System Failure when calling other Resource Provider."
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get Services in the Subscriptions.:
          $ref: ./examples/ListBySubscriptionSqlMigrationService.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Datamigration Sqlmigrationservices
definitions:
  NodeMonitoringData:
    type: object
    properties:
      additionalProperties:
        description: ' Unmatched properties from the message are deserialized in this collection.'
        type: object
        additionalProperties:
          type: object
        readOnly: true
      nodeName:
        description: Name of the integration runtime node.
        type: string
        readOnly: true
      availableMemoryInMB:
        format: int32
        description: Available memory (MB) on the integration runtime node.
        type: integer
        readOnly: true
      cpuUtilization:
        format: int32
        description: CPU percentage on the integration runtime node.
        type: integer
        readOnly: true
      concurrentJobsLimit:
        format: int32
        description: Maximum concurrent jobs on the integration runtime node.
        type: integer
        readOnly: true
      concurrentJobsRunning:
        format: int32
        description: The number of jobs currently running on the integration runtime node.
        type: integer
        readOnly: true
      maxConcurrentJobs:
        format: int32
        description: The maximum concurrent jobs in this integration runtime.
        type: integer
        readOnly: true
      sentBytes:
        format: double
        description: Sent bytes on the integration runtime node.
        type: number
        readOnly: true
      receivedBytes:
        format: double
        description: Received bytes on the integration runtime node.
        type: number
        readOnly: true
  SqlMigrationServiceUpdate:
    description: An update to a SQL Migration Service.
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
  ErrorInfo:
    description: Error details
    type: object
    properties:
      code:
        description: Error code.
        type: string
        readOnly: true
      message:
        description: Error message.
        type: string
        readOnly: true
  DatabaseMigration:
    description: Database Migration Resource.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        $ref: '#/definitions/DatabaseMigrationProperties'
        x-ms-client-flatten: false
    x-ms-azure-resource: true
  SqlMigrationListResult:
    description: A list of SQL Migration Service.
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SqlMigrationService'
        readOnly: true
      nextLink:
        type: string
        readOnly: true
  DatabaseMigrationListResult:
    description: A list of Database Migrations.
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DatabaseMigration'
        readOnly: true
      nextLink:
        type: string
        readOnly: true
  SqlMigrationServiceProperties:
    description: The SQL Migration Service properties.
    type: object
    properties:
      provisioningState:
        description: Provisioning state to track the async operation status.
        type: string
        readOnly: true
      integrationRuntimeState:
        description: Current state of the Integration runtime.
        type: string
        readOnly: true
  deleteNode:
    description: Details of node to be deleted.
    type: object
    properties:
      nodeName:
        description: The name of node to delete.
        type: string
        x-ms-mutability:
        - read
        - create
      integrationRuntimeName:
        description: The name of integration runtime.
        type: string
        x-ms-mutability:
        - read
        - create
  IntegrationRuntimeMonitoringData:
    description: Integration Runtime Monitoring Data.
    type: object
    properties:
      name:
        description: The name of Integration Runtime.
        type: string
        readOnly: true
      nodes:
        description: Integration Runtime node monitoring data.
        type: array
        items:
          $ref: '#/definitions/NodeMonitoringData'
        readOnly: true
  TrackedResource:
    type: object
    properties:
      location:
        type: string
        x-ms-mutability:
        - read
        - create
      tags:
        type: object
        additionalProperties:
          type: string
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
      type:
        type: string
        readOnly: true
      systemData:
        $ref: '#/definitions/SystemData'
        readOnly: true
    x-ms-azure-resource: true
  AuthenticationKeys:
    description: An authentication key.
    type: object
    properties:
      authKey1:
        description: The first authentication key.
        type: string
        x-ms-secret: true
        x-ms-mutability:
        - read
        - create
      authKey2:
        description: The second authentication key.
        type: string
        x-ms-secret: true
        x-ms-mutability:
        - read
        - create
  RegenAuthKeys:
    description: An authentication key to regenerate.
    type: object
    properties:
      keyName:
        description: The name of authentication key to generate.
        type: string
        x-ms-mutability:
        - read
        - create
      authKey1:
        description: The first authentication key.
        type: string
        x-ms-secret: true
        x-ms-mutability:
        - read
        - create
      authKey2:
        description: The second authentication key.
        type: string
        x-ms-secret: true
        x-ms-mutability:
        - read
        - create
  SqlConnectionInformation:
    description: Source SQL Connection
    type: object
    properties:
      dataSource:
        description: Data source.
        type: string
      authentication:
        description: Authentication type.
        type: string
      userName:
        description: User name to connect to source SQL.
        type: string
      password:
        description: Password to connect to source SQL.
        type: string
        format: password
        x-ms-secret: true
      encryptConnection:
        description: Whether to encrypt connection or not.
        type: boolean
      trustServerCertificate:
        description: Whether to trust server certificate or not.
        type: boolean
  DatabaseMigrationProperties:
    required:
    - kind
    allOf:
    - $ref: '#/definitions/DatabaseMigrationBaseProperties'
    description: Database Migration Resource properties.
    type: object
    properties:
      sourceSqlConnection:
        $ref: '#/definitions/SqlConnectionInformation'
        description: Source SQL Server connection details.
      sourceDatabaseName:
        description: Name of the source database.
        type: string
      sourceServerName:
        description: Name of the source sql server.
        type: string
        readOnly: true
      targetDatabaseCollation:
        description: Database collation to be used for the target database.
        type: string
    discriminator: kind
  DatabaseMigrationBaseProperties:
    required:
    - kind
    description: Database Migration Base Resource properties.
    type: object
    properties:
      kind:
        enum:
        - SqlMi
        - SqlVm
        - SqlDb
        - MongoToCosmosDbMongo
        type: string
        x-ms-enum:
          name: ResourceType
          modelAsString: true
      scope:
        description: Resource Id of the target resource.
        type: string
        x-ms-mutability:
        - read
        - create
      provisioningState:
        enum:
        - Provisioning
        - Updating
        - Succeeded
        - Failed
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
        description: Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
      migrationStatus:
        description: Migration status.
        type: string
        readOnly: true
      startedOn:
        format: date-time
        description: Database migration start time.
        type: string
        readOnly: true
      endedOn:
        format: date-time
        description: Database migration end time.
        type: string
        readOnly: true
      migrationService:
        description: Resource Id of the Migration Service.
        type: string
        format: arm-id
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.DataMigration/migrationServices
          - type: Microsoft.DataMigration/sqlMigrationServices
      migrationOperationId:
        description: ID for current migration operation.
        type: string
      migrationFailureError:
        $ref: '#/definitions/ErrorInfo'
        description: Error details in case of migration failure.
        readOnly: true
      provisioningError:
        description: Error message for migration provisioning failure, if any.
        type: string
    discriminator: kind
  SqlMigrationService:
    description: A SQL Migration Service.
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/SqlMigrationServiceProperties'
        x-ms-client-flatten: true
    x-ms-azure-resource: true
  SystemData:
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
      createdByType:
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        x-ms-enum:
          name: createdByType
          modelAsString: true
      createdAt:
        format: date-time
        type: string
      lastModifiedBy:
        type: string
      lastModifiedByType:
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        format: date-time
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: API version to use for the request.
    required: true
    type: string
    x-ms-parameter-location: client
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription ID that identifies an Azure subscription.
    required: true
    type: string
    x-ms-parameter-location: client
  SqlMigrationServiceNameParameter:
    name: sqlMigrationServiceName
    in: path
    description: Name of the SQL Migration Service.
    required: true
    type: string
    x-ms-parameter-location: method
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'