swagger: '2.0'
info:
version: 2017-11-11-preview
title: Microsoft Azure Azure Migrate
description: Move your workloads to Azure.
contact:
name: Microsoft
email: azuremigrate@microsoft.com
host: management.azure.com
schemes:
- https
produces:
- application/json
consumes:
- application/json
parameters:
subscriptionId:
name: subscriptionId
description: Azure Subscription Id in which project was created.
type: string
in: path
required: true
resourceGroupName:
name: resourceGroupName
description: Name of the Azure Resource Group that project is part of.
type: string
in: path
x-ms-parameter-location: method
required: true
projectName:
name: projectName
description: Name of the Azure Migrate project.
type: string
in: path
x-ms-parameter-location: method
required: true
machineName:
name: machineName
description: Unique name of a machine in private datacenter.
type: string
in: path
x-ms-parameter-location: method
required: true
assessedMachineName:
name: assessedMachineName
description: Unique name of an assessed machine evaluated as part of an assessment.
type: string
in: path
x-ms-parameter-location: method
required: true
groupName:
name: groupName
description: Unique name of a group within a project.
type: string
in: path
x-ms-parameter-location: method
required: true
assessmentName:
name: assessmentName
description: Unique name of an assessment within a project.
type: string
in: path
x-ms-parameter-location: method
required: true
api-version:
name: api-version
description: >-
Standard request header. Used by service to identify API version used by
client.
type: string
in: query
required: true
enum:
- 2017-11-11-preview
acceptLanguage:
description: >-
Standard request header. Used by service to respond to client in
appropriate language.
name: Accept-Language
type: string
in: header
x-ms-parameter-location: client
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
security:
- azure_auth:
- user_impersonation
definitions:
Project:
type: object
x-ms-azure-resource: true
description: Azure Migrate Project.
properties:
id:
type: string
description: >-
Path reference to this project
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}
readOnly: true
name:
type: string
description: Name of the project.
readOnly: true
type:
type: string
description: Type of the object = [Microsoft.Migrate/projects].
readOnly: true
eTag:
type: string
description: For optimistic concurrency control.
location:
type: string
description: Azure location in which project is created.
tags:
type: object
description: Tags provided by Azure Tagging service.
properties:
description: Properties of the project.
x-ms-client-flatten: true
$ref: '#/definitions/ProjectProperties'
ProjectProperties:
type: object
description: Properties of a project.
properties:
numberOfMachines:
type: integer
format: int32
description: Number of machines in the project.
readOnly: true
numberOfGroups:
type: integer
format: int32
description: Number of groups created in the project.
readOnly: true
numberOfAssessments:
type: integer
format: int32
description: Number of assessments created in the project.
readOnly: true
createdTimestamp:
type: string
format: date-time
description: >-
Time when this project was created. Date-Time represented in ISO-8601
format.
readOnly: true
updatedTimestamp:
type: string
format: date-time
description: >-
Time when this project was last updated. Date-Time represented in
ISO-8601 format.
readOnly: true
discoveryStatus:
type: string
enum:
- Unknown
- NotStarted
- InProgress
- Completed
readOnly: true
description: Reports whether project is under discovery.
x-ms-enum:
name: DiscoveryStatus
modelAsString: true
customerWorkspaceId:
type: string
description: ARM ID of the Service Map workspace created by user.
provisioningState:
type: string
enum:
- Accepted
- Creating
- Deleting
- Failed
- Moving
- Succeeded
description: Provisioning state of the project.
x-ms-enum:
name: ProvisioningState
modelAsString: true
Group:
type: object
x-ms-azure-resource: true
description: A group created in a Migration project.
required:
- properties
properties:
id:
description: >-
Path reference to this group.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}
type: string
readOnly: true
name:
description: Name of the group.
type: string
readOnly: true
eTag:
type: string
description: For optimistic concurrency control.
type:
type: string
description: Type of the object = [Microsoft.Migrate/projects/groups].
readOnly: true
properties:
description: Properties of the group.
x-ms-client-flatten: true
$ref: '#/definitions/GroupProperties'
GroupProperties:
type: object
description: Properties of group resource.
required:
- machines
properties:
machines:
type: array
description: List of machine names that are part of this group.
items:
type: string
description: >-
Reference to a machine.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName}
assessments:
type: array
description: List of References to Assessments created on this group.
readOnly: true
items:
type: string
description: >-
Reference to an Assessment.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}
readOnly: true
createdTimestamp:
type: string
format: date-time
description: >-
Time when this project was created. Date-Time represented in ISO-8601
format.
readOnly: true
updatedTimestamp:
type: string
format: date-time
description: >-
Time when this project was last updated. Date-Time represented in
ISO-8601 format.
readOnly: true
Assessment:
type: object
x-ms-azure-resource: true
description: An assessment created for a group in the Migration project.
required:
- properties
properties:
id:
type: string
description: >-
Path reference to this assessment.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessment/{assessmentName}
readOnly: true
name:
type: string
description: Unique name of an assessment.
readOnly: true
eTag:
type: string
description: For optimistic concurrency control.
type:
type: string
description: Type of the object = [Microsoft.Migrate/projects/groups/assessments].
readOnly: true
properties:
description: Properties of the assessment.
x-ms-client-flatten: true
$ref: '#/definitions/AssessmentProperties'
AssessmentProperties:
type: object
description: Properties of an assessment.
required:
- stage
- azureOfferCode
- timeRange
- percentile
- azureLocation
- azureStorageRedundancy
- scalingFactor
- azurePricingTier
- currency
- azureHybridUseBenefit
- discountPercentage
properties:
azureLocation:
type: string
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
description: >-
Target Azure location for which the machines should be assessed. These
enums are the same as used by Compute API.
x-ms-enum:
name: AzureLocation
modelAsString: true
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
description: Offer code according to which cost estimation is done.
x-ms-enum:
name: AzureOfferCode
modelAsString: true
azurePricingTier:
type: string
enum:
- Standard
- Basic
description: Pricing tier for Size evaluation.
x-ms-enum:
name: AzurePricingTier
modelAsString: true
azureStorageRedundancy:
type: string
enum:
- Unknown
- LocallyRedundant
- ZoneRedundant
- GeoRedundant
- ReadAccessGeoRedundant
description: Storage Redundancy type offered by Azure.
x-ms-enum:
name: AzureStorageRedundancy
modelAsString: true
scalingFactor:
type: number
format: double
description: >-
Scaling factor used over utilization data to add a performance buffer
for new machines to be created in Azure. Min Value = 1.0, Max value =
1.9, Default = 1.3.
percentile:
type: string
enum:
- Percentile50
- Percentile90
- Percentile95
- Percentile99
description: Percentile of performance data used to recommend Azure size.
x-ms-enum:
name: Percentile
modelAsString: true
timeRange:
type: string
enum:
- Day
- Week
- Month
description: Time range of performance data used to recommend a size.
x-ms-enum:
name: TimeRange
modelAsString: true
stage:
type: string
enum:
- InProgress
- UnderReview
- Approved
description: User configurable setting that describes the status of the assessment.
x-ms-enum:
name: AssessmentStage
modelAsString: true
currency:
type: string
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
description: Currency to report prices in.
x-ms-enum:
name: Currency
modelAsString: true
azureHybridUseBenefit:
type: string
enum:
- Unknown
- 'Yes'
- 'No'
description: AHUB discount on windows virtual machines.
x-ms-enum:
name: AzureHybridUseBenefit
modelAsString: true
discountPercentage:
type: number
format: double
description: >-
Custom discount percentage to be applied on final costs. Can be in the
range [0, 100].
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: >-
Time when this project was created. Date-Time represented in ISO-8601
format.
readOnly: true
updatedTimestamp:
type: string
format: date-time
description: >-
Time when this project was last updated. Date-Time represented in
ISO-8601 format.
readOnly: true
monthlyComputeCost:
type: number
format: double
description: >-
Monthly compute cost estimate for the machines that are part of this
assessment as a group, for a 31-day month.
readOnly: true
monthlyBandwidthCost:
type: number
format: double
description: >-
Monthly network cost estimate for the machines that are part of this
assessment as a group, for a 31-day month.
readOnly: true
monthlyStorageCost:
type: number
format: double
description: >-
Monthly storage cost estimate for the machines that are part of this
assessment as a group, for a 31-day month.
readOnly: true
status:
type: string
enum:
- Created
- Updated
- Running
- Completed
- Invalid
description: Whether the assessment has been created and is valid.
readOnly: true
x-ms-enum:
name: AssessmentStatus
modelAsString: true
numberOfMachines:
type: integer
format: int32
description: Number of assessed machines part of this assessment.
readOnly: true
Disk:
type: object
description: A disk discovered on a machine.
properties:
gigabytesAllocated:
type: number
format: double
description: Gigabytes of storage provisioned for this disk.
readOnly: true
gigabytesConsumed:
format: double
type: number
description: Gigabytes of storage consumed by this disk.
readOnly: true
NetworkAdapter:
type: object
description: A network adapter discovered on a machine.
properties:
macAddress:
type: string
description: MAC Address of the network adapter.
readOnly: true
ipAddresses:
type: array
description: List of IP Addresses on the network adapter.
readOnly: true
items:
type: string
description: IP Address of the network adapter.
readOnly: true
Machine:
type: object
x-ms-azure-resource: true
description: A machine in a migration project.
properties:
id:
type: string
description: >-
Path reference to this machine.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName}
readOnly: true
name:
type: string
description: >-
Name of the machine. It is a GUID which is unique identifier of
machine in private data center. For user-readable name, we have a
displayName property on this machine.
readOnly: true
eTag:
type: string
description: For optimistic concurrency control.
type:
type: string
description: Type of the object = [Microsoft.Migrate/projects/machines].
readOnly: true
properties:
description: Properties of the machine.
x-ms-client-flatten: true
$ref: '#/definitions/MachineProperties'
MachineProperties:
type: object
description: Properties of a machine.
properties:
bootType:
type: string
description: Boot type of the machine.
enum:
- Unknown
- EFI
- BIOS
readOnly: true
x-ms-enum:
name: MachineBootType
modelAsString: true
datacenterContainer:
type: string
description: >-
Container defined in the management solution that this machine is part
of in the datacenter.
readOnly: true
datacenterManagementServer:
type: string
description: Name of the server hosting the datacenter management solution.
readOnly: true
datacenterMachineId:
type: string
description: ID of the machine as tracked by the datacenter management solution.
readOnly: true
datacenterManagementServerId:
type: string
description: ID of the server hosting the datacenter management solution.
readOnly: true
description:
type: string
description: Description of the machine
readOnly: true
displayName:
type: string
description: >-
User readable name of the machine as defined by the user in their
private datacenter.
readOnly: true
megabytesOfMemory:
type: number
description: Memory in Megabytes.
readOnly: true
numberOfCores:
type: integer
description: Processor count.
readOnly: true
operatingSystem:
type: string
description: Operating System of the machine.
readOnly: true
groups:
type: array
description: List of references to the groups that the machine is member of.
readOnly: true
items:
type: string
readOnly: true
description: >-
Reference to a group that this machine is member of.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}
createdTimestamp:
type: string
format: date-time
description: >-
Time when this machine was created. Date-Time represented in ISO-8601
format.
readOnly: true
updatedTimestamp:
type: string
format: date-time
description: >-
Time when this machine was last updated. Date-Time represented in
ISO-8601 format.
readOnly: true
discoveredTimestamp:
type: string
format: date-time
description: >-
Time when this machine was discovered by Azure Migrate agent.
Date-Time represented in ISO-8601 format.
readOnly: true
disks:
type: object
description: >-
Dictionary of disks attached to the machine. Key is ID of disk. Value
is a disk object
readOnly: true
additionalProperties:
$ref: '#/definitions/Disk'
networkAdapters:
type: object
description: >-
Dictionary of network adapters attached to the machine. Key is ID of
network adapter. Value is a network adapter object
readOnly: true
additionalProperties:
$ref: '#/definitions/NetworkAdapter'
AssessedDisk:
type: object
description: A disk assessed for an assessment.
properties:
name:
type: string
description: Name of the assessed disk.
readOnly: true
gigabytesProvisioned:
type: number
format: double
description: Gigabytes of storage provisioned for this disk.
readOnly: true
gigabytesConsumed:
type: number
format: double
description: Gigabytes of storage consumed by this disk.
readOnly: true
megabytesPerSecondOfRead:
type: number
format: double
description: Disk throughput in MegaBytes per second.
readOnly: true
megabytesPerSecondOfWrite:
type: number
format: double
description: Disk throughput in MegaBytes per second.
readOnly: true
numberOfReadOperationsPerSecond:
type: number
format: double
description: Number of read operations per second for the disk.
readOnly: true
numberOfWriteOperationsPerSecond:
type: number
format: double
description: Number of read and write operations per second for the disk.
readOnly: true
monthlyStorageCost:
type: number
format: double
description: Estimated aggregate storage cost for a 31-day month for this disk.
readOnly: true
recommendedDiskType:
type: string
enum:
- Unknown
- Standard
- Premium
description: Storage type selected for this disk.
x-ms-enum:
name: AzureDiskType
modelAsString: true
readOnly: true
recommendedDiskSize:
type: string
enum:
- Unknown
- Standard_S4
- Standard_S6
- Standard_S10
- Standard_S20
- Standard_S30
- Standard_S40
- Standard_S50
- Premium_P4
- Premium_P6
- Premium_P10
- Premium_P20
- Premium_P30
- Premium_P40
- Premium_P50
description: >-
Recommended Azure size for the disk, given utilization data and
preferences set on Assessment.
readOnly: true
x-ms-enum:
name: AzureDiskSize
modelAsString: true
gigabytesForRecommendedDiskSize:
type: integer
format: int32
description: Gigabytes of storage provided by the recommended Azure disk size.
readOnly: true
suitability:
type: string
enum:
- Unknown
- NotSuitable
- Suitable
- ConditionallySuitable
description: Whether this disk is suitable for Azure.
readOnly: true
x-ms-enum:
name: CloudSuitability
modelAsString: true
suitabilityExplanation:
type: string
enum:
- Unknown
- NotApplicable
- DiskSizeGreaterThanSupported
- NoSuitableDiskSizeForIops
- NoSuitableDiskSizeForThroughput
- NoDiskSizeFoundInSelectedLocation
- NoDiskSizeFoundForSelectedRedundancy
- InternalErrorOccurredForDiskEvaluation
description: If disk is suitable, this explains the reasons and mitigation steps.
readOnly: true
x-ms-enum:
name: AzureDiskSuitabilityExplanation
modelAsString: true
AssessedNetworkAdapter:
type: object
description: A network adapter assessed for an assessment.
properties:
macAddress:
type: string
description: MAC Address of the network adapter.
readOnly: true
ipAddresses:
type: array
description: List of IP Addresses on the network adapter.
readOnly: true
items:
type: string
description: IP Address of the network adapter.
readOnly: true
monthlyBandwidthCosts:
type: number
format: double
description: >-
Monthly cost estimate for network bandwidth used by this network
adapter.
readOnly: true
megabytesPerSecondTransmitted:
type: number
format: double
description: Adapter throughput for outgoing traffic in MegaBytes per second.
readOnly: true
megabytesPerSecondReceived:
type: number
format: double
description: Adapter throughput for incoming traffic in MegaBytes per second.
readOnly: true
netGigabytesTransmittedPerMonth:
type: number
format: double
description: Gigabytes transmitted through this adapter each month.
suitability:
type: string
enum:
- Unknown
- NotSuitable
- Suitable
- ConditionallySuitable
description: Whether this adapter is suitable for Azure.
readOnly: true
x-ms-enum:
name: CloudSuitability
modelAsString: true
suitabilityExplanation:
type: string
enum:
- Unknown
- NotApplicable
- InternalErrorOccured
description: >-
If network adapter is suitable, this explains the reasons and
mitigation steps.
readOnly: true
x-ms-enum:
name: AzureNetworkAdapterSuitabilityExplanation
modelAsString: true
AssessedMachine:
type: object
x-ms-azure-resource: true
description: A machine evaluated as part of an assessment.
properties:
id:
type: string
description: >-
Path reference to this assessed machine.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}
readOnly: true
name:
type: string
description: Name of the machine.
readOnly: true
eTag:
type: string
description: For optimistic concurrency control.
type:
type: string
description: >-
Type of the object =
[Microsoft.Migrate/projects/groups/assessments/assessedMachines].
readOnly: true
properties:
description: Properties of an assessed machine.
x-ms-client-flatten: true
$ref: '#/definitions/AssessedMachineProperties'
AssessedMachineProperties:
type: object
description: Properties of an assessed machine.
properties:
groups:
type: array
description: List of references to the groups that the machine is member of.
readOnly: true
items:
type: string
readOnly: true
description: >-
Reference to a group that this machine is member of.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}
discoveredTimestamp:
type: string
format: date-time
description: >-
Time when this machine was discovered by Azure Migrate agent.
Date-Time represented in ISO-8601 format.
readOnly: true
bootType:
type: string
description: Boot type of the machine.
enum:
- Unknown
- EFI
- BIOS
readOnly: true
x-ms-enum:
name: MachineBootType
modelAsString: true
datacenterContainer:
type: string
description: >-
Container defined in the management solution that this machine is part
of in the datacenter.
readOnly: true
datacenterManagementServer:
type: string
description: Name of the server hosting the datacenter management solution.
readOnly: true
datacenterMachineId:
type: string
description: ID of the machine as tracked by the datacenter management solution.
readOnly: true
datacenterManagementServerId:
type: string
description: ID of the server hosting the datacenter management solution.
readOnly: true
description:
type: string
description: Description of the machine
readOnly: true
displayName:
type: string
description: >-
User readable name of the machine as defined by the user in their
private datacenter.
readOnly: true
megabytesOfMemory:
type: number
format: double
description: Memory in Megabytes.
readOnly: true
numberOfCores:
type: integer
format: int32
description: Processor count.
readOnly: true
operatingSystem:
type: string
description: Operating System of the machine.
readOnly: true
monthlyBandwidthCost:
type: number
format: double
description: >-
Monthly network cost estimate for the network adapters that are
attached to this machine as a group, for a 31-day month.
readOnly: true
monthlyStorageCost:
type: number
format: double
description: >-
Monthly storage cost estimate for the disks that are attached to this
machine as a group, for a 31-day month.
readOnly: true
disks:
type: object
description: >-
Dictionary of disks attached to the machine. Key is ID of disk. Value
is a disk object.
readOnly: true
additionalProperties:
$ref: '#/definitions/AssessedDisk'
networkAdapters:
type: object
description: >-
Dictionary of network adapters attached to the machine. Key is name of
the adapter. Value is a network adapter object.
readOnly: true
additionalProperties:
$ref: '#/definitions/AssessedNetworkAdapter'
recommendedSize:
type: string
enum:
- Unknown
- Basic_A0
- Basic_A1
- Basic_A2
- Basic_A3
- Basic_A4
- Standard_A0
- Standard_A1
- Standard_A2
- Standard_A3
- Standard_A4
- Standard_A5
- Standard_A6
- Standard_A7
- Standard_A8
- Standard_A9
- Standard_A10
- Standard_A11
- Standard_A1_v2
- Standard_A2_v2
- Standard_A4_v2
- Standard_A8_v2
- Standard_A2m_v2
- Standard_A4m_v2
- Standard_A8m_v2
- Standard_D1
- Standard_D2
- Standard_D3
- Standard_D4
- Standard_D11
- Standard_D12
- Standard_D13
- Standard_D14
- Standard_D1_v2
- Standard_D2_v2
- Standard_D3_v2
- Standard_D4_v2
- Standard_D5_v2
- Standard_D11_v2
- Standard_D12_v2
- Standard_D13_v2
- Standard_D14_v2
- Standard_D15_v2
- Standard_DS1
- Standard_DS2
- Standard_DS3
- Standard_DS4
- Standard_DS11
- Standard_DS12
- Standard_DS13
- Standard_DS14
- Standard_DS1_v2
- Standard_DS2_v2
- Standard_DS3_v2
- Standard_DS4_v2
- Standard_DS5_v2
- Standard_DS11_v2
- Standard_DS12_v2
- Standard_DS13_v2
- Standard_DS14_v2
- Standard_DS15_v2
- Standard_F1
- Standard_F2
- Standard_F4
- Standard_F8
- Standard_F16
- Standard_F1s
- Standard_F2s
- Standard_F4s
- Standard_F8s
- Standard_F16s
- Standard_G1
- Standard_G2
- Standard_G3
- Standard_G4
- Standard_G5
- Standard_GS1
- Standard_GS2
- Standard_GS3
- Standard_GS4
- Standard_GS5
- Standard_H8
- Standard_H16
- Standard_H8m
- Standard_H16m
- Standard_H16r
- Standard_H16mr
- Standard_L4s
- Standard_L8s
- Standard_L16s
- Standard_L32s
description: Recommended Azure size for this machine.
readOnly: true
x-ms-enum:
name: AzureVmSize
modelAsString: true
numberOfCoresForRecommendedSize:
type: integer
format: int32
description: Number of CPU cores in the Recommended Azure VM Size.
readOnly: true
megabytesOfMemoryForRecommendedSize:
type: number
format: double
description: Megabytes of memory in the Recommended Azure VM Size.
readOnly: true
monthlyComputeCostForRecommendedSize:
type: number
format: double
description: >-
Compute Cost for a 31-day month, if the machine is migrated to Azure
with the Recommended Size.
readOnly: true
percentageCoresUtilization:
type: number
format: double
description: >-
Utilization percentage of the processor core as observed in the
private data center, in the Time Range selected on Assessment,
reported as the Percentile value based on the percentile number
selected in assessment.
readOnly: true
percentageMemoryUtilization:
type: number
format: double
description: >-
Utilization percentage of the memory as observed in the private data
center, in the Time Range selected on Assessment, reported as the
Percentile value based on the percentile number selected in
assessment.
readOnly: true
suitability:
type: string
enum:
- Unknown
- NotSuitable
- Suitable
- ConditionallySuitable
description: Whether machine is suitable for migration to Azure.
readOnly: true
x-ms-enum:
name: CloudSuitability
modelAsString: true
suitabilityExplanation:
type: string
enum:
- Unknown
- NotApplicable
- GuestOperatingSystemArchitectureNotSupported
- GuestOperatingSystemNotSupported
- BootTypeNotSupported
- MoreDisksThanSupported
- NoSuitableVmSizeFound
- OneOrMoreDisksNotSuitable
- OneOrMoreAdaptersNotSuitable
- InternalErrorOccuredDuringComputeEvaluation
- InternalErrorOccuredDuringStorageEvaluation
- InternalErrorOccuredDuringNetworkEvaluation
- NoVmSizeSupportsStoragePerformance
- NoVmSizeSupportsNetworkPerformance
- NoVmSizeForSelectedPricingTier
- NoVmSizeForSelectedAzureLocation
- CheckRedHatLinuxVersion
- CheckOpenSuseLinuxVersion
- CheckWindowsServer2008R2Version
- CheckCentOsVersion
- CheckDebianLinuxVersion
- CheckSuseLinuxVersion
- CheckOracleLinuxVersion
- CheckUbuntuLinuxVersion
- CheckCoreOsLinuxVersion
- WindowsServerVersionConditionallySupported
- NoGuestOperatingSystemConditionallySupported
- WindowsClientVersionsConditionallySupported
description: >-
If machine is not ready to be migrated, this explains the reasons and
mitigation steps.
readOnly: true
x-ms-enum:
name: AzureVmSuitabilityExplanation
modelAsString: true
createdTimestamp:
type: string
format: date-time
description: >-
Time when this machine was created. Date-Time represented in ISO-8601
format.
readOnly: true
updatedTimestamp:
type: string
format: date-time
description: >-
Time when this machine was last updated. Date-Time represented in
ISO-8601 format.
readOnly: true
ProjectKey:
type: object
x-ms-azure-resource: true
description: ID and Key for Migration Project.
properties:
workspaceId:
type: string
description: ID of Migration Project.
readOnly: true
workspaceKey:
type: string
description: Key of Migration Project.
readOnly: true
OperationDisplay:
type: object
description: Displayable properties of the operation.
readOnly: true
properties:
provider:
type: string
description: Provider of the operation.
readOnly: true
resource:
type: string
description: Resource operated on by the operation.
readOnly: true
operation:
type: string
description: Operation Type.
readOnly: true
description:
type: string
description: Description of the operation.
readOnly: true
Operation:
type: object
description: A REST API operation supported by the provider.
properties:
name:
type: string
description: Name of the operation.
readOnly: true
display:
description: Displayable properties of the operation.
$ref: '#/definitions/OperationDisplay'
origin:
type: string
description: Origin of the operation.
readOnly: true
DownloadUrl:
type: object
description: 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
ProjectResultList:
type: object
description: List of projects.
properties:
value:
type: array
description: List of projects.
items:
$ref: '#/definitions/Project'
MachineResultList:
type: object
description: List of machines.
properties:
value:
type: array
description: List of machines.
items:
$ref: '#/definitions/Machine'
GroupResultList:
type: object
description: List of groups.
properties:
value:
type: array
description: List of groups.
items:
$ref: '#/definitions/Group'
AssessedMachineResultList:
type: object
description: List of assessed machines.
properties:
value:
description: List of assessed machines.
type: array
items:
$ref: '#/definitions/AssessedMachine'
AssessmentResultList:
type: object
description: List of assessments.
properties:
value:
type: array
description: List of assessments.
items:
$ref: '#/definitions/Assessment'
OperationResultList:
type: object
description: List of API operations.
properties:
value:
type: array
description: List of operations.
items:
$ref: '#/definitions/Operation'
paths:
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects:
get:
summary: 'Microsoft Azure Get All Projects'
description: Get all the projects in the resource group.
operationId: microsoftAzureProjectsList
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
responses:
'200':
description: OK.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/ProjectResultList'
'401':
description: Not authorized (No access to subscription or resource group).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
Projects_List:
$ref: ./examples/Projects_List.json
tags:
- Subscriptions
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}:
get:
summary: 'Microsoft Azure Get The Specified Project'
description: Get the project with the specified name.
operationId: microsoftAzureProjectsGet
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
responses:
'200':
description: OK.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Project'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, projectName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Projects_Get:
$ref: ./examples/Projects_Get.json
tags:
- Subscriptions
put:
summary: 'Microsoft Azure Create Or Update Project'
description: >-
Create a project with specified name. If a project already exists,
update it.
operationId: microsoftAzureProjectsCreate
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
- name: project
description: New or Updated project object.
in: body
schema:
$ref: '#/definitions/Project'
responses:
'200':
description: OK. Existing project updated.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Project'
'201':
description: Created. New project was created.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Project'
'400':
description: >-
Bad Request (Read only settings of an existing project cannot be
changed).
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Projects_Create:
$ref: ./examples/Projects_Create.json
tags:
- Subscriptions
patch:
summary: 'Microsoft Azure Update Project'
description: >-
Update a project with specified name. Supports partial updates, for
example only tags can be provided.
operationId: microsoftAzureProjectsUpdate
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
- name: project
description: Updated project object.
in: body
schema:
$ref: '#/definitions/Project'
responses:
'200':
description: OK. Existing project updated.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Project'
'400':
description: >-
Bad Request (Read only settings of an existing project cannot be
changed).
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, or nestName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Projects_Update:
$ref: ./examples/Projects_Update.json
tags:
- Subscriptions
delete:
summary: Microsoft Azure Delete The Project
description: Delete the project. Deleting non-existent project is a no-operation.
operationId: microsoftAzureProjectsDelete
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
responses:
'200':
description: OK. Deleted the group.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
'204':
description: No content. No project with specified name was found.
'400':
description: Bad request. (Invalid subscriptionId or resourceGroupName).
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project)
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Projects_Delete:
$ref: ./examples/Projects_Delete.json
tags:
- Subscriptions
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/keys:
post:
summary: 'Microsoft Azure Get Shared Keys For The Project'
description: >-
Gets the Log Analytics Workspace ID and Primary Key for the specified
project.
operationId: microsoftAzureProjectsGetkeys
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
responses:
'200':
description: OK.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/ProjectKey'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, projectName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Projects_GetKeys:
$ref: ./examples/Projects_GetKeys.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines
: get:
summary: Microsoft Azure Get All Machines In The Project
description: >-
Get data of all the machines available in the project. Returns a json
array of objects of type 'machine' defined in Models section.
operationId: microsoftAzureMachinesListbyproject
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns list of all machine objects.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/MachineResultList'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, projectName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
Machines_ListByProject:
$ref: ./examples/Machines_ListByProject.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName}
: get:
summary: 'Microsoft Azure Get A Specific Machine'
description: >-
Get the machine with the specified name. Returns a json object of type
'machine' defined in Models section.
operationId: microsoftAzureMachinesGet
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/machineName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns the machine with the specified name.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Machine'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName, projectName,
or machineName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Machines_Get:
$ref: ./examples/Machines_Get.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups
: get:
summary: Microsoft Azure Get All Groups
description: >-
Get all groups created in the project. Returns a json array of objects
of type 'group' as specified in the Models section.
operationId: microsoftAzureGroupsListbyproject
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns list of groups.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/GroupResultList'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, projectName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
Groups_ListByProject:
$ref: ./examples/Groups_ListByProject.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}
: get:
summary: 'Microsoft Azure Get A Specific Group'
description: >-
Get information related to a specific group in the project. Returns a
json object of type 'group' as specified in the models section.
operationId: microsoftAzureGroupsGet
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns the group with the specified name.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Group'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName, projectName,
or groupName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Groups_Get:
$ref: ./examples/Groups_Get.json
tags:
- Subscriptions
put:
summary: >-
Microsoft Azure Create A New Group With Specified Settings If Group With The Name Provided Already Exists, Then The Existing Group Is Updated
description: >-
Create a new group by sending a json object of type 'group' as given in
Models section as part of the Request Body. The group name in a project
is unique. Labels can be applied on a group as part of
creation.
If a group with the groupName specified in the URL
already exists, then this call acts as an update.
This operation
is Idempotent.
operationId: microsoftAzureGroupsCreate
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
- name: group
description: New or Updated Group object.
in: body
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: OK. Existing group updated.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Group'
'201':
description: Created. New group was created.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Group'
'400':
description: >-
Bad Request (Read only settings of an existing group cannot be
changed).
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Groups_Create:
$ref: ./examples/Groups_Create.json
tags:
- Subscriptions
delete:
summary: Microsoft Azure Delete The Group
description: >-
Delete the group from the project. The machines remain in the project.
Deleting a non-existent group results in a no-operation.
A group
is an aggregation mechanism for machines in a project. Therefore,
deleting group does not delete machines in it.
operationId: microsoftAzureGroupsDelete
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Deleted the group.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
'204':
description: No content. No group with specified name was found.
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project)
'404':
description: Not found (Invalid subscriptionId, resourceGroupName)
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Groups_Delete:
$ref: ./examples/Groups_Delete.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments
: get:
summary: 'Microsoft Azure Get All Assessments Created For The Specified Group'
description: >-
Get all assessments created for the specified group.
Returns a
json array of objects of type 'assessment' as specified in Models
section.
operationId: microsoftAzureAssessmentsListbygroup
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns list of Assessment objects.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/AssessmentResultList'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName,
assessmentName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
Assessments_ListByGroup:
$ref: ./examples/Assessments_ListByGroup.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/assessments
: get:
summary: 'Microsoft Azure Get All Assessments Created In The Project'
description: >-
Get all assessments created in the project.
Returns a json array
of objects of type 'assessment' as specified in Models section.
operationId: microsoftAzureAssessmentsListbyproject
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns list of Assessment objects.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/AssessmentResultList'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName,
assessmentName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
Assessments_ListByProject:
$ref: ./examples/Assessments_ListByProject.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}
: get:
summary: 'Microsoft Azure Get An Assessment'
description: >-
Get an existing assessment with the specified name. Returns a json
object of type 'assessment' as specified in Models section.
operationId: microsoftAzureAssessmentsGet
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns Assessment object.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Assessment'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName, projectName,
or assessmentName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Assessments_Get:
$ref: ./examples/Assessments_Get.json
tags:
- Subscriptions
put:
summary: 'Microsoft Azure Create Or Update Assessment'
description: >-
Create a new assessment with the given name and the specified settings.
Since name of an assessment in a project is a unique identifier, if an
assessment with the name provided already exists, then the existing
assessment is updated.
Any PUT operation, resulting in either
create or update on an assessment, will cause the assessment to go in a
"InProgress" state. This will be indicated by the field
'computationState' on the Assessment object. During this time no other
PUT operation will be allowed on that assessment object, nor will a
Delete operation. Once the computation for the assessment is complete,
the field 'computationState' will be updated to 'Ready', and then other
PUT or DELETE operations can happen on the assessment.
When
assessment is under computation, any PUT will lead to a 400 - Bad
Request error.
operationId: microsoftAzureAssessmentsCreate
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
- name: assessment
description: New or Updated Assessment object.
in: body
schema:
$ref: '#/definitions/Assessment'
responses:
'200':
description: OK. Existing assessment updated.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Assessment'
'201':
description: Created. New assessment was created.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/Assessment'
'400':
description: >-
Bad Request. Assessment is under computation and cannot be updated
yet.
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Assessments_Create:
$ref: ./examples/Assessments_Create.json
tags:
- Subscriptions
delete:
summary: 'Microsoft Azure Deletes An Assessment From The Project'
description: >-
Delete an assessment from the project. The machines remain in the
assessment. Deleting a non-existent assessment results in a
no-operation.
When an assessment is under computation, as
indicated by the 'computationState' field, it cannot be deleted. Any
such attempt will return a 400 - Bad Request.
operationId: microsoftAzureAssessmentsDelete
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Deleted the assessment.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
'204':
description: No content. No assessment with specified name was found.
'400':
description: >-
Bad Request. Assessment is under computation and cannot be deleted
yet.
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project)
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Assessments_Delete:
$ref: ./examples/Assessments_Delete.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl
: post:
summary: 'Microsoft Azure Get Download Url For The Assessment Report'
description: Get the URL for downloading the assessment in a report format.
operationId: microsoftAzureAssessmentsGetreportdownloadurl
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/api-version'
- $ref: '#/parameters/acceptLanguage'
responses:
'200':
description: OK.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/DownloadUrl'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: Not found (Invalid subscriptionId, resourceGroupName, projectName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
Assessments_GetReportDownloadUrl:
$ref: ./examples/Assessments_GetReportDownloadUrl.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines
: get:
summary: 'Microsoft Azure Get Assessed Machines For Assessment'
description: >-
Get list of machines that assessed as part of the specified assessment.
Returns a json array of objects of type 'assessedMachine' as specified
in the Models section.
Whenever an assessment is created or
updated, it goes under computation. During this phase, the 'status'
field of Assessment object reports 'Computing'.
During the period
when the assessment is under computation, the list of assessed machines
is empty and no assessed machines are returned by this call.
operationId: microsoftAzureAssessedmachinesListbyassessment
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: >-
OK. Returns list of machines with their assessment data in the
assessment.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/AssessedMachineResultList'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName, projectName,
or assessmentName).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-pageable:
nextLinkName:
x-ms-examples:
AssessedMachines_ListByAssessment:
$ref: ./examples/AssessedMachines_ListByAssessment.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}
: get:
summary: 'Microsoft Azure Get An Assessed Machine'
description: >-
Get an assessed machine with its size & cost estimate that was evaluated
in the specified assessment.
operationId: microsoftAzureAssessedmachinesGet
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- $ref: '#/parameters/projectName'
- $ref: '#/parameters/groupName'
- $ref: '#/parameters/assessmentName'
- $ref: '#/parameters/assessedMachineName'
- $ref: '#/parameters/acceptLanguage'
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK. Returns a specific assessed machine.
headers:
x-ms-request-id:
type: string
description: Service generated Request ID.
schema:
$ref: '#/definitions/AssessedMachine'
'401':
description: >-
Not authorized (No access to subscription, resource group, or
project).
'404':
description: >-
Not found (Invalid subscriptionId, resourceGroupName, projectName,
groupName, assessmentName, or machineId).
'500':
description: Internal Server Error.
'503':
description: Service Unavailable.
x-ms-examples:
AssessedMachines_Get:
$ref: ./examples/AssessedMachines_Get.json
tags:
- Subscriptions
/providers/Microsoft.Migrate/operations:
get:
summary: 'Microsoft Azure Get List Of Operations Supported In The Api'
description: Get a list of REST API supported by Microsoft.Migrate provider.
operationId: microsoftAzureOperationsList
responses:
'200':
description: OK. Returns list of operations.
schema:
$ref: '#/definitions/OperationResultList'
x-ms-pageable:
nextLinkName:
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
tags:
- Providers
tags:
- name: Providers
- name: Subscriptions