swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector AssessedSqlDatabaseV2Operations API schemes: - https tags: - name: AssessedSqlDatabaseV2Operations paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases : get: operationId: microsoftAzureAssessedsqldatabasev2operationsListbysqlassessmentv2 tags: - AssessedSqlDatabaseV2Operations description: List AssessedSqlDatabaseV2 resources by SqlAssessmentV2 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: $filter in: query description: Filter query. required: false type: string - name: pageSize in: query description: Optional parameter for page size. required: false type: integer format: int32 - name: continuationToken in: query description: Optional parameter for continuation token. required: false type: string - name: totalRecordCount in: query description: Total record count. required: false type: integer format: int32 - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: assessmentName in: path description: SQL Assessment arm name. required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/AssessedSqlDatabaseV2ListResult' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen: $ref: ./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Sqlassessments Assessmentname Assessedsqldatabases ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName} : get: operationId: microsoftAzureAssessedsqldatabasev2operationsGet tags: - AssessedSqlDatabaseV2Operations description: Get a AssessedSqlDatabaseV2 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: assessmentName in: path description: SQL Assessment arm name. required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: assessedSqlDatabaseName in: path description: Sql assessment Assessed Databases ARM name. required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/AssessedSqlDatabaseV2' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen: $ref: ./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Sqlassessments Assessmentname Assessedsqldatabases Assessedsqldatabasename definitions: AzureManagedDiskSkuDTO: type: object description: Class representing an Azure Managed Disk SKU. properties: diskType: $ref: '#/definitions/AzureManagedDiskSkuDTODiskType' description: Gets the Type ("tier") of disk - e.g. standard, premium, ultra. readOnly: true diskSize: $ref: '#/definitions/AzureDiskSize' description: Gets the Size of the managed disk - e.g. P30, P40. readOnly: true diskRedundancy: $ref: '#/definitions/AzureManagedDiskSkuDTODiskRedundancy' description: Gets disk redundancy - e.g. LRS, ZRS. readOnly: true storageCost: type: number format: float description: Gets the managed disk storage cost. readOnly: true recommendedSizeInGib: type: number format: float description: Gets the recommended in GB of the managed disk. readOnly: true recommendedThroughputInMbps: type: number format: float description: Gets the recommended throughput in MBPS of the managed disk. readOnly: true recommendedIops: type: number format: float description: Gets the recommended IOPS of the managed disk. readOnly: true AssessedSqlDatabaseV2ListResult: type: object description: The response of a AssessedSqlDatabaseV2 list operation. properties: value: type: array description: The AssessedSqlDatabaseV2 items on this page items: $ref: '#/definitions/AssessedSqlDatabaseV2' nextLink: type: string format: uri description: The link to the next page of items required: - value ImpactedAssessmentObject: type: object description: Class representing the impacted objects. properties: objectName: type: string description: Gets the object name. readOnly: true objectType: type: string description: Gets the object type. readOnly: true CompatibilityLevel: type: string enum: - Unknown - CompatLevel80 - CompatLevel90 - CompatLevel100 - CompatLevel110 - CompatLevel120 - CompatLevel130 - CompatLevel140 - CompatLevel150 x-ms-enum: name: CompatibilityLevel modelAsString: true MigrationGuidelineContext: type: object description: Migration Guideline Context. properties: contextKey: type: string description: Gets the reasoning context key. contextValue: type: string description: Gets the reasoning context value. AzureQuorumWitnessDTO: type: object description: Quorum Witness. properties: quorumWitnessType: $ref: '#/definitions/AzureQuorumWitnessDTOQuorumWitnessType' description: Gets quorum witness type. readOnly: true CostComponentName: type: string description: Enum to represent component name. enum: - Unknown - MonthlyAzureHybridCostSavings - MonthlySecurityCost - MonthlyPremiumV2StorageCost - MonthlyLinuxAzureHybridCostSavings x-ms-enum: name: CostComponentName modelAsString: true SqlAssessmentMigrationIssue: type: object description: Class representing the SQL migration issues. properties: issueId: type: string description: Gets the issue id. readOnly: true issueCategory: $ref: '#/definitions/SqlAssessmentMigrationIssueCategory' description: Gets the issue category. readOnly: true impactedObjects: type: array description: Gets the list of impacted objects. items: $ref: '#/definitions/ImpactedAssessmentObject' readOnly: true x-ms-identifiers: [] AzureManagedDiskSkuDTODiskType: type: string enum: - Unknown - Standard - StandardSSD - Premium - StandardOrPremium - Ultra - PremiumV2 x-ms-enum: name: AzureManagedDiskSkuDTODiskType modelAsString: true TargetType: type: string enum: - Unknown - Recommended - AzureSqlDatabase - AzureSqlManagedInstance - AzureSqlVirtualMachine - AzureVirtualMachine x-ms-enum: name: TargetType modelAsString: true SqlRecommendationReasoningContext: type: object description: Class representing Azure SQL Recommendation Reasoning Context. properties: contextKey: type: string description: Gets the reasoning context key. contextValue: type: string description: Gets the reasoning context value. CloudSuitability: type: string description: Cloud Suitability for Azure. enum: - Unknown - NotSuitable - Suitable - ConditionallySuitable - ReadinessUnknown x-ms-enum: name: CloudSuitability modelAsString: true values: - name: Unknown value: Unknown description: Unknown. Indicates missing data. - name: NotSuitable value: NotSuitable description: Not Suitable for Azure. - name: Suitable value: Suitable description: Suitable for Azure. - name: ConditionallySuitable value: ConditionallySuitable description: Conditionally Suitable for Azure. - name: ReadinessUnknown value: ReadinessUnknown description: Unknown Readiness for Azure. ProductSupportStatus: type: object description: Class to represent the Product Support Status. properties: currentVersion: type: string description: Gets or sets current version of ServicePack. readOnly: true servicePackStatus: type: string description: Gets or sets ServicePack of the product. readOnly: true esuStatus: type: string description: Gets or sets the Extended Security Update ESU status. readOnly: true supportStatus: type: string description: Gets or sets the support status of the product. readOnly: true eta: type: integer format: int32 description: Gets or sets the ETA. readOnly: true currentEsuYear: type: string description: Gets or sets the current ESU support year. readOnly: true mainstreamEndDate: type: string format: date-time description: Gets or sets the main stream end date of the product. readOnly: true extendedSupportEndDate: type: string format: date-time description: Gets or sets the extended support end date of the product. readOnly: true extendedSecurityUpdateYear1EndDate: type: string format: date-time description: Gets or sets the extended security update year 1 end date of the product. readOnly: true extendedSecurityUpdateYear2EndDate: type: string format: date-time description: Gets or sets the extended security update year 2 end date of the product. readOnly: true extendedSecurityUpdateYear3EndDate: type: string format: date-time description: Gets or sets the extended security update year 3 end date of the product. readOnly: true AssessedSqlDatabaseV2Properties: type: object description: Assessed SQL database properties web model. properties: recommendedAzureSqlTargetType: $ref: '#/definitions/TargetType' description: Gets or sets the recommended azure SQL target type. readOnly: true recommendedSuitability: $ref: '#/definitions/RecommendedSuitability' description: Gets or sets the recommended azure SQL suitability. readOnly: true bufferCacheSizeInMB: type: number format: float description: 'Gets or sets the aggregated cache size of this database. This is a performance data metric for this DB.' readOnly: true productSupportStatus: $ref: '#/definitions/ProductSupportStatus' description: Gets the product support status related details. readOnly: true azureSqlMISuitabilityDetails: $ref: '#/definitions/SqlAssessmentV2PaasSuitabilityData' description: Gets or sets the azure SQL MI suitability details. readOnly: true azureSqlDBSuitabilityDetails: $ref: '#/definitions/SqlAssessmentV2PaasSuitabilityData' description: Gets or sets the azure SQL DB suitability details. readOnly: true isDatabaseHighlyAvailable: type: boolean description: 'Gets a value indicating whether the assessed SQL database is highly available or not.' readOnly: true linkedAvailabilityGroupOverview: $ref: '#/definitions/SqlAvailabilityGroupDataOverview' description: 'Gets the linked availability group overview if the database being assessed is highly available.' readOnly: true machineArmId: type: string description: Machine arm id. readOnly: true assessedSqlInstanceArmId: type: string description: Assessed SQL instance arm id. readOnly: true machineName: type: string description: Machine display name. readOnly: true instanceName: type: string description: SQL instance name. readOnly: true databaseName: type: string description: SQL database name. readOnly: true databaseSizeInMB: type: number format: float description: SQL database size in megabytes. readOnly: true compatibilityLevel: $ref: '#/definitions/CompatibilityLevel' description: Database compatibility level. readOnly: true sqlDatabaseSdsArmId: type: string description: SQL database SDS arm id. readOnly: true percentageCoresUtilization: type: number format: float description: The percentage of the total number of cores being utilized by the SQL database. readOnly: true megabytesPerSecondOfRead: type: number format: float description: The read throughput of the SQL database. readOnly: true megabytesPerSecondOfWrite: type: number format: float description: The write throughput of the SQL database. readOnly: true numberOfReadOperationsPerSecond: type: number format: float description: The read operations per second of the SQL database. readOnly: true numberOfWriteOperationsPerSecond: type: number format: float description: The write operations per second of the SQL database. readOnly: true confidenceRatingInPercentage: type: number format: float description: Confidence Rating in Percentage. readOnly: true sizingCriterion: $ref: '#/definitions/AssessmentSizingCriterion' description: Assessment sizing criterion. readOnly: true createdTimestamp: type: string format: date-time description: When was assessed SQL database first created. readOnly: true updatedTimestamp: type: string format: date-time description: When was assessed SQL database last updated. readOnly: true AzureManagedDiskSkuDTODiskRedundancy: type: string enum: - Unknown - LRS - ZRS x-ms-enum: name: AzureManagedDiskSkuDTODiskRedundancy modelAsString: true RecommendedSuitability: type: string enum: - Unknown - SuitableForSqlDB - SuitableForSqlMI - SuitableForVM - PotentiallySuitableForVM - ReadinessUnknown - NotSuitable - SuitableForSqlVM - ConditionallySuitableForSqlDB - ConditionallySuitableForSqlMI - ConditionallySuitableForVM - ConditionallySuitableForSqlVM x-ms-enum: name: RecommendedSuitability modelAsString: true SqlAssessmentMigrationIssueCategory: type: string enum: - Issue - Warning - Internal x-ms-enum: name: SqlAssessmentMigrationIssueCategory modelAsString: true HardwareGeneration: type: string enum: - Unknown - Automatic - Gen5 - Fsv2_series - M_series - DC_series x-ms-enum: name: HardwareGeneration modelAsString: true values: - name: Unknown value: Unknown - name: Automatic value: Automatic - name: Gen5 value: Gen5 - name: Fsv2Series value: Fsv2_series - name: MSeries value: M_series - name: DCSeries value: DC_series CostComponent: type: object description: Class to represent the component of the cost. properties: name: $ref: '#/definitions/CostComponentName' description: Gets the name of the component. readOnly: true value: type: number format: float description: The value of the component. description: type: string description: The textual description of the component. SkuReplicationMode: type: string enum: - NotApplicable - ActiveGeoReplication - FailoverGroupInstance x-ms-enum: name: SkuReplicationMode modelAsString: true SqlMigrationGuidelineCategory: type: string enum: - Unknown - General - FailoverCluterInstanceGuideLine - AvailabilityGroupGuideline x-ms-enum: name: SqlMigrationGuidelineCategory modelAsString: true AzureSqlServiceTier: type: string enum: - Unknown - Automatic - GeneralPurpose - BusinessCritical - HyperScale x-ms-enum: name: AzureSqlServiceTier modelAsString: true SqlAvailabilityGroupDataOverview: type: object description: Assessed Sql Availability Group Data Overview. properties: availabilityGroupId: type: string description: Gets the availability group id. availabilityGroupName: type: string description: Gets the availability group name. sqlAvailabilityGroupSdsArmId: type: string description: Gets the availability group arm id. sqlAvailabilityGroupEntityId: type: string description: Gets the availability group entity id. sqlAvailabilityReplicaId: type: string description: Gets the availability replica id. AzureSqlPaasSkuDTO: type: object description: Class representing Azure SQL PAAS SKU. properties: azureSqlServiceTier: $ref: '#/definitions/AzureSqlServiceTier' description: Gets the service tier. readOnly: true azureSqlComputeTier: $ref: '#/definitions/ComputeTier' description: Gets the compute tier. readOnly: true azureSqlHardwareGeneration: $ref: '#/definitions/HardwareGeneration' description: Gets the hardware generation. readOnly: true storageMaxSizeInMB: type: number format: float description: Gets the storage maximum size in megabytes. readOnly: true predictedDataSizeInMB: type: number format: float description: 'Gets the predicted data size in megabytes in the Azure SQL, will impact the billing cost.' readOnly: true predictedLogSizeInMB: type: number format: float description: 'Gets the predicted log size in megabytes in the Azure SQL, will impact the billing cost.' readOnly: true cores: type: integer format: int32 description: Gets the number of cores. readOnly: true azureSqlTargetType: $ref: '#/definitions/TargetType' description: Gets the target type. readOnly: true AzureQuorumWitnessDTOQuorumWitnessType: type: string enum: - Unknown - Cloud - Disk x-ms-enum: name: AzureQuorumWitnessDTOQuorumWitnessType modelAsString: true ComputeTier: type: string enum: - Unknown - Automatic - Provisioned - Serverless x-ms-enum: name: ComputeTier modelAsString: true SqlAssessmentV2PaasSuitabilityData: type: object description: Class representing Azure SQL PAAS suitability details. properties: azureSqlSku: $ref: '#/definitions/AzureSqlPaasSkuDTO' description: Gets the azure SQL PAAS SKU. readOnly: true replicaAzureSqlSku: type: array description: Gets the replica azure SQL PAAS SKU. items: $ref: '#/definitions/AzureSqlPaasSkuDTO' readOnly: true x-ms-identifiers: [] sharedResources: $ref: '#/definitions/SharedResourcesDTO' description: Gets the shared resources. readOnly: true monthlyComputeCost: type: number format: float description: Gets the monthly compute cost. readOnly: true monthlyStorageCost: type: number format: float description: Gets the monthly storage cost. readOnly: true costComponents: type: array description: Gets the collection of cost components. items: $ref: '#/definitions/CostComponent' x-ms-identifiers: [] securitySuitability: $ref: '#/definitions/CloudSuitability' description: Gets the suitability for Microsoft cloud defender. readOnly: true shouldProvisionReplicas: type: boolean description: Gets a value indicating whether replicas should be provisioned. readOnly: true skuReplicationMode: $ref: '#/definitions/SkuReplicationMode' description: Gets the replication mode. readOnly: true migrationGuidelines: type: array description: Gets the list of migration guidelines applicable to this target. items: $ref: '#/definitions/SqlMigrationGuideline' readOnly: true x-ms-identifiers: [] recommendationReasonings: type: array description: Gets the list of SQL recommendation Reasoning. items: $ref: '#/definitions/SqlRecommendationReasoning' readOnly: true x-ms-identifiers: [] migrationTargetPlatform: $ref: '#/definitions/TargetType' description: Gets the migration target platform. readOnly: true suitability: $ref: '#/definitions/CloudSuitability' description: Gets the azure suitability. readOnly: true migrationIssues: type: array description: Gets the list of migrations issues. items: $ref: '#/definitions/SqlAssessmentMigrationIssue' readOnly: true x-ms-identifiers: [] SqlRecommendationReasoning: type: object description: Class representing Azure SQL Recommendation Reasoning. properties: reasoningId: type: string description: Gets the reasoning id. reasoningString: type: string description: Gets the reasoning status. reasoningCategory: type: string description: Gets the reasoning category. contextParameters: type: array description: Gets the Sql recommended reasoning parameters. items: $ref: '#/definitions/SqlRecommendationReasoningContext' readOnly: true x-ms-identifiers: [] AssessedSqlDatabaseV2: type: object description: Assessed SQL database web model class. properties: properties: $ref: '#/definitions/AssessedSqlDatabaseV2Properties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource AssessmentSizingCriterion: type: string description: Assessment Sizing Criteria. enum: - PerformanceBased - AsOnPremises x-ms-enum: name: AssessmentSizingCriterion modelAsString: true values: - name: PerformanceBased value: PerformanceBased description: Performance Data based Sizing. - name: AsOnPremises value: AsOnPremises description: As On Premises or Static Data based Sizing. SqlMigrationGuideline: type: object description: Sql Migration Guideline. properties: guidelineId: type: string description: Gets the guideline id. migrationGuidelineCategory: $ref: '#/definitions/SqlMigrationGuidelineCategory' description: Gets the migration guideline category. migrationGuidelineContext: type: array description: Gets the migration guideline context. items: $ref: '#/definitions/MigrationGuidelineContext' readOnly: true x-ms-identifiers: [] AzureDiskSize: type: string enum: - Unknown - Standard_S4 - Standard_S6 - Standard_S10 - Standard_S15 - Standard_S20 - Standard_S30 - Standard_S40 - Standard_S50 - Standard_S60 - Standard_S70 - Standard_S80 - Premium_P4 - Premium_P6 - Premium_P10 - Premium_P15 - Premium_P20 - Premium_P30 - Premium_P40 - Premium_P50 - Premium_P60 - Premium_P70 - Premium_P80 - StandardSSD_E10 - StandardSSD_E15 - StandardSSD_E20 - StandardSSD_E30 - StandardSSD_E40 - StandardSSD_E50 - StandardSSD_E60 - StandardSSD_E70 - StandardSSD_E80 - StandardSSD_E4 - StandardSSD_E6 - StandardSSD_E1 - StandardSSD_E2 - StandardSSD_E3 - Premium_P1 - Premium_P2 - Premium_P3 - Ultra - PremiumV2 x-ms-enum: name: AzureDiskSize modelAsString: true values: - name: Unknown value: Unknown - name: StandardS4 value: Standard_S4 - name: StandardS6 value: Standard_S6 - name: StandardS10 value: Standard_S10 - name: StandardS15 value: Standard_S15 - name: StandardS20 value: Standard_S20 - name: StandardS30 value: Standard_S30 - name: StandardS40 value: Standard_S40 - name: StandardS50 value: Standard_S50 - name: StandardS60 value: Standard_S60 - name: StandardS70 value: Standard_S70 - name: StandardS80 value: Standard_S80 - name: PremiumP4 value: Premium_P4 - name: PremiumP6 value: Premium_P6 - name: PremiumP10 value: Premium_P10 - name: PremiumP15 value: Premium_P15 - name: PremiumP20 value: Premium_P20 - name: PremiumP30 value: Premium_P30 - name: PremiumP40 value: Premium_P40 - name: PremiumP50 value: Premium_P50 - name: PremiumP60 value: Premium_P60 - name: PremiumP70 value: Premium_P70 - name: PremiumP80 value: Premium_P80 - name: StandardSSDE10 value: StandardSSD_E10 - name: StandardSSDE15 value: StandardSSD_E15 - name: StandardSSDE20 value: StandardSSD_E20 - name: StandardSSDE30 value: StandardSSD_E30 - name: StandardSSDE40 value: StandardSSD_E40 - name: StandardSSDE50 value: StandardSSD_E50 - name: StandardSSDE60 value: StandardSSD_E60 - name: StandardSSDE70 value: StandardSSD_E70 - name: StandardSSDE80 value: StandardSSD_E80 - name: StandardSSDE4 value: StandardSSD_E4 - name: StandardSSDE6 value: StandardSSD_E6 - name: StandardSSDE1 value: StandardSSD_E1 - name: StandardSSDE2 value: StandardSSD_E2 - name: StandardSSDE3 value: StandardSSD_E3 - name: PremiumP1 value: Premium_P1 - name: PremiumP2 value: Premium_P2 - name: PremiumP3 value: Premium_P3 - name: Ultra value: Ultra - name: PremiumV2 value: PremiumV2 SharedResourcesDTO: type: object description: Shared Resources. properties: sharedDataDisks: type: array description: Gets the list of shared data disks. items: $ref: '#/definitions/AzureManagedDiskSkuDTO' readOnly: true x-ms-identifiers: [] sharedLogDisks: type: array description: Gets the list of shared log disks. items: $ref: '#/definitions/AzureManagedDiskSkuDTO' readOnly: true x-ms-identifiers: [] sharedTempDbDisks: type: array description: Gets the list of shared Temporary database disks. items: $ref: '#/definitions/AzureManagedDiskSkuDTO' readOnly: true x-ms-identifiers: [] numberOfMounts: type: integer format: int32 description: Gets number of mounts of shared disks. readOnly: true quorumWitness: $ref: '#/definitions/AzureQuorumWitnessDTO' description: Gets quorum witness. readOnly: true x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'