swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector AvsAssessmentsOperations API schemes: - https tags: - name: AvsAssessmentsOperations paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments : get: operationId: microsoftAzureAvsassessmentsoperationsListbygroup tags: - AvsAssessmentsOperations description: List AvsAssessment resources by Group 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}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/AvsAssessmentListResult' 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: AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen: $ref: ./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName} : get: operationId: microsoftAzureAvsassessmentsoperationsGet tags: - AvsAssessmentsOperations description: Get a AvsAssessment 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: AVS Assessment ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/AvsAssessment' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: AvsAssessmentsOperations_Get_MaximumSet_Gen: $ref: ./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments Assessmentname put: operationId: microsoftAzureAvsassessmentsoperationsCreate tags: - AvsAssessmentsOperations description: Create a AvsAssessment 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: AVS Assessment ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/AvsAssessment' responses: '200': description: Resource 'AvsAssessment' update operation succeeded schema: $ref: '#/definitions/AvsAssessment' '201': description: Resource 'AvsAssessment' create operation succeeded schema: $ref: '#/definitions/AvsAssessment' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true x-ms-examples: AvsAssessmentsOperations_Create_MaximumSet_Gen: $ref: ./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments Assessmentname delete: operationId: microsoftAzureAvsassessmentsoperationsDelete tags: - AvsAssessmentsOperations description: Delete a AvsAssessment 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: AVS Assessment ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: Resource deleted successfully. '204': description: Resource deleted successfully. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: AvsAssessmentsOperations_Delete_MaximumSet_Gen: $ref: ./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments Assessmentname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl : post: operationId: microsoftAzureAvsassessmentsoperationsDownloadurl tags: - AvsAssessmentsOperations summary: Microsoft Azure Get Download Url For The Assessment Report description: Get the URL for downloading the assessment in a report format. 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: AVS Assessment ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: body in: body description: The content of the action request required: true schema: type: object responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/DownloadUrl' '202': description: Resource operation accepted. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true x-ms-examples: AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen: $ref: ./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json definitions: AvsAssessmentProperties: type: object description: Properties of the AVS assessment. properties: assessmentErrorSummary: type: object description: "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment." additionalProperties: format: int32 type: integer readOnly: true failuresToTolerateAndRaidLevel: $ref: '#/definitions/FttAndRaidLevel' description: Failures to tolerate and RAID level in a common property. vcpuOversubscription: type: number format: float description: VCPU over subscription. nodeType: $ref: '#/definitions/AzureAvsNodeType' description: AVS node type. reservedInstance: $ref: '#/definitions/AzureReservedInstance' description: Reserved instance. totalMonthlyCost: type: number format: float description: Total monthly cost. readOnly: true suitability: $ref: '#/definitions/CloudSuitability' description: Gets or sets the Assessment cloud suitability. readOnly: true suitabilityExplanation: $ref: '#/definitions/AzureAvsSuitabilityExplanation' description: Gets or sets the Assessment suitability explanation. readOnly: true numberOfNodes: type: integer format: int32 description: Recommended number of nodes. readOnly: true cpuUtilization: type: number format: float description: Predicted CPU utilization. readOnly: true ramUtilization: type: number format: float description: Predicted RAM utilization. readOnly: true storageUtilization: type: number format: float description: Predicted storage utilization. readOnly: true totalCpuCores: type: number format: float description: Predicted total CPU cores used. readOnly: true totalRamInGB: type: number format: float description: Predicted total RAM used in GB. readOnly: true totalStorageInGB: type: number format: float description: Predicted total Storage used in GB. readOnly: true numberOfMachines: type: integer format: int32 description: Number of machines part of the assessment. readOnly: true suitabilitySummary: type: object description: Cloud suitability summary for all the machines in the assessment. additionalProperties: format: int32 type: integer readOnly: true memOvercommit: type: number format: float description: Memory overcommit. dedupeCompression: type: number format: float description: De-duplication compression. limitingFactor: type: string description: Limiting factor. readOnly: true isStretchClusterEnabled: type: boolean description: Is Stretch Cluster Enabled. groupType: $ref: '#/definitions/GroupType' description: Gets the group type for the assessment. readOnly: true assessmentType: $ref: '#/definitions/AssessmentType' description: Assessment type of the assessment. readOnly: true azureLocation: $ref: '#/definitions/AzureLocation' description: Azure Location or Azure region where to which the machines will be migrated. azureOfferCode: $ref: '#/definitions/AzureOfferCode' description: Azure Offer code according to which cost estimation is done. currency: $ref: '#/definitions/AzureCurrency' description: Currency in which prices should be reported. scalingFactor: type: number format: float description: 'Percentage of buffer that user wants on performance metrics when recommending Azure sizes.' percentile: $ref: '#/definitions/Percentile' description: 'Percentile of the utilization data values to be considered while assessing machines.' timeRange: $ref: '#/definitions/TimeRange' description: 'Time Range for which the historic utilization data should be considered for assessment.' perfDataStartTime: type: string format: date-time description: Gets or sets the start time to consider performance data for assessment. perfDataEndTime: type: string format: date-time description: Gets or sets the end time to consider performance data for assessment. stage: $ref: '#/definitions/AssessmentStage' description: User configurable setting to display the Stage of Assessment. readOnly: true discountPercentage: type: number format: float description: Custom discount percentage. sizingCriterion: $ref: '#/definitions/AssessmentSizingCriterion' description: Assessment sizing criterion. confidenceRatingInPercentage: type: number format: float description: Confidence Rating in Percentage. readOnly: true pricesTimestamp: type: string format: date-time description: 'Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.' readOnly: true createdTimestamp: type: string format: date-time description: Date and Time when assessment was created. readOnly: true updatedTimestamp: type: string format: date-time description: Date and Time when assessment was last updated. readOnly: true status: $ref: '#/definitions/AssessmentStatus' description: Whether assessment is in valid state and all machines have been assessed. readOnly: true schemaVersion: type: string description: Schema version. readOnly: true allOf: - $ref: '#/definitions/AzureResourceProperties' AzureAvsNodeType: type: string enum: - Unknown - AV36 x-ms-enum: name: AzureAvsNodeType modelAsString: true TimeRange: type: string description: Time Range for Performance Data. enum: - Day - Week - Month - Custom x-ms-enum: name: TimeRange modelAsString: true values: - name: Day value: Day description: Daily. - name: Week value: Week description: Weekly. - name: Month value: Month description: Monthly. - name: Custom value: Custom description: Custom Time Range. AzureAvsSuitabilityExplanation: type: string enum: - Unknown - NotApplicable - UnsupportedLocationForSelectedNode x-ms-enum: name: AzureAvsSuitabilityExplanation modelAsString: true AzureLocation: type: string description: Location for Azure. enum: - Unknown - EastAsia - SoutheastAsia - AustraliaEast - AustraliaSoutheast - BrazilSouth - CanadaCentral - CanadaEast - WestEurope - NorthEurope - CentralIndia - SouthIndia - WestIndia - JapanEast - JapanWest - KoreaCentral - KoreaSouth - UkWest - UkSouth - NorthCentralUs - EastUs - WestUs2 - SouthCentralUs - CentralUs - EastUs2 - WestUs - WestCentralUs - GermanyCentral - GermanyNortheast - ChinaNorth - ChinaEast - USGovArizona - USGovTexas - USGovIowa - USGovVirginia - USDoDCentral - USDoDEast - FranceCentral - AustraliaCentral - SouthAfricaNorth - FranceSouth - AustraliaCentral2 - SouthAfricaWest - GermanyNorth - GermanyWestCentral - NorwayEast - NorwayWest - ChinaEast2 - ChinaNorth2 - SwitzerlandNorth - SwitzerlandWest - UAENorth - UAECentral - UsNatEast - UsNatWest - UsSecEast - UsSecCentral - UsSecWest - SwedenCentral - QatarCentral x-ms-enum: name: AzureLocation modelAsString: true FttAndRaidLevel: type: string description: FTT and RAID Level. enum: - Unknown - Ftt1Raid1 - Ftt1Raid5 - Ftt2Raid1 - Ftt2Raid6 - Ftt3Raid1 x-ms-enum: name: FttAndRaidLevel modelAsString: true values: - name: Unknown value: Unknown description: Unknown FTT and RAID Level. - name: Ftt1Raid1 value: Ftt1Raid1 description: FTT 1 and RAID Level 1. - name: Ftt1Raid5 value: Ftt1Raid5 description: FTT 1 and RAID Level 5. - name: Ftt2Raid1 value: Ftt2Raid1 description: FTT 2 and RAID Level 1. - name: Ftt2Raid6 value: Ftt2Raid6 description: FTT 2 and RAID Level 6. - name: Ftt3Raid1 value: Ftt3Raid1 description: FTT 3 and RAID Level 1. GroupType: type: string enum: - Default - Import x-ms-enum: name: GroupType modelAsString: true 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. AzureResourceProperties: type: object description: Common properties for all azure tracked and proxy resources. properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. AzureCurrency: type: string description: Currency for Azure. enum: - Unknown - USD - DKK - CAD - IDR - JPY - KRW - NZD - NOK - RUB - SAR - ZAR - SEK - TRY - GBP - MXN - MYR - INR - HKD - BRL - TWD - EUR - CHF - ARS - AUD - CNY x-ms-enum: name: AzureCurrency modelAsString: true AssessmentType: type: string enum: - Unknown - MachineAssessment - AvsAssessment - SqlAssessment - WebAppAssessment x-ms-enum: name: AssessmentType modelAsString: true AvsAssessment: type: object description: AVS assessment resource. properties: properties: $ref: '#/definitions/AvsAssessmentProperties' 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 AvsAssessmentListResult: type: object description: The response of a AvsAssessment list operation. properties: value: type: array description: The AvsAssessment items on this page items: $ref: '#/definitions/AvsAssessment' nextLink: type: string format: uri description: The link to the next page of items required: - value DownloadUrl: type: object description: Data model of Download URL for assessment report. properties: assessmentReportUrl: type: string description: Hyperlink to download report. readOnly: true expirationTime: type: string format: date-time description: Expiry date of download url. readOnly: true required: - assessmentReportUrl - expirationTime AzureOfferCode: type: string enum: - Unknown - MSAZR0003P - MSAZR0044P - MSAZR0059P - MSAZR0060P - MSAZR0062P - MSAZR0063P - MSAZR0064P - MSAZR0029P - MSAZR0022P - MSAZR0023P - MSAZR0148P - MSAZR0025P - MSAZR0036P - MSAZR0120P - MSAZR0121P - MSAZR0122P - MSAZR0123P - MSAZR0124P - MSAZR0125P - MSAZR0126P - MSAZR0127P - MSAZR0128P - MSAZR0129P - MSAZR0130P - MSAZR0111P - MSAZR0144P - MSAZR0149P - MSMCAZR0044P - MSMCAZR0059P - MSMCAZR0060P - MSMCAZR0063P - MSMCAZR0120P - MSMCAZR0121P - MSMCAZR0125P - MSMCAZR0128P - MSAZRDE0003P - MSAZRDE0044P - MSAZRUSGOV0003P - EA - MSAZR0243P - SavingsPlan1Year - SavingsPlan3Year x-ms-enum: name: AzureOfferCode modelAsString: true values: - name: Unknown value: Unknown - name: Msazr0003P value: MSAZR0003P - name: Msazr0044P value: MSAZR0044P - name: Msazr0059P value: MSAZR0059P - name: Msazr0060P value: MSAZR0060P - name: Msazr0062P value: MSAZR0062P - name: Msazr0063P value: MSAZR0063P - name: Msazr0064P value: MSAZR0064P - name: Msazr0029P value: MSAZR0029P - name: Msazr0022P value: MSAZR0022P - name: Msazr0023P value: MSAZR0023P - name: Msazr0148P value: MSAZR0148P - name: Msazr0025P value: MSAZR0025P - name: Msazr0036P value: MSAZR0036P - name: Msazr0120P value: MSAZR0120P - name: Msazr0121P value: MSAZR0121P - name: Msazr0122P value: MSAZR0122P - name: Msazr0123P value: MSAZR0123P - name: Msazr0124P value: MSAZR0124P - name: Msazr0125P value: MSAZR0125P - name: Msazr0126P value: MSAZR0126P - name: Msazr0127P value: MSAZR0127P - name: Msazr0128P value: MSAZR0128P - name: Msazr0129P value: MSAZR0129P - name: Msazr0130P value: MSAZR0130P - name: Msazr0111P value: MSAZR0111P - name: Msazr0144P value: MSAZR0144P - name: Msazr0149P value: MSAZR0149P - name: Msmcazr0044P value: MSMCAZR0044P - name: Msmcazr0059P value: MSMCAZR0059P - name: Msmcazr0060P value: MSMCAZR0060P - name: Msmcazr0063P value: MSMCAZR0063P - name: Msmcazr0120P value: MSMCAZR0120P - name: Msmcazr0121P value: MSMCAZR0121P - name: Msmcazr0125P value: MSMCAZR0125P - name: Msmcazr0128P value: MSMCAZR0128P - name: Msazrde0003P value: MSAZRDE0003P - name: Msazrde0044P value: MSAZRDE0044P - name: Msazrusgov0003P value: MSAZRUSGOV0003P - name: EA value: EA - name: Msazr0243P value: MSAZR0243P - name: SavingsPlan1Year value: SavingsPlan1Year - name: SavingsPlan3Year value: SavingsPlan3Year AzureReservedInstance: type: string enum: - None - RI1Year - RI3Year x-ms-enum: name: AzureReservedInstance modelAsString: true Percentile: type: string description: Percentile for Performance Data. enum: - Percentile50 - Percentile90 - Percentile95 - Percentile99 x-ms-enum: name: Percentile modelAsString: true values: - name: Percentile50 value: Percentile50 description: Percentile 50. - name: Percentile90 value: Percentile90 description: Percentile 90. - name: Percentile95 value: Percentile95 description: Percentile 95. - name: Percentile99 value: Percentile99 description: Percentile 99. AssessmentStatus: type: string description: Assessment Status. enum: - Created - Updated - Running - Completed - Invalid - OutOfSync - OutDated - Deleted x-ms-enum: name: AssessmentStatus modelAsString: true values: - name: Created value: Created description: Assessment is Created. - name: Updated value: Updated description: Assessment is Updated. - name: Running value: Running description: Assessment is currently running. - name: Completed value: Completed description: Assessment is Completed or Ready. - name: Invalid value: Invalid description: Assessment is Failed i.e. it is now invalid. - name: OutOfSync value: OutOfSync description: Assessment is Out of Sync. - name: OutDated value: OutDated description: Assessment is Out Dated. - name: Deleted value: Deleted description: Assessment is Deleted. AssessmentStage: type: string enum: - InProgress - UnderReview - Approved x-ms-enum: name: AssessmentStage modelAsString: true ProvisioningState: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: Resource is being Provisioned. - name: Updating value: Updating description: Resource is being Updated. - name: Deleting value: Deleting description: Resource is being Deleted. - name: Accepted value: Accepted description: Resource is being Accepted. 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. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'