Microsoft Azure Migrate is a cloud-based service that allows organizations to assess and migrate their on-premises infrastructure and applications to the Azure cloud. By providing a comprehensive and efficient solution for the migration process, Azure Migrate helps businesses quickly and seamlessly transition their workloads to the cloud.
swagger: '2.0'
info:
version: 2017-11-11-preview
title: Microsoft Azure Azure Migrate
description: Move your workloads to Azure.
contact:
name: Microsoft
email: [email protected]
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_H16
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-migrate-openapi-original.yml