ConnectToTargetSqlMITask.json

{
  "swagger": "2.0",
  "info": {
    "title": "Azure Database Migration Service Resource Provider",
    "version": "2018-07-15-preview"
  },
  "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": {},
  "definitions": {
    "ConnectToTargetSqlMITaskInput": {
      "type": "object",
      "description": "Input for the task that validates connection to Azure SQL Database Managed Instance.",
      "properties": {
        "targetConnectionInfo": {
          "description": "Connection information for target SQL Server",
          "$ref": "./Common.json#/definitions/SqlConnectionInfo"
        },
        "collectLogins": {
          "type": "boolean",
          "description": "Flag for whether to collect logins from target SQL MI server.",
          "default": true
        },
        "collectAgentJobs": {
          "type": "boolean",
          "description": "Flag for whether to collect agent jobs from target SQL MI server.",
          "default": true
        },
        "validateSsisCatalogOnly": {
          "type": "boolean",
          "description": "Flag for whether to validate SSIS catalog is reachable on the target SQL MI server.",
          "default": false
        }
      },
      "required": [
        "targetConnectionInfo"
      ]
    },
    "ConnectToTargetSqlMITaskOutput": {
      "type": "object",
      "description": "Output for the task that validates connection to Azure SQL Database Managed Instance.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Result identifier",
          "readOnly": true
        },
        "targetServerVersion": {
          "type": "string",
          "description": "Target server version",
          "readOnly": true
        },
        "targetServerBrandVersion": {
          "type": "string",
          "description": "Target server brand version",
          "readOnly": true
        },
        "logins": {
          "type": "array",
          "description": "List of logins on the target server.",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "agentJobs": {
          "type": "array",
          "description": "List of agent jobs on the target server.",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "validationErrors": {
          "description": "Validation errors",
          "type": "array",
          "items": {
            "$ref": "./Common.json#/definitions/ReportableException"
          },
          "readOnly": true
        }
      }
    }
  }
}