Microsoft.Migrate (preview:2024-03-03)

2025/04/14 • 151 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksOptionsOperations_ListByParent (new)
Description :  List AKSAssessmentOptions resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AKSAssessmentOptions items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets the mapping of Assessment Options in graph representation. ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksOptionsOperations_Get (new)
Description :  Get a AKSAssessmentOptions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentOptionsName:
{
Description: AKS Assessment Options Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets the mapping of Assessment Options in graph representation. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksAssessmentOperations_ListByParent (new)
Description :  List AKSAssessment resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AKSAssessment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Gets or sets azure VM category. ,
Enum:
{
All: Indicates All categories of VM. ,
ComputeOptimized: Compute Optimized. ,
GeneralPurpose: General Purpose. ,
GpuOptimized: GPU Optimized. ,
HighPerformanceCompute: High Performance Compute. ,
MemoryOptimized: Memory Optimized. ,
StorageOptimized: Storage Optimized. ,
Isolated: Isolated VM. ,
}
,
Required: True ,
}
enum ,
consolidation:
{
Description: Gets or sets consolidation type. ,
Enum:
{
Full: Full Consolidation. ,
AsOnSource: As On Source or On Premises Consolidation. ,
}
,
Required: True ,
}
enum ,
pricingTier:
{
Description: Gets or sets pricing tier. ,
Enum:
{
Standard: Standard Pricing Tier. ,
Free: Free Pricing Tier. ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksAssessmentOperations_Get (new)
Description :  Get a AKSAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Gets or sets azure VM category. ,
Enum:
{
All: Indicates All categories of VM. ,
ComputeOptimized: Compute Optimized. ,
GeneralPurpose: General Purpose. ,
GpuOptimized: GPU Optimized. ,
HighPerformanceCompute: High Performance Compute. ,
MemoryOptimized: Memory Optimized. ,
StorageOptimized: Storage Optimized. ,
Isolated: Isolated VM. ,
}
,
Required: True ,
}
enum ,
consolidation:
{
Description: Gets or sets consolidation type. ,
Enum:
{
Full: Full Consolidation. ,
AsOnSource: As On Source or On Premises Consolidation. ,
}
,
Required: True ,
}
enum ,
pricingTier:
{
Description: Gets or sets pricing tier. ,
Enum:
{
Standard: Standard Pricing Tier. ,
Free: Free Pricing Tier. ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksAssessmentOperations_Create (new)
Description :  Create a AKSAssessment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Gets or sets azure VM category. ,
Enum:
{
All: Indicates All categories of VM. ,
ComputeOptimized: Compute Optimized. ,
GeneralPurpose: General Purpose. ,
GpuOptimized: GPU Optimized. ,
HighPerformanceCompute: High Performance Compute. ,
MemoryOptimized: Memory Optimized. ,
StorageOptimized: Storage Optimized. ,
Isolated: Isolated VM. ,
}
,
Required: True ,
}
enum ,
consolidation:
{
Description: Gets or sets consolidation type. ,
Enum:
{
Full: Full Consolidation. ,
AsOnSource: As On Source or On Premises Consolidation. ,
}
,
Required: True ,
}
enum ,
pricingTier:
{
Description: Gets or sets pricing tier. ,
Enum:
{
Standard: Standard Pricing Tier. ,
Free: Free Pricing Tier. ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Gets or sets azure VM category. ,
Enum:
{
All: Indicates All categories of VM. ,
ComputeOptimized: Compute Optimized. ,
GeneralPurpose: General Purpose. ,
GpuOptimized: GPU Optimized. ,
HighPerformanceCompute: High Performance Compute. ,
MemoryOptimized: Memory Optimized. ,
StorageOptimized: Storage Optimized. ,
Isolated: Isolated VM. ,
}
,
Required: True ,
}
enum ,
consolidation:
{
Description: Gets or sets consolidation type. ,
Enum:
{
Full: Full Consolidation. ,
AsOnSource: As On Source or On Premises Consolidation. ,
}
,
Required: True ,
}
enum ,
pricingTier:
{
Description: Gets or sets pricing tier. ,
Enum:
{
Standard: Standard Pricing Tier. ,
Free: Free Pricing Tier. ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: ARM model of AKS Assessment. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Gets or sets azure VM category. ,
Enum:
{
All: Indicates All categories of VM. ,
ComputeOptimized: Compute Optimized. ,
GeneralPurpose: General Purpose. ,
GpuOptimized: GPU Optimized. ,
HighPerformanceCompute: High Performance Compute. ,
MemoryOptimized: Memory Optimized. ,
StorageOptimized: Storage Optimized. ,
Isolated: Isolated VM. ,
}
,
Required: True ,
}
enum ,
consolidation:
{
Description: Gets or sets consolidation type. ,
Enum:
{
Full: Full Consolidation. ,
AsOnSource: As On Source or On Premises Consolidation. ,
}
,
Required: True ,
}
enum ,
pricingTier:
{
Description: Gets or sets pricing tier. ,
Enum:
{
Standard: Standard Pricing Tier. ,
Free: Free Pricing Tier. ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksAssessmentOperations_Delete (new)
Description :  Delete a AKSAssessment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedWebApplicationOperations_ListByParent (new)
Description :  List AssessedWebApplication resources by AKSAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedWebApplication items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
recommendationResult:
{
Description: Recommendation Result of assessed webapp. ,
Required: True ,
}
{
request:
{
Description: Gets cores and memory request. ,
Required: True ,
}
{
cores:
{
Description: Gets cores. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: Gets memory. ,
Format: float ,
Required: True ,
}
number ,
}
,
limit:
{
Description: Gets cores and memory limit. ,
Required: True ,
}
{
cores:
{
Description: Gets cores. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: Gets memory. ,
Format: float ,
Required: True ,
}
number ,
}
,
clusterName:
{
Description: Gets cluster name. ,
Required: True ,
}
string ,
}
,
webAppType:
{
Description: Type of assessed webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedWebApplicationOperations_Get (new)
Description :  Get a AssessedWebApplication
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
assessedWorkload:
{
Description: Assessed Web Application Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
recommendationResult:
{
Description: Recommendation Result of assessed webapp. ,
Required: True ,
}
{
request:
{
Description: Gets cores and memory request. ,
Required: True ,
}
{
cores:
{
Description: Gets cores. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: Gets memory. ,
Format: float ,
Required: True ,
}
number ,
}
,
limit:
{
Description: Gets cores and memory limit. ,
Required: True ,
}
{
cores:
{
Description: Gets cores. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: Gets memory. ,
Format: float ,
Required: True ,
}
number ,
}
,
clusterName:
{
Description: Gets cluster name. ,
Required: True ,
}
string ,
}
,
webAppType:
{
Description: Type of assessed webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksClusterOperations_ListByParent (new)
Description :  List AKSCluster resources by AKSAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AKSCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
nodePools:
{
Description: Gets list of node pools. ,
Required: True ,
}
[
{
id:
{
Description: Gets id. ,
Required: True ,
}
string ,
name:
{
Description: Gets name. ,
Required: True ,
}
string ,
clusterName:
{
Description: Gets cluster name. ,
Required: True ,
}
string ,
mode:
{
Description: Gets mode. ,
Enum:
{
User: Indicates User node pool. ,
System: Indicates System node pool. ,
}
,
Required: True ,
}
enum ,
osType:
{
Description: Gets os type. ,
Enum:
{
Linux: Linux OS Type. ,
Windows: Windows OS Type. ,
}
,
Required: True ,
}
enum ,
armSkuName:
{
Description: Gets arm sku name. ,
Required: True ,
}
string ,
nodeCount:
{
Description: Gets node count. ,
Format: int32 ,
Required: True ,
}
integer ,
podCount:
{
Description: Gets pod count. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Gets monthly cost. ,
Format: float ,
Required: True ,
}
number ,
podApproxMonthlyCost:
{
Description: Gets pod approximate monthly cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
region:
{
Description: Gets region. ,
Required: True ,
}
string ,
userNodePoolCount:
{
Description: Gets user node pool count. ,
Format: int32 ,
Required: True ,
}
integer ,
userNodeCount:
{
Description: Gets user node count. ,
Format: int32 ,
Required: True ,
}
integer ,
systemNodePoolCount:
{
Description: Gets system node pool count. ,
Format: int32 ,
Required: True ,
}
integer ,
systemNodeCount:
{
Description: Gets system node count. ,
Format: int32 ,
Required: True ,
}
integer ,
podCount:
{
Description: Gets pod count. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Gets monthly cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksClusterOperations_Get (new)
Description :  Get a AKSCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
clusterName:
{
Description: AKS Cluster Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
nodePools:
{
Description: Gets list of node pools. ,
Required: True ,
}
[
{
id:
{
Description: Gets id. ,
Required: True ,
}
string ,
name:
{
Description: Gets name. ,
Required: True ,
}
string ,
clusterName:
{
Description: Gets cluster name. ,
Required: True ,
}
string ,
mode:
{
Description: Gets mode. ,
Enum:
{
User: Indicates User node pool. ,
System: Indicates System node pool. ,
}
,
Required: True ,
}
enum ,
osType:
{
Description: Gets os type. ,
Enum:
{
Linux: Linux OS Type. ,
Windows: Windows OS Type. ,
}
,
Required: True ,
}
enum ,
armSkuName:
{
Description: Gets arm sku name. ,
Required: True ,
}
string ,
nodeCount:
{
Description: Gets node count. ,
Format: int32 ,
Required: True ,
}
integer ,
podCount:
{
Description: Gets pod count. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Gets monthly cost. ,
Format: float ,
Required: True ,
}
number ,
podApproxMonthlyCost:
{
Description: Gets pod approximate monthly cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
region:
{
Description: Gets region. ,
Required: True ,
}
string ,
userNodePoolCount:
{
Description: Gets user node pool count. ,
Format: int32 ,
Required: True ,
}
integer ,
userNodeCount:
{
Description: Gets user node count. ,
Format: int32 ,
Required: True ,
}
integer ,
systemNodePoolCount:
{
Description: Gets system node pool count. ,
Format: int32 ,
Required: True ,
}
integer ,
systemNodeCount:
{
Description: Gets system node count. ,
Format: int32 ,
Required: True ,
}
integer ,
podCount:
{
Description: Gets pod count. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Gets monthly cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksCostDetailOperations_ListByParent (new)
Description :  List AKSCostDetail resources by AKSAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AKSCostDetail items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
id:
{
Description: Gets id. ,
Required: True ,
}
string ,
name:
{
Description: Gets name. ,
Required: True ,
}
string ,
clusterName:
{
Description: Gets cluster name. ,
Required: True ,
}
string ,
mode:
{
Description: Gets mode. ,
Enum:
{
User: Indicates User node pool. ,
System: Indicates System node pool. ,
}
,
Required: True ,
}
enum ,
osType:
{
Description: Gets os type. ,
Enum:
{
Linux: Linux OS Type. ,
Windows: Windows OS Type. ,
}
,
Required: True ,
}
enum ,
armSkuName:
{
Description: Gets arm sku name. ,
Required: True ,
}
string ,
nodeCount:
{
Description: Gets node count. ,
Format: int32 ,
Required: True ,
}
integer ,
podCount:
{
Description: Gets pod count. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Gets monthly cost. ,
Format: float ,
Required: True ,
}
number ,
podApproxMonthlyCost:
{
Description: Gets pod approximate monthly cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksAssessmentOperations_DownloadUrl (new)
Description :  Get URL for downloading AKS Assessment Report.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksSummaryOperations_ListByParent (new)
Description :  List AKSSummary resources by AKSAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AKSSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
webAppCount:
{
Description: Gets the number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
webServerCount:
{
Description: Gets the number of web servers. ,
Format: int32 ,
Required: True ,
}
integer ,
machineCount:
{
Description: Gets the number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AksSummaryOperations_Get (new)
Description :  Get a AKSSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AKS Assessment Name. ,
Required: True ,
}
string ,
summaryName:
{
Description: AKS Assessment Summary Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
webAppCount:
{
Description: Gets the number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
webServerCount:
{
Description: Gets the number of web servers. ,
Format: int32 ,
Required: True ,
}
integer ,
machineCount:
{
Description: Gets the number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_ListBySubscription (new)
Description :  List AssessmentProject resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentProject items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_ListByParent (new)
Description :  List AssessmentProject resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentProject items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_Get (new)
Description :  Get a AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_Create (new)
Description :  Create a AssessmentProject
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An Assessment project site resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_Update (new)
Description :  Update a AssessmentProject
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Time when this project was created. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Time when this project was last updated. Date-Time represented in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Endpoint at which the collector agent can call agent REST API. ,
Required: False ,
}
string ,
assessmentSolutionId:
{
Description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. ,
Required: False ,
}
string ,
projectStatus:
{
Description: Assessment project status. ,
Enum:
{
Active: Active Status. ,
Inactive: Inactive Status. ,
}
,
Required: False ,
}
enum ,
customerWorkspaceId:
{
Description: The ARM id of service map workspace created by customer. ,
Required: False ,
}
string ,
customerWorkspaceLocation:
{
Description: Location of service map workspace created by customer. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the project. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
customerStorageAccountArmId:
{
Description: The ARM id of the storage account used for interactions when public access is disabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectsOperations_Delete (new)
Description :  Delete a AssessmentProject
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnectionOperations_ListByParent (new)
Description :  List PrivateEndpointConnection resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnectionOperations_Get (new)
Description :  Get a PrivateEndpointConnection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnectionOperations_Update (new)
Description :  Create a PrivateEndpointConnection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Private endpoint connection resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnectionOperations_Delete (new)
Description :  Delete a PrivateEndpointConnection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResourceOperations_ListByParent (new)
Description :  List PrivateLinkResource resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResourceOperations_Get (new)
Description :  Get a PrivateLinkResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: Private link resource ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectSummaryOperations_ListByParent (new)
Description :  List AssessmentProjectSummary resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentProjectSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
errorSummaryAffectedEntities:
{
Description: Gets the Error summary by feature. Contains number of affected Entities per feature. ,
Required: False ,
}
[
{
assessmentType:
{
Description: Gets the assessment type. ,
Required: False ,
}
string ,
count:
{
Description: Gets the affected entity count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
numberOfPrivateEndpointConnections:
{
Description: Gets the number of private endpoint connections. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfGroups:
{
Description: Gets the number of groups created in this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfMachines:
{
Description: Gets the number of machines part of this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfImportMachines:
{
Description: Gets the number of import machines part of this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAssessments:
{
Description: Gets the number of assessments created in this project. ,
Format: int32 ,
Required: False ,
}
integer ,
lastAssessmentTimestamp:
{
Description: Gets the last assessment timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentProjectSummaryOperations_Get (new)
Description :  Get a AssessmentProjectSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
projectSummaryName:
{
Description: Assessment project summary resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
errorSummaryAffectedEntities:
{
Description: Gets the Error summary by feature. Contains number of affected Entities per feature. ,
Required: False ,
}
[
{
assessmentType:
{
Description: Gets the assessment type. ,
Required: False ,
}
string ,
count:
{
Description: Gets the affected entity count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
numberOfPrivateEndpointConnections:
{
Description: Gets the number of private endpoint connections. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfGroups:
{
Description: Gets the number of groups created in this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfMachines:
{
Description: Gets the number of machines part of this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfImportMachines:
{
Description: Gets the number of import machines part of this project. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAssessments:
{
Description: Gets the number of assessments created in this project. ,
Format: int32 ,
Required: False ,
}
integer ,
lastAssessmentTimestamp:
{
Description: Gets the last assessment timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsGraphAssessmentOptionsOperations_ListByParent (new)
Description :  List AvsGraphAssessmentOptions resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsGraphAssessmentOptions items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsGraphAssessmentOptionsOperations_Get (new)
Description :  Get a AvsGraphAssessmentOptions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentsV2Operations_ListByParent (new)
Description :  List AvsAssessmentV2 resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsAssessmentV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
failuresToTolerateAndRaidLevelList:
{
Description: List of Failures to tolerate and RAID levels in a common property. ,
Required: False ,
}
[
string ,
]
,
vcpuOversubscription:
{
Description: VCPU over subscription. ,
Format: float ,
Required: False ,
}
number ,
nodeTypes:
{
Description: AVS node types. ,
Required: False ,
}
[
string ,
]
,
avsAssessmentScenario:
{
Description: AVS Assessment Scenario. ,
Enum:
{
Unknown: Unknown assessment scenario ,
NewAvsSddc: Create Assessment for new Avs Sddc ,
AvsSddcExpansion: Create Assessment for existing Avs Sddc ,
}
,
Required: False ,
}
enum ,
externalStorageTypes:
{
Description: List of AVS external storage types. ,
Required: False ,
}
[
string ,
]
,
cpuHeadroom:
{
Description: Gets or sets the CPU headroom. ,
Format: float ,
Required: False ,
}
number ,
isVcfByolEnabled:
{
Description: Is VCF license applied ,
Required: False ,
}
boolean ,
memOvercommit:
{
Description: Memory overcommit. ,
Format: float ,
Required: False ,
}
number ,
dedupeCompression:
{
Description: De-duplication compression. ,
Format: float ,
Required: False ,
}
number ,
isStretchClusterEnabled:
{
Description: Is Stretch Cluster Enabled. ,
Required: False ,
}
boolean ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentsV2Operations_Get (new)
Description :  Get a AvsAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
failuresToTolerateAndRaidLevelList:
{
Description: List of Failures to tolerate and RAID levels in a common property. ,
Required: False ,
}
[
string ,
]
,
vcpuOversubscription:
{
Description: VCPU over subscription. ,
Format: float ,
Required: False ,
}
number ,
nodeTypes:
{
Description: AVS node types. ,
Required: False ,
}
[
string ,
]
,
avsAssessmentScenario:
{
Description: AVS Assessment Scenario. ,
Enum:
{
Unknown: Unknown assessment scenario ,
NewAvsSddc: Create Assessment for new Avs Sddc ,
AvsSddcExpansion: Create Assessment for existing Avs Sddc ,
}
,
Required: False ,
}
enum ,
externalStorageTypes:
{
Description: List of AVS external storage types. ,
Required: False ,
}
[
string ,
]
,
cpuHeadroom:
{
Description: Gets or sets the CPU headroom. ,
Format: float ,
Required: False ,
}
number ,
isVcfByolEnabled:
{
Description: Is VCF license applied ,
Required: False ,
}
boolean ,
memOvercommit:
{
Description: Memory overcommit. ,
Format: float ,
Required: False ,
}
number ,
dedupeCompression:
{
Description: De-duplication compression. ,
Format: float ,
Required: False ,
}
number ,
isStretchClusterEnabled:
{
Description: Is Stretch Cluster Enabled. ,
Required: False ,
}
boolean ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentsV2Operations_Create (new)
Description :  Create a AvsAssessmentV2
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
failuresToTolerateAndRaidLevelList:
{
Description: List of Failures to tolerate and RAID levels in a common property. ,
Required: False ,
}
[
string ,
]
,
vcpuOversubscription:
{
Description: VCPU over subscription. ,
Format: float ,
Required: False ,
}
number ,
nodeTypes:
{
Description: AVS node types. ,
Required: False ,
}
[
string ,
]
,
avsAssessmentScenario:
{
Description: AVS Assessment Scenario. ,
Enum:
{
Unknown: Unknown assessment scenario ,
NewAvsSddc: Create Assessment for new Avs Sddc ,
AvsSddcExpansion: Create Assessment for existing Avs Sddc ,
}
,
Required: False ,
}
enum ,
externalStorageTypes:
{
Description: List of AVS external storage types. ,
Required: False ,
}
[
string ,
]
,
cpuHeadroom:
{
Description: Gets or sets the CPU headroom. ,
Format: float ,
Required: False ,
}
number ,
isVcfByolEnabled:
{
Description: Is VCF license applied ,
Required: False ,
}
boolean ,
memOvercommit:
{
Description: Memory overcommit. ,
Format: float ,
Required: False ,
}
number ,
dedupeCompression:
{
Description: De-duplication compression. ,
Format: float ,
Required: False ,
}
number ,
isStretchClusterEnabled:
{
Description: Is Stretch Cluster Enabled. ,
Required: False ,
}
boolean ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
failuresToTolerateAndRaidLevelList:
{
Description: List of Failures to tolerate and RAID levels in a common property. ,
Required: False ,
}
[
string ,
]
,
vcpuOversubscription:
{
Description: VCPU over subscription. ,
Format: float ,
Required: False ,
}
number ,
nodeTypes:
{
Description: AVS node types. ,
Required: False ,
}
[
string ,
]
,
avsAssessmentScenario:
{
Description: AVS Assessment Scenario. ,
Enum:
{
Unknown: Unknown assessment scenario ,
NewAvsSddc: Create Assessment for new Avs Sddc ,
AvsSddcExpansion: Create Assessment for existing Avs Sddc ,
}
,
Required: False ,
}
enum ,
externalStorageTypes:
{
Description: List of AVS external storage types. ,
Required: False ,
}
[
string ,
]
,
cpuHeadroom:
{
Description: Gets or sets the CPU headroom. ,
Format: float ,
Required: False ,
}
number ,
isVcfByolEnabled:
{
Description: Is VCF license applied ,
Required: False ,
}
boolean ,
memOvercommit:
{
Description: Memory overcommit. ,
Format: float ,
Required: False ,
}
number ,
dedupeCompression:
{
Description: De-duplication compression. ,
Format: float ,
Required: False ,
}
number ,
isStretchClusterEnabled:
{
Description: Is Stretch Cluster Enabled. ,
Required: False ,
}
boolean ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: AVS assessment V2 resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
failuresToTolerateAndRaidLevelList:
{
Description: List of Failures to tolerate and RAID levels in a common property. ,
Required: False ,
}
[
string ,
]
,
vcpuOversubscription:
{
Description: VCPU over subscription. ,
Format: float ,
Required: False ,
}
number ,
nodeTypes:
{
Description: AVS node types. ,
Required: False ,
}
[
string ,
]
,
avsAssessmentScenario:
{
Description: AVS Assessment Scenario. ,
Enum:
{
Unknown: Unknown assessment scenario ,
NewAvsSddc: Create Assessment for new Avs Sddc ,
AvsSddcExpansion: Create Assessment for existing Avs Sddc ,
}
,
Required: False ,
}
enum ,
externalStorageTypes:
{
Description: List of AVS external storage types. ,
Required: False ,
}
[
string ,
]
,
cpuHeadroom:
{
Description: Gets or sets the CPU headroom. ,
Format: float ,
Required: False ,
}
number ,
isVcfByolEnabled:
{
Description: Is VCF license applied ,
Required: False ,
}
boolean ,
memOvercommit:
{
Description: Memory overcommit. ,
Format: float ,
Required: False ,
}
number ,
dedupeCompression:
{
Description: De-duplication compression. ,
Format: float ,
Required: False ,
}
number ,
isStretchClusterEnabled:
{
Description: Is Stretch Cluster Enabled. ,
Required: False ,
}
boolean ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentsV2Operations_Delete (new)
Description :  Delete a AvsAssessmentV2
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessedMachinesV2Operations_ListByParent (new)
Description :  List AvsAssessedMachineV2 resources by AvsAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}/avsAssessedMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsAssessedMachineV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The assessed machine extended details. ,
Required: False ,
}
{
errors:
{
Description: List of errors for this machine. ,
Required: False ,
}
[
{
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the Run as account ID. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the Appliance name. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
agentScenario:
{
Description: Gets the agent scenario where this error occurred. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the error possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action for the error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the error message parameters. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
impactedAssessmentType:
{
Description: Gets the type of assessment impacted by this error. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: List of Disks that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
name:
{
Description: Gets the ID of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the disk. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gigabytes Provisioned for a disk in private data center. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Disk Read Throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Disk Write Throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Read Operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Write Operations per second. ,
Format: float ,
Required: False ,
}
number ,
assessedExternalStorageType:
{
Description: Associated storage Type recommended for Disk. ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
estimatedDiskSizeInGB:
{
Description: Estimated Disk Size in GB. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
networkAdapters:
{
Description: List of Network Adapters that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
macAddress:
{
Description: Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: IP V4 addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name of the network adapter. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the network adapter. ,
Required: False ,
}
string ,
megabytesPerSecondRecieved:
{
Description: Gets the Recieved data for Network Adapter in MB/s. This value is the percentile of historical data based on options selected in Assessment. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the Transmitted data for Network Adapter in MB/s. This value is the percentile of historical data based on options selected in Assessment. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
storageInUseGB:
{
Description: Gets the storage in use. ,
Format: float ,
Required: False ,
}
number ,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
datacenterManagementServerName:
{
Description: Data center management server name. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
avsTargetNode:
{
Description: Gets the Avs Target Type for Machine. ,
Enum:
{
Unknown: Unknown Node type ,
AV36: AVS36 Node type ,
AV36P: AV36P Node type ,
AV52: AV52 Node type ,
AV64: AV64 Node type ,
}
,
Required: False ,
}
enum ,
}
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessedMachinesV2Operations_Get (new)
Description :  Get a AvsAssessedMachineV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
avsAssessedMachineName:
{
Description: AVS assessment Assessed Machine V2 ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The assessed machine extended details. ,
Required: False ,
}
{
errors:
{
Description: List of errors for this machine. ,
Required: False ,
}
[
{
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the Run as account ID. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the Appliance name. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
agentScenario:
{
Description: Gets the agent scenario where this error occurred. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the error possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action for the error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the error message parameters. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
impactedAssessmentType:
{
Description: Gets the type of assessment impacted by this error. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: List of Disks that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
name:
{
Description: Gets the ID of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the disk. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gigabytes Provisioned for a disk in private data center. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Disk Read Throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Disk Write Throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Read Operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Write Operations per second. ,
Format: float ,
Required: False ,
}
number ,
assessedExternalStorageType:
{
Description: Associated storage Type recommended for Disk. ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
estimatedDiskSizeInGB:
{
Description: Estimated Disk Size in GB. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
networkAdapters:
{
Description: List of Network Adapters that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
macAddress:
{
Description: Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: IP V4 addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name of the network adapter. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the network adapter. ,
Required: False ,
}
string ,
megabytesPerSecondRecieved:
{
Description: Gets the Recieved data for Network Adapter in MB/s. This value is the percentile of historical data based on options selected in Assessment. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the Transmitted data for Network Adapter in MB/s. This value is the percentile of historical data based on options selected in Assessment. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
storageInUseGB:
{
Description: Gets the storage in use. ,
Format: float ,
Required: False ,
}
number ,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
datacenterManagementServerName:
{
Description: Data center management server name. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
avsTargetNode:
{
Description: Gets the Avs Target Type for Machine. ,
Enum:
{
Unknown: Unknown Node type ,
AV36: AVS36 Node type ,
AV36P: AV36P Node type ,
AV52: AV52 Node type ,
AV64: AV64 Node type ,
}
,
Required: False ,
}
enum ,
}
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentsV2Operations_DownloadUrl (new)
Description :  Get the URL for downloading the assessment in a report format.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentV2SummaryOperations_ListByParent (new)
Description :  List AvsAssessmentV2Summary resources by AvsAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsAssessmentV2Summary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
suitability:
{
Description: Gets or sets the Assessment cloud suitability. ,
Enum:
{
Unknown: Unknown. Indicates missing data. ,
NotSuitable: Not Suitable for Azure. ,
Suitable: Suitable for Azure. ,
ConditionallySuitable: Conditionally Suitable for Azure. ,
ReadinessUnknown: Unknown Readiness for Azure. ,
}
,
Required: False ,
}
enum ,
suitabilityExplanation:
{
Description: Gets or sets the Assessment suitability explanation. ,
Enum:
{
Unknown: Suitability Unknown ,
NotApplicable: Suitability Not applicable ,
UnsupportedLocationForSelectedNode: Unsupported location for selected node ,
InternalErrorInRecommendation: Internal error in recommendation ,
UnsupportedLocationForSelectedExternalStorageTypes: Unsupported location for selected external storage types ,
}
,
Required: False ,
}
enum ,
numberOfNodes:
{
Description: Recommended number of nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: Predicted CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
ramUtilization:
{
Description: Predicted RAM utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
totalCpuCores:
{
Description: Predicted total CPU cores used. ,
Format: float ,
Required: False ,
}
number ,
totalRamInGB:
{
Description: Predicted total RAM used in GB. ,
Format: float ,
Required: False ,
}
number ,
totalStorageInGB:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
avsEstimatedNodes:
{
Description: Estimated AVS SKU for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Total monthly cost for type and number of nodes. ,
Format: float ,
Required: False ,
}
number ,
nodeType:
{
Description: Recommended SKU. ,
Enum:
{
Unknown: Unknown Node type ,
AV36: AVS36 Node type ,
AV36P: AV36P Node type ,
AV52: AV52 Node type ,
AV64: AV64 Node type ,
}
,
Required: False ,
}
enum ,
nodeNumber:
{
Description: Number of nodes that will be needed. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: Predicted CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
ramUtilization:
{
Description: Predicted RAM utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
totalCpu:
{
Description: Predicted total CPU cores across the set of nodes. ,
Format: float ,
Required: False ,
}
number ,
totalRam:
{
Description: Predicted total RAM used in GB. ,
Format: float ,
Required: False ,
}
number ,
totalStorage:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
pricingModel:
{
Description: Pricing model indicates what hour multiplier to use while estimating the Nodes cost. ,
Enum:
{
None: None Azure reserved Instance ,
RI1Year: RI1Year Azure reserved Instance ,
RI3Year: RI3Year Azure reserved Instance ,
}
,
Required: False ,
}
enum ,
fttRaidLevel:
{
Description: FttRaidLevel recommended for Node. ,
Enum:
{
Unknown: Unknown FTT and RAID Level. ,
Ftt1Raid1: FTT 1 and RAID Level 1. ,
Ftt1Raid5: FTT 1 and RAID Level 5. ,
Ftt2Raid1: FTT 2 and RAID Level 1. ,
Ftt2Raid6: FTT 2 and RAID Level 6. ,
Ftt3Raid1: FTT 3 and RAID Level 1. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
avsEstimatedExternalStorages:
{
Description: Estimated External Storage for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Total monthly cost for type of storage. ,
Format: float ,
Required: False ,
}
number ,
storageType:
{
Description: Recommended External Storage. ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
totalStorageInGB:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
avsEstimatedNetworks:
{
Description: Estimated External Storage for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Monthly cost for network type. ,
Format: float ,
Required: False ,
}
number ,
networkType:
{
Description: Recommended Network Sku. ,
Enum:
{
Unknown: Indicates un-supported network SKU. ,
None: Indicates No network SKU. ,
ExpressRouteUltra: Express Route network type with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
limitingFactor:
{
Description: Limiting factor. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsAssessmentV2SummaryOperations_Get (new)
Description :  Get a AvsAssessmentV2Summary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: AVS Assessment ARM name ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the AVS Assessment Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
suitability:
{
Description: Gets or sets the Assessment cloud suitability. ,
Enum:
{
Unknown: Unknown. Indicates missing data. ,
NotSuitable: Not Suitable for Azure. ,
Suitable: Suitable for Azure. ,
ConditionallySuitable: Conditionally Suitable for Azure. ,
ReadinessUnknown: Unknown Readiness for Azure. ,
}
,
Required: False ,
}
enum ,
suitabilityExplanation:
{
Description: Gets or sets the Assessment suitability explanation. ,
Enum:
{
Unknown: Suitability Unknown ,
NotApplicable: Suitability Not applicable ,
UnsupportedLocationForSelectedNode: Unsupported location for selected node ,
InternalErrorInRecommendation: Internal error in recommendation ,
UnsupportedLocationForSelectedExternalStorageTypes: Unsupported location for selected external storage types ,
}
,
Required: False ,
}
enum ,
numberOfNodes:
{
Description: Recommended number of nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: Predicted CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
ramUtilization:
{
Description: Predicted RAM utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
totalCpuCores:
{
Description: Predicted total CPU cores used. ,
Format: float ,
Required: False ,
}
number ,
totalRamInGB:
{
Description: Predicted total RAM used in GB. ,
Format: float ,
Required: False ,
}
number ,
totalStorageInGB:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
avsEstimatedNodes:
{
Description: Estimated AVS SKU for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Total monthly cost for type and number of nodes. ,
Format: float ,
Required: False ,
}
number ,
nodeType:
{
Description: Recommended SKU. ,
Enum:
{
Unknown: Unknown Node type ,
AV36: AVS36 Node type ,
AV36P: AV36P Node type ,
AV52: AV52 Node type ,
AV64: AV64 Node type ,
}
,
Required: False ,
}
enum ,
nodeNumber:
{
Description: Number of nodes that will be needed. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: Predicted CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
ramUtilization:
{
Description: Predicted RAM utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
totalCpu:
{
Description: Predicted total CPU cores across the set of nodes. ,
Format: float ,
Required: False ,
}
number ,
totalRam:
{
Description: Predicted total RAM used in GB. ,
Format: float ,
Required: False ,
}
number ,
totalStorage:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
pricingModel:
{
Description: Pricing model indicates what hour multiplier to use while estimating the Nodes cost. ,
Enum:
{
None: None Azure reserved Instance ,
RI1Year: RI1Year Azure reserved Instance ,
RI3Year: RI3Year Azure reserved Instance ,
}
,
Required: False ,
}
enum ,
fttRaidLevel:
{
Description: FttRaidLevel recommended for Node. ,
Enum:
{
Unknown: Unknown FTT and RAID Level. ,
Ftt1Raid1: FTT 1 and RAID Level 1. ,
Ftt1Raid5: FTT 1 and RAID Level 5. ,
Ftt2Raid1: FTT 2 and RAID Level 1. ,
Ftt2Raid6: FTT 2 and RAID Level 6. ,
Ftt3Raid1: FTT 3 and RAID Level 1. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
avsEstimatedExternalStorages:
{
Description: Estimated External Storage for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Total monthly cost for type of storage. ,
Format: float ,
Required: False ,
}
number ,
storageType:
{
Description: Recommended External Storage. ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
totalStorageInGB:
{
Description: Predicted total Storage used in GB. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Predicted storage utilization. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
avsEstimatedNetworks:
{
Description: Estimated External Storage for Assessment. ,
Required: False ,
}
[
{
monthlyPrice:
{
Description: Monthly cost for network type. ,
Format: float ,
Required: False ,
}
number ,
networkType:
{
Description: Recommended Network Sku. ,
Enum:
{
Unknown: Indicates un-supported network SKU. ,
None: Indicates No network SKU. ,
ExpressRouteUltra: Express Route network type with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
limitingFactor:
{
Description: Limiting factor. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_ListByParent (new)
Description :  List BusinessCase resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BusinessCase items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
settings:
{
Description: Business case settings. ,
Required: False ,
}
{
azureSettings:
{
Description: Azure settings for a business case. ,
Required: True ,
}
{
targetLocation:
{
Description: Gets or sets azure location. ,
Required: True ,
}
string ,
discountPercentage:
{
Description: Gets azure Discount percentage. ,
Format: float ,
Required: False ,
}
number ,
currency:
{
Description: Business case Currency. ,
Enum:
{
Unknown: Currency Unknown. ,
USD: Currency USD. ,
DKK: Currency DKK. ,
CAD: Currency CAD. ,
IDR: Currency IDR. ,
JPY: Currency JPY. ,
KRW: Currency KRW. ,
NZD: Currency NZD. ,
NOK: Currency NOK. ,
RUB: Currency RUB. ,
SAR: Currency SAR. ,
ZAR: Currency ZAR. ,
SEK: Currency SEK. ,
TRY: Currency TRY. ,
GBP: Currency GBP. ,
MXN: Currency MXN. ,
MYR: Currency MYR. ,
INR: Currency INR. ,
HKD: Currency HKD. ,
BRL: Currency BRL. ,
TWD: Currency TWD. ,
EUR: Currency EUR. ,
CHF: Currency CHF. ,
ARS: Currency ARS. ,
AUD: Currency AUD. ,
CNY: Currency CNY. ,
}
,
Required: True ,
}
enum ,
businessCaseType:
{
Description: Migration Strategy. ,
Enum:
{
Unknown: Unknown Migration Strategy. ,
OptimizeForCost: Optimize for cost. ,
IaaSOnly: IaaS only. ,
OptimizeForPaas: Optimize for PaaS. ,
AVSOnly: Avs only. ,
}
,
Required: False ,
}
enum ,
workloadDiscoverySource:
{
Description: Workload discovery source. ,
Enum:
{
Unknown: Unknown Discovery Source. ,
Appliance: Appliance Discovery Source. ,
Import: Import Discovery Source. ,
}
,
Required: False ,
}
enum ,
performanceDataStartTime:
{
Description: Gets start time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
performanceDataEndTime:
{
Description: Gets end time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
comfortFactor:
{
Description: Gets comfort factor. ,
Format: float ,
Required: False ,
}
number ,
performanceUtilizationPercentile:
{
Description: Gets utilization percentile for performance. ,
Format: float ,
Required: False ,
}
number ,
perYearMigrationCompletionPercentage:
{
Description: Gets migration completion percentage per year. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
infrastructureGrowthRate:
{
Description: Gets infrastructure growth rate. ,
Format: float ,
Required: False ,
}
number ,
wacc:
{
Description: Gets wACC percentage. ,
Format: float ,
Required: False ,
}
number ,
networkCostPercentage:
{
Description: Gets network cost percentage. ,
Format: float ,
Required: False ,
}
number ,
iaasLaborCostPercentage:
{
Description: Gets IaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
paasLaborCostPercentage:
{
Description: Gets PaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
avsLaborCostPercentage:
{
Description: Gets Avs labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
savingsOption:
{
Description: Gets the business case savings option type. ,
Enum:
{
Unknown: Unknown Savings Option. ,
RI3Year: Reserved Instance 3 Year. ,
SavingsPlan3Year: Azure Savings Plan 3 Year. ,
}
,
Required: False ,
}
enum ,
}
,
onPremiseSettings:
{
Description: On-premise settings. ,
Required: False ,
}
{
computeSettings:
{
Description: Compute settings. ,
Required: True ,
}
{
hyperthreadCoreToMemoryRatio:
{
Description: Hyperthread core to memory ratio. ,
Format: float ,
Required: True ,
}
number ,
price:
{
Description: Compute Price. ,
Format: float ,
Required: True ,
}
number ,
computeHardwareMaintenanceCost:
{
Description: Compute Hardware Maintenance Cost. ,
Format: float ,
Required: True ,
}
number ,
vmOversubscriptionRatio:
{
Description: VM Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
cpuOversubscriptionRatio:
{
Description: CPU Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
sqlServerLicensing:
{
Description: SQL Server licensing settings. ,
Required: True ,
}
[
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: Unknown Sql Server License. ,
Enterprise: Enterprise Sql Server License. ,
Standard: Standard Sql Server License. ,
}
,
Required: True ,
}
enum ,
licenseCost:
{
Description: Licence cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
windowsServerLicensing:
{
Description: Windows Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
licensesPerCore:
{
Description: Licenses per core. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rhelLinuxServerLicensing:
{
Description: Linux Rhel Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
suseLinuxServerLicensing:
{
Description: Linux Suse Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
virtualizationSoftwareSettings:
{
Description: Virtualization software settings. ,
Required: True ,
}
{
vMwareCloudFoundationLicenseCost:
{
Description: VMware cloud foundation license cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
storageSettings:
{
Description: Storage settings. ,
Required: True ,
}
{
costPerGbPerYear:
{
Description: Cost per gigabyte per year. ,
Format: float ,
Required: True ,
}
number ,
maintainanceCostPercentageToAcquisitionCost:
{
Description: Maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
}
,
networkSettings:
{
Description: Network settings. ,
Required: True ,
}
{
maintenanceCostPercentage:
{
Description: Network maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
physicalServersPerCabinet:
{
Description: Number of physical servers per cabinet ,
Format: int32 ,
Required: True ,
}
integer ,
averageCostPerCabinet:
{
Description: Average cost per cabinet ,
Format: float ,
Required: True ,
}
number ,
}
,
facilitySettings:
{
Description: Facility settings. ,
Required: True ,
}
{
facilitiesCostPerKwh:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
powerUtilizationEfficiency:
{
Description: Power utilization Efficiency. ,
Format: float ,
Required: True ,
}
number ,
}
,
laborSettings:
{
Description: Labour settings. ,
Required: True ,
}
{
physicalServersPerAdmin:
{
Description: Physical servers per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
virtualMachinesPerAdmin:
{
Description: Virtual machines per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
hourlyAdminCost:
{
Description: Hourly administrator cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
securitySettings:
{
Description: Security settings. ,
Required: True ,
}
{
serverSecurityCostPerServerPerYear:
{
Description: Physical servers per administrator. ,
Format: float ,
Required: True ,
}
number ,
sqlServerSecurityCostPerServerPerYear:
{
Description: Virtual machines per administrator. ,
Format: float ,
Required: True ,
}
number ,
}
,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
hypervVirtualizationManagementSettings:
{
Description: HyperV Virtualization Management Settings. ,
Required: True ,
}
{
numberOfPhysicalCoresPerLicense:
{
Description: Number of physical cores per licence. ,
Format: int32 ,
Required: True ,
}
integer ,
softwareAssuranceCost:
{
Description: Software Assurance Cost. ,
Format: float ,
Required: True ,
}
number ,
licenseAndSupportList:
{
Description: Licence and support list. ,
Required: True ,
}
[
{
licenseCost:
{
Description: Cost of a licence. ,
Format: float ,
Required: True ,
}
number ,
licenseType:
{
Description: HyperV licence type. ,
Enum:
{
Unknown: Unknown HyperV License. ,
Datacentre: Datacentre HyperV License. ,
Standard: Standard HyperV License. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
thirdPartyManagementSettings:
{
Description: Third Party Management Settings. ,
Required: True ,
}
{
licenseCost:
{
Description: License Cost. ,
Format: float ,
Required: True ,
}
number ,
supportCost:
{
Description: Support Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
otherManagementCostsSettings:
{
Description: Other Management Costs Settings. ,
Required: True ,
}
{
monitoringCostPerServerPerYear:
{
Description: Monitoring Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
patchingCostPerServerPerYear:
{
Description: Patching Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
dataProtectionCostPerServerPerYear:
{
Description: Data Protection Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
azureArcSettings:
{
Description: Azure arc settings. ,
Required: False ,
}
{
azureArcState:
{
Description: AzureArc state indicates whether to include azure arc related costs in on-premises or not. ,
Enum:
{
Disabled: AzureArc state disabled. ,
Enabled: AzureArc state enabled. ,
Unknown: AzureArc state unknown. ,
}
,
Required: True ,
}
enum ,
laborCostPercentage:
{
Description: Gets Azure arc labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Gets the azure arc monitoring settings. ,
Required: True ,
}
{
logsVolumeInGB:
{
Description: Logs volume settings. ,
Format: float ,
Required: True ,
}
number ,
alertRulesCount:
{
Description: Number of alert rules settings. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
state:
{
Description: Business case state. ,
Enum:
{
Unknown: Unknown State. ,
InProgress: InProgress State. ,
Completed: Completed State. ,
OutDated: OutDated State. ,
Invalid: Invalid State. ,
OutOfSync: OutOfSync State. ,
Failed: Failed State. ,
}
,
Required: False ,
}
enum ,
reportStatusDetails:
{
Description: Gets the state of business case reports. ,
Required: False ,
}
[
{
reportType:
{
Description: Report type. ,
Enum:
{
Unknown: Unknown Report Type. ,
Excel: Excel Report Type. ,
}
,
Required: False ,
}
enum ,
reportStatus:
{
Description: Report status. ,
Enum:
{
Unknown: Unknown Report Status. ,
None: None Report Status. ,
InProgress: InProgress Report Status. ,
Failed: Failed Report Status. ,
Completed: Completed Report Status. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
businessCaseScope:
{
Description: Gets the business case scope. ,
Required: False ,
}
{
scopeType:
{
Description: Scope type. ,
Enum:
{
Datacenter: Enum for Datacenter. ,
AzureResourceGraphQuery: Enum for ARG. ,
}
,
Required: True ,
}
enum ,
azureResourceGraphQuery:
{
Description: ARG query. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_Get (new)
Description :  Get a BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
settings:
{
Description: Business case settings. ,
Required: False ,
}
{
azureSettings:
{
Description: Azure settings for a business case. ,
Required: True ,
}
{
targetLocation:
{
Description: Gets or sets azure location. ,
Required: True ,
}
string ,
discountPercentage:
{
Description: Gets azure Discount percentage. ,
Format: float ,
Required: False ,
}
number ,
currency:
{
Description: Business case Currency. ,
Enum:
{
Unknown: Currency Unknown. ,
USD: Currency USD. ,
DKK: Currency DKK. ,
CAD: Currency CAD. ,
IDR: Currency IDR. ,
JPY: Currency JPY. ,
KRW: Currency KRW. ,
NZD: Currency NZD. ,
NOK: Currency NOK. ,
RUB: Currency RUB. ,
SAR: Currency SAR. ,
ZAR: Currency ZAR. ,
SEK: Currency SEK. ,
TRY: Currency TRY. ,
GBP: Currency GBP. ,
MXN: Currency MXN. ,
MYR: Currency MYR. ,
INR: Currency INR. ,
HKD: Currency HKD. ,
BRL: Currency BRL. ,
TWD: Currency TWD. ,
EUR: Currency EUR. ,
CHF: Currency CHF. ,
ARS: Currency ARS. ,
AUD: Currency AUD. ,
CNY: Currency CNY. ,
}
,
Required: True ,
}
enum ,
businessCaseType:
{
Description: Migration Strategy. ,
Enum:
{
Unknown: Unknown Migration Strategy. ,
OptimizeForCost: Optimize for cost. ,
IaaSOnly: IaaS only. ,
OptimizeForPaas: Optimize for PaaS. ,
AVSOnly: Avs only. ,
}
,
Required: False ,
}
enum ,
workloadDiscoverySource:
{
Description: Workload discovery source. ,
Enum:
{
Unknown: Unknown Discovery Source. ,
Appliance: Appliance Discovery Source. ,
Import: Import Discovery Source. ,
}
,
Required: False ,
}
enum ,
performanceDataStartTime:
{
Description: Gets start time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
performanceDataEndTime:
{
Description: Gets end time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
comfortFactor:
{
Description: Gets comfort factor. ,
Format: float ,
Required: False ,
}
number ,
performanceUtilizationPercentile:
{
Description: Gets utilization percentile for performance. ,
Format: float ,
Required: False ,
}
number ,
perYearMigrationCompletionPercentage:
{
Description: Gets migration completion percentage per year. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
infrastructureGrowthRate:
{
Description: Gets infrastructure growth rate. ,
Format: float ,
Required: False ,
}
number ,
wacc:
{
Description: Gets wACC percentage. ,
Format: float ,
Required: False ,
}
number ,
networkCostPercentage:
{
Description: Gets network cost percentage. ,
Format: float ,
Required: False ,
}
number ,
iaasLaborCostPercentage:
{
Description: Gets IaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
paasLaborCostPercentage:
{
Description: Gets PaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
avsLaborCostPercentage:
{
Description: Gets Avs labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
savingsOption:
{
Description: Gets the business case savings option type. ,
Enum:
{
Unknown: Unknown Savings Option. ,
RI3Year: Reserved Instance 3 Year. ,
SavingsPlan3Year: Azure Savings Plan 3 Year. ,
}
,
Required: False ,
}
enum ,
}
,
onPremiseSettings:
{
Description: On-premise settings. ,
Required: False ,
}
{
computeSettings:
{
Description: Compute settings. ,
Required: True ,
}
{
hyperthreadCoreToMemoryRatio:
{
Description: Hyperthread core to memory ratio. ,
Format: float ,
Required: True ,
}
number ,
price:
{
Description: Compute Price. ,
Format: float ,
Required: True ,
}
number ,
computeHardwareMaintenanceCost:
{
Description: Compute Hardware Maintenance Cost. ,
Format: float ,
Required: True ,
}
number ,
vmOversubscriptionRatio:
{
Description: VM Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
cpuOversubscriptionRatio:
{
Description: CPU Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
sqlServerLicensing:
{
Description: SQL Server licensing settings. ,
Required: True ,
}
[
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: Unknown Sql Server License. ,
Enterprise: Enterprise Sql Server License. ,
Standard: Standard Sql Server License. ,
}
,
Required: True ,
}
enum ,
licenseCost:
{
Description: Licence cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
windowsServerLicensing:
{
Description: Windows Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
licensesPerCore:
{
Description: Licenses per core. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rhelLinuxServerLicensing:
{
Description: Linux Rhel Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
suseLinuxServerLicensing:
{
Description: Linux Suse Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
virtualizationSoftwareSettings:
{
Description: Virtualization software settings. ,
Required: True ,
}
{
vMwareCloudFoundationLicenseCost:
{
Description: VMware cloud foundation license cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
storageSettings:
{
Description: Storage settings. ,
Required: True ,
}
{
costPerGbPerYear:
{
Description: Cost per gigabyte per year. ,
Format: float ,
Required: True ,
}
number ,
maintainanceCostPercentageToAcquisitionCost:
{
Description: Maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
}
,
networkSettings:
{
Description: Network settings. ,
Required: True ,
}
{
maintenanceCostPercentage:
{
Description: Network maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
physicalServersPerCabinet:
{
Description: Number of physical servers per cabinet ,
Format: int32 ,
Required: True ,
}
integer ,
averageCostPerCabinet:
{
Description: Average cost per cabinet ,
Format: float ,
Required: True ,
}
number ,
}
,
facilitySettings:
{
Description: Facility settings. ,
Required: True ,
}
{
facilitiesCostPerKwh:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
powerUtilizationEfficiency:
{
Description: Power utilization Efficiency. ,
Format: float ,
Required: True ,
}
number ,
}
,
laborSettings:
{
Description: Labour settings. ,
Required: True ,
}
{
physicalServersPerAdmin:
{
Description: Physical servers per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
virtualMachinesPerAdmin:
{
Description: Virtual machines per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
hourlyAdminCost:
{
Description: Hourly administrator cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
securitySettings:
{
Description: Security settings. ,
Required: True ,
}
{
serverSecurityCostPerServerPerYear:
{
Description: Physical servers per administrator. ,
Format: float ,
Required: True ,
}
number ,
sqlServerSecurityCostPerServerPerYear:
{
Description: Virtual machines per administrator. ,
Format: float ,
Required: True ,
}
number ,
}
,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
hypervVirtualizationManagementSettings:
{
Description: HyperV Virtualization Management Settings. ,
Required: True ,
}
{
numberOfPhysicalCoresPerLicense:
{
Description: Number of physical cores per licence. ,
Format: int32 ,
Required: True ,
}
integer ,
softwareAssuranceCost:
{
Description: Software Assurance Cost. ,
Format: float ,
Required: True ,
}
number ,
licenseAndSupportList:
{
Description: Licence and support list. ,
Required: True ,
}
[
{
licenseCost:
{
Description: Cost of a licence. ,
Format: float ,
Required: True ,
}
number ,
licenseType:
{
Description: HyperV licence type. ,
Enum:
{
Unknown: Unknown HyperV License. ,
Datacentre: Datacentre HyperV License. ,
Standard: Standard HyperV License. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
thirdPartyManagementSettings:
{
Description: Third Party Management Settings. ,
Required: True ,
}
{
licenseCost:
{
Description: License Cost. ,
Format: float ,
Required: True ,
}
number ,
supportCost:
{
Description: Support Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
otherManagementCostsSettings:
{
Description: Other Management Costs Settings. ,
Required: True ,
}
{
monitoringCostPerServerPerYear:
{
Description: Monitoring Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
patchingCostPerServerPerYear:
{
Description: Patching Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
dataProtectionCostPerServerPerYear:
{
Description: Data Protection Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
azureArcSettings:
{
Description: Azure arc settings. ,
Required: False ,
}
{
azureArcState:
{
Description: AzureArc state indicates whether to include azure arc related costs in on-premises or not. ,
Enum:
{
Disabled: AzureArc state disabled. ,
Enabled: AzureArc state enabled. ,
Unknown: AzureArc state unknown. ,
}
,
Required: True ,
}
enum ,
laborCostPercentage:
{
Description: Gets Azure arc labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Gets the azure arc monitoring settings. ,
Required: True ,
}
{
logsVolumeInGB:
{
Description: Logs volume settings. ,
Format: float ,
Required: True ,
}
number ,
alertRulesCount:
{
Description: Number of alert rules settings. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
state:
{
Description: Business case state. ,
Enum:
{
Unknown: Unknown State. ,
InProgress: InProgress State. ,
Completed: Completed State. ,
OutDated: OutDated State. ,
Invalid: Invalid State. ,
OutOfSync: OutOfSync State. ,
Failed: Failed State. ,
}
,
Required: False ,
}
enum ,
reportStatusDetails:
{
Description: Gets the state of business case reports. ,
Required: False ,
}
[
{
reportType:
{
Description: Report type. ,
Enum:
{
Unknown: Unknown Report Type. ,
Excel: Excel Report Type. ,
}
,
Required: False ,
}
enum ,
reportStatus:
{
Description: Report status. ,
Enum:
{
Unknown: Unknown Report Status. ,
None: None Report Status. ,
InProgress: InProgress Report Status. ,
Failed: Failed Report Status. ,
Completed: Completed Report Status. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
businessCaseScope:
{
Description: Gets the business case scope. ,
Required: False ,
}
{
scopeType:
{
Description: Scope type. ,
Enum:
{
Datacenter: Enum for Datacenter. ,
AzureResourceGraphQuery: Enum for ARG. ,
}
,
Required: True ,
}
enum ,
azureResourceGraphQuery:
{
Description: ARG query. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_Create (new)
Description :  Create a BusinessCase
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
settings:
{
Description: Business case settings. ,
Required: False ,
}
{
azureSettings:
{
Description: Azure settings for a business case. ,
Required: True ,
}
{
targetLocation:
{
Description: Gets or sets azure location. ,
Required: True ,
}
string ,
discountPercentage:
{
Description: Gets azure Discount percentage. ,
Format: float ,
Required: False ,
}
number ,
currency:
{
Description: Business case Currency. ,
Enum:
{
Unknown: Currency Unknown. ,
USD: Currency USD. ,
DKK: Currency DKK. ,
CAD: Currency CAD. ,
IDR: Currency IDR. ,
JPY: Currency JPY. ,
KRW: Currency KRW. ,
NZD: Currency NZD. ,
NOK: Currency NOK. ,
RUB: Currency RUB. ,
SAR: Currency SAR. ,
ZAR: Currency ZAR. ,
SEK: Currency SEK. ,
TRY: Currency TRY. ,
GBP: Currency GBP. ,
MXN: Currency MXN. ,
MYR: Currency MYR. ,
INR: Currency INR. ,
HKD: Currency HKD. ,
BRL: Currency BRL. ,
TWD: Currency TWD. ,
EUR: Currency EUR. ,
CHF: Currency CHF. ,
ARS: Currency ARS. ,
AUD: Currency AUD. ,
CNY: Currency CNY. ,
}
,
Required: True ,
}
enum ,
businessCaseType:
{
Description: Migration Strategy. ,
Enum:
{
Unknown: Unknown Migration Strategy. ,
OptimizeForCost: Optimize for cost. ,
IaaSOnly: IaaS only. ,
OptimizeForPaas: Optimize for PaaS. ,
AVSOnly: Avs only. ,
}
,
Required: False ,
}
enum ,
workloadDiscoverySource:
{
Description: Workload discovery source. ,
Enum:
{
Unknown: Unknown Discovery Source. ,
Appliance: Appliance Discovery Source. ,
Import: Import Discovery Source. ,
}
,
Required: False ,
}
enum ,
performanceDataStartTime:
{
Description: Gets start time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
performanceDataEndTime:
{
Description: Gets end time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
comfortFactor:
{
Description: Gets comfort factor. ,
Format: float ,
Required: False ,
}
number ,
performanceUtilizationPercentile:
{
Description: Gets utilization percentile for performance. ,
Format: float ,
Required: False ,
}
number ,
perYearMigrationCompletionPercentage:
{
Description: Gets migration completion percentage per year. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
infrastructureGrowthRate:
{
Description: Gets infrastructure growth rate. ,
Format: float ,
Required: False ,
}
number ,
wacc:
{
Description: Gets wACC percentage. ,
Format: float ,
Required: False ,
}
number ,
networkCostPercentage:
{
Description: Gets network cost percentage. ,
Format: float ,
Required: False ,
}
number ,
iaasLaborCostPercentage:
{
Description: Gets IaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
paasLaborCostPercentage:
{
Description: Gets PaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
avsLaborCostPercentage:
{
Description: Gets Avs labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
savingsOption:
{
Description: Gets the business case savings option type. ,
Enum:
{
Unknown: Unknown Savings Option. ,
RI3Year: Reserved Instance 3 Year. ,
SavingsPlan3Year: Azure Savings Plan 3 Year. ,
}
,
Required: False ,
}
enum ,
}
,
onPremiseSettings:
{
Description: On-premise settings. ,
Required: False ,
}
{
computeSettings:
{
Description: Compute settings. ,
Required: True ,
}
{
hyperthreadCoreToMemoryRatio:
{
Description: Hyperthread core to memory ratio. ,
Format: float ,
Required: True ,
}
number ,
price:
{
Description: Compute Price. ,
Format: float ,
Required: True ,
}
number ,
computeHardwareMaintenanceCost:
{
Description: Compute Hardware Maintenance Cost. ,
Format: float ,
Required: True ,
}
number ,
vmOversubscriptionRatio:
{
Description: VM Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
cpuOversubscriptionRatio:
{
Description: CPU Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
sqlServerLicensing:
{
Description: SQL Server licensing settings. ,
Required: True ,
}
[
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: Unknown Sql Server License. ,
Enterprise: Enterprise Sql Server License. ,
Standard: Standard Sql Server License. ,
}
,
Required: True ,
}
enum ,
licenseCost:
{
Description: Licence cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
windowsServerLicensing:
{
Description: Windows Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
licensesPerCore:
{
Description: Licenses per core. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rhelLinuxServerLicensing:
{
Description: Linux Rhel Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
suseLinuxServerLicensing:
{
Description: Linux Suse Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
virtualizationSoftwareSettings:
{
Description: Virtualization software settings. ,
Required: True ,
}
{
vMwareCloudFoundationLicenseCost:
{
Description: VMware cloud foundation license cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
storageSettings:
{
Description: Storage settings. ,
Required: True ,
}
{
costPerGbPerYear:
{
Description: Cost per gigabyte per year. ,
Format: float ,
Required: True ,
}
number ,
maintainanceCostPercentageToAcquisitionCost:
{
Description: Maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
}
,
networkSettings:
{
Description: Network settings. ,
Required: True ,
}
{
maintenanceCostPercentage:
{
Description: Network maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
physicalServersPerCabinet:
{
Description: Number of physical servers per cabinet ,
Format: int32 ,
Required: True ,
}
integer ,
averageCostPerCabinet:
{
Description: Average cost per cabinet ,
Format: float ,
Required: True ,
}
number ,
}
,
facilitySettings:
{
Description: Facility settings. ,
Required: True ,
}
{
facilitiesCostPerKwh:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
powerUtilizationEfficiency:
{
Description: Power utilization Efficiency. ,
Format: float ,
Required: True ,
}
number ,
}
,
laborSettings:
{
Description: Labour settings. ,
Required: True ,
}
{
physicalServersPerAdmin:
{
Description: Physical servers per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
virtualMachinesPerAdmin:
{
Description: Virtual machines per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
hourlyAdminCost:
{
Description: Hourly administrator cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
securitySettings:
{
Description: Security settings. ,
Required: True ,
}
{
serverSecurityCostPerServerPerYear:
{
Description: Physical servers per administrator. ,
Format: float ,
Required: True ,
}
number ,
sqlServerSecurityCostPerServerPerYear:
{
Description: Virtual machines per administrator. ,
Format: float ,
Required: True ,
}
number ,
}
,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
hypervVirtualizationManagementSettings:
{
Description: HyperV Virtualization Management Settings. ,
Required: True ,
}
{
numberOfPhysicalCoresPerLicense:
{
Description: Number of physical cores per licence. ,
Format: int32 ,
Required: True ,
}
integer ,
softwareAssuranceCost:
{
Description: Software Assurance Cost. ,
Format: float ,
Required: True ,
}
number ,
licenseAndSupportList:
{
Description: Licence and support list. ,
Required: True ,
}
[
{
licenseCost:
{
Description: Cost of a licence. ,
Format: float ,
Required: True ,
}
number ,
licenseType:
{
Description: HyperV licence type. ,
Enum:
{
Unknown: Unknown HyperV License. ,
Datacentre: Datacentre HyperV License. ,
Standard: Standard HyperV License. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
thirdPartyManagementSettings:
{
Description: Third Party Management Settings. ,
Required: True ,
}
{
licenseCost:
{
Description: License Cost. ,
Format: float ,
Required: True ,
}
number ,
supportCost:
{
Description: Support Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
otherManagementCostsSettings:
{
Description: Other Management Costs Settings. ,
Required: True ,
}
{
monitoringCostPerServerPerYear:
{
Description: Monitoring Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
patchingCostPerServerPerYear:
{
Description: Patching Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
dataProtectionCostPerServerPerYear:
{
Description: Data Protection Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
azureArcSettings:
{
Description: Azure arc settings. ,
Required: False ,
}
{
azureArcState:
{
Description: AzureArc state indicates whether to include azure arc related costs in on-premises or not. ,
Enum:
{
Disabled: AzureArc state disabled. ,
Enabled: AzureArc state enabled. ,
Unknown: AzureArc state unknown. ,
}
,
Required: True ,
}
enum ,
laborCostPercentage:
{
Description: Gets Azure arc labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Gets the azure arc monitoring settings. ,
Required: True ,
}
{
logsVolumeInGB:
{
Description: Logs volume settings. ,
Format: float ,
Required: True ,
}
number ,
alertRulesCount:
{
Description: Number of alert rules settings. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
state:
{
Description: Business case state. ,
Enum:
{
Unknown: Unknown State. ,
InProgress: InProgress State. ,
Completed: Completed State. ,
OutDated: OutDated State. ,
Invalid: Invalid State. ,
OutOfSync: OutOfSync State. ,
Failed: Failed State. ,
}
,
Required: False ,
}
enum ,
reportStatusDetails:
{
Description: Gets the state of business case reports. ,
Required: False ,
}
[
{
reportType:
{
Description: Report type. ,
Enum:
{
Unknown: Unknown Report Type. ,
Excel: Excel Report Type. ,
}
,
Required: False ,
}
enum ,
reportStatus:
{
Description: Report status. ,
Enum:
{
Unknown: Unknown Report Status. ,
None: None Report Status. ,
InProgress: InProgress Report Status. ,
Failed: Failed Report Status. ,
Completed: Completed Report Status. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
businessCaseScope:
{
Description: Gets the business case scope. ,
Required: False ,
}
{
scopeType:
{
Description: Scope type. ,
Enum:
{
Datacenter: Enum for Datacenter. ,
AzureResourceGraphQuery: Enum for ARG. ,
}
,
Required: True ,
}
enum ,
azureResourceGraphQuery:
{
Description: ARG query. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
settings:
{
Description: Business case settings. ,
Required: False ,
}
{
azureSettings:
{
Description: Azure settings for a business case. ,
Required: True ,
}
{
targetLocation:
{
Description: Gets or sets azure location. ,
Required: True ,
}
string ,
discountPercentage:
{
Description: Gets azure Discount percentage. ,
Format: float ,
Required: False ,
}
number ,
currency:
{
Description: Business case Currency. ,
Enum:
{
Unknown: Currency Unknown. ,
USD: Currency USD. ,
DKK: Currency DKK. ,
CAD: Currency CAD. ,
IDR: Currency IDR. ,
JPY: Currency JPY. ,
KRW: Currency KRW. ,
NZD: Currency NZD. ,
NOK: Currency NOK. ,
RUB: Currency RUB. ,
SAR: Currency SAR. ,
ZAR: Currency ZAR. ,
SEK: Currency SEK. ,
TRY: Currency TRY. ,
GBP: Currency GBP. ,
MXN: Currency MXN. ,
MYR: Currency MYR. ,
INR: Currency INR. ,
HKD: Currency HKD. ,
BRL: Currency BRL. ,
TWD: Currency TWD. ,
EUR: Currency EUR. ,
CHF: Currency CHF. ,
ARS: Currency ARS. ,
AUD: Currency AUD. ,
CNY: Currency CNY. ,
}
,
Required: True ,
}
enum ,
businessCaseType:
{
Description: Migration Strategy. ,
Enum:
{
Unknown: Unknown Migration Strategy. ,
OptimizeForCost: Optimize for cost. ,
IaaSOnly: IaaS only. ,
OptimizeForPaas: Optimize for PaaS. ,
AVSOnly: Avs only. ,
}
,
Required: False ,
}
enum ,
workloadDiscoverySource:
{
Description: Workload discovery source. ,
Enum:
{
Unknown: Unknown Discovery Source. ,
Appliance: Appliance Discovery Source. ,
Import: Import Discovery Source. ,
}
,
Required: False ,
}
enum ,
performanceDataStartTime:
{
Description: Gets start time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
performanceDataEndTime:
{
Description: Gets end time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
comfortFactor:
{
Description: Gets comfort factor. ,
Format: float ,
Required: False ,
}
number ,
performanceUtilizationPercentile:
{
Description: Gets utilization percentile for performance. ,
Format: float ,
Required: False ,
}
number ,
perYearMigrationCompletionPercentage:
{
Description: Gets migration completion percentage per year. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
infrastructureGrowthRate:
{
Description: Gets infrastructure growth rate. ,
Format: float ,
Required: False ,
}
number ,
wacc:
{
Description: Gets wACC percentage. ,
Format: float ,
Required: False ,
}
number ,
networkCostPercentage:
{
Description: Gets network cost percentage. ,
Format: float ,
Required: False ,
}
number ,
iaasLaborCostPercentage:
{
Description: Gets IaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
paasLaborCostPercentage:
{
Description: Gets PaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
avsLaborCostPercentage:
{
Description: Gets Avs labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
savingsOption:
{
Description: Gets the business case savings option type. ,
Enum:
{
Unknown: Unknown Savings Option. ,
RI3Year: Reserved Instance 3 Year. ,
SavingsPlan3Year: Azure Savings Plan 3 Year. ,
}
,
Required: False ,
}
enum ,
}
,
onPremiseSettings:
{
Description: On-premise settings. ,
Required: False ,
}
{
computeSettings:
{
Description: Compute settings. ,
Required: True ,
}
{
hyperthreadCoreToMemoryRatio:
{
Description: Hyperthread core to memory ratio. ,
Format: float ,
Required: True ,
}
number ,
price:
{
Description: Compute Price. ,
Format: float ,
Required: True ,
}
number ,
computeHardwareMaintenanceCost:
{
Description: Compute Hardware Maintenance Cost. ,
Format: float ,
Required: True ,
}
number ,
vmOversubscriptionRatio:
{
Description: VM Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
cpuOversubscriptionRatio:
{
Description: CPU Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
sqlServerLicensing:
{
Description: SQL Server licensing settings. ,
Required: True ,
}
[
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: Unknown Sql Server License. ,
Enterprise: Enterprise Sql Server License. ,
Standard: Standard Sql Server License. ,
}
,
Required: True ,
}
enum ,
licenseCost:
{
Description: Licence cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
windowsServerLicensing:
{
Description: Windows Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
licensesPerCore:
{
Description: Licenses per core. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rhelLinuxServerLicensing:
{
Description: Linux Rhel Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
suseLinuxServerLicensing:
{
Description: Linux Suse Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
virtualizationSoftwareSettings:
{
Description: Virtualization software settings. ,
Required: True ,
}
{
vMwareCloudFoundationLicenseCost:
{
Description: VMware cloud foundation license cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
storageSettings:
{
Description: Storage settings. ,
Required: True ,
}
{
costPerGbPerYear:
{
Description: Cost per gigabyte per year. ,
Format: float ,
Required: True ,
}
number ,
maintainanceCostPercentageToAcquisitionCost:
{
Description: Maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
}
,
networkSettings:
{
Description: Network settings. ,
Required: True ,
}
{
maintenanceCostPercentage:
{
Description: Network maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
physicalServersPerCabinet:
{
Description: Number of physical servers per cabinet ,
Format: int32 ,
Required: True ,
}
integer ,
averageCostPerCabinet:
{
Description: Average cost per cabinet ,
Format: float ,
Required: True ,
}
number ,
}
,
facilitySettings:
{
Description: Facility settings. ,
Required: True ,
}
{
facilitiesCostPerKwh:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
powerUtilizationEfficiency:
{
Description: Power utilization Efficiency. ,
Format: float ,
Required: True ,
}
number ,
}
,
laborSettings:
{
Description: Labour settings. ,
Required: True ,
}
{
physicalServersPerAdmin:
{
Description: Physical servers per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
virtualMachinesPerAdmin:
{
Description: Virtual machines per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
hourlyAdminCost:
{
Description: Hourly administrator cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
securitySettings:
{
Description: Security settings. ,
Required: True ,
}
{
serverSecurityCostPerServerPerYear:
{
Description: Physical servers per administrator. ,
Format: float ,
Required: True ,
}
number ,
sqlServerSecurityCostPerServerPerYear:
{
Description: Virtual machines per administrator. ,
Format: float ,
Required: True ,
}
number ,
}
,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
hypervVirtualizationManagementSettings:
{
Description: HyperV Virtualization Management Settings. ,
Required: True ,
}
{
numberOfPhysicalCoresPerLicense:
{
Description: Number of physical cores per licence. ,
Format: int32 ,
Required: True ,
}
integer ,
softwareAssuranceCost:
{
Description: Software Assurance Cost. ,
Format: float ,
Required: True ,
}
number ,
licenseAndSupportList:
{
Description: Licence and support list. ,
Required: True ,
}
[
{
licenseCost:
{
Description: Cost of a licence. ,
Format: float ,
Required: True ,
}
number ,
licenseType:
{
Description: HyperV licence type. ,
Enum:
{
Unknown: Unknown HyperV License. ,
Datacentre: Datacentre HyperV License. ,
Standard: Standard HyperV License. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
thirdPartyManagementSettings:
{
Description: Third Party Management Settings. ,
Required: True ,
}
{
licenseCost:
{
Description: License Cost. ,
Format: float ,
Required: True ,
}
number ,
supportCost:
{
Description: Support Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
otherManagementCostsSettings:
{
Description: Other Management Costs Settings. ,
Required: True ,
}
{
monitoringCostPerServerPerYear:
{
Description: Monitoring Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
patchingCostPerServerPerYear:
{
Description: Patching Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
dataProtectionCostPerServerPerYear:
{
Description: Data Protection Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
azureArcSettings:
{
Description: Azure arc settings. ,
Required: False ,
}
{
azureArcState:
{
Description: AzureArc state indicates whether to include azure arc related costs in on-premises or not. ,
Enum:
{
Disabled: AzureArc state disabled. ,
Enabled: AzureArc state enabled. ,
Unknown: AzureArc state unknown. ,
}
,
Required: True ,
}
enum ,
laborCostPercentage:
{
Description: Gets Azure arc labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Gets the azure arc monitoring settings. ,
Required: True ,
}
{
logsVolumeInGB:
{
Description: Logs volume settings. ,
Format: float ,
Required: True ,
}
number ,
alertRulesCount:
{
Description: Number of alert rules settings. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
state:
{
Description: Business case state. ,
Enum:
{
Unknown: Unknown State. ,
InProgress: InProgress State. ,
Completed: Completed State. ,
OutDated: OutDated State. ,
Invalid: Invalid State. ,
OutOfSync: OutOfSync State. ,
Failed: Failed State. ,
}
,
Required: False ,
}
enum ,
reportStatusDetails:
{
Description: Gets the state of business case reports. ,
Required: False ,
}
[
{
reportType:
{
Description: Report type. ,
Enum:
{
Unknown: Unknown Report Type. ,
Excel: Excel Report Type. ,
}
,
Required: False ,
}
enum ,
reportStatus:
{
Description: Report status. ,
Enum:
{
Unknown: Unknown Report Status. ,
None: None Report Status. ,
InProgress: InProgress Report Status. ,
Failed: Failed Report Status. ,
Completed: Completed Report Status. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
businessCaseScope:
{
Description: Gets the business case scope. ,
Required: False ,
}
{
scopeType:
{
Description: Scope type. ,
Enum:
{
Datacenter: Enum for Datacenter. ,
AzureResourceGraphQuery: Enum for ARG. ,
}
,
Required: True ,
}
enum ,
azureResourceGraphQuery:
{
Description: ARG query. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Business case resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
settings:
{
Description: Business case settings. ,
Required: False ,
}
{
azureSettings:
{
Description: Azure settings for a business case. ,
Required: True ,
}
{
targetLocation:
{
Description: Gets or sets azure location. ,
Required: True ,
}
string ,
discountPercentage:
{
Description: Gets azure Discount percentage. ,
Format: float ,
Required: False ,
}
number ,
currency:
{
Description: Business case Currency. ,
Enum:
{
Unknown: Currency Unknown. ,
USD: Currency USD. ,
DKK: Currency DKK. ,
CAD: Currency CAD. ,
IDR: Currency IDR. ,
JPY: Currency JPY. ,
KRW: Currency KRW. ,
NZD: Currency NZD. ,
NOK: Currency NOK. ,
RUB: Currency RUB. ,
SAR: Currency SAR. ,
ZAR: Currency ZAR. ,
SEK: Currency SEK. ,
TRY: Currency TRY. ,
GBP: Currency GBP. ,
MXN: Currency MXN. ,
MYR: Currency MYR. ,
INR: Currency INR. ,
HKD: Currency HKD. ,
BRL: Currency BRL. ,
TWD: Currency TWD. ,
EUR: Currency EUR. ,
CHF: Currency CHF. ,
ARS: Currency ARS. ,
AUD: Currency AUD. ,
CNY: Currency CNY. ,
}
,
Required: True ,
}
enum ,
businessCaseType:
{
Description: Migration Strategy. ,
Enum:
{
Unknown: Unknown Migration Strategy. ,
OptimizeForCost: Optimize for cost. ,
IaaSOnly: IaaS only. ,
OptimizeForPaas: Optimize for PaaS. ,
AVSOnly: Avs only. ,
}
,
Required: False ,
}
enum ,
workloadDiscoverySource:
{
Description: Workload discovery source. ,
Enum:
{
Unknown: Unknown Discovery Source. ,
Appliance: Appliance Discovery Source. ,
Import: Import Discovery Source. ,
}
,
Required: False ,
}
enum ,
performanceDataStartTime:
{
Description: Gets start time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
performanceDataEndTime:
{
Description: Gets end time to use for performance. ,
Format: date-time ,
Required: False ,
}
string ,
comfortFactor:
{
Description: Gets comfort factor. ,
Format: float ,
Required: False ,
}
number ,
performanceUtilizationPercentile:
{
Description: Gets utilization percentile for performance. ,
Format: float ,
Required: False ,
}
number ,
perYearMigrationCompletionPercentage:
{
Description: Gets migration completion percentage per year. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
infrastructureGrowthRate:
{
Description: Gets infrastructure growth rate. ,
Format: float ,
Required: False ,
}
number ,
wacc:
{
Description: Gets wACC percentage. ,
Format: float ,
Required: False ,
}
number ,
networkCostPercentage:
{
Description: Gets network cost percentage. ,
Format: float ,
Required: False ,
}
number ,
iaasLaborCostPercentage:
{
Description: Gets IaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
paasLaborCostPercentage:
{
Description: Gets PaaS labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
avsLaborCostPercentage:
{
Description: Gets Avs labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
savingsOption:
{
Description: Gets the business case savings option type. ,
Enum:
{
Unknown: Unknown Savings Option. ,
RI3Year: Reserved Instance 3 Year. ,
SavingsPlan3Year: Azure Savings Plan 3 Year. ,
}
,
Required: False ,
}
enum ,
}
,
onPremiseSettings:
{
Description: On-premise settings. ,
Required: False ,
}
{
computeSettings:
{
Description: Compute settings. ,
Required: True ,
}
{
hyperthreadCoreToMemoryRatio:
{
Description: Hyperthread core to memory ratio. ,
Format: float ,
Required: True ,
}
number ,
price:
{
Description: Compute Price. ,
Format: float ,
Required: True ,
}
number ,
computeHardwareMaintenanceCost:
{
Description: Compute Hardware Maintenance Cost. ,
Format: float ,
Required: True ,
}
number ,
vmOversubscriptionRatio:
{
Description: VM Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
cpuOversubscriptionRatio:
{
Description: CPU Oversubscription Ratio. ,
Format: float ,
Required: True ,
}
number ,
sqlServerLicensing:
{
Description: SQL Server licensing settings. ,
Required: True ,
}
[
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: Unknown Sql Server License. ,
Enterprise: Enterprise Sql Server License. ,
Standard: Standard Sql Server License. ,
}
,
Required: True ,
}
enum ,
licenseCost:
{
Description: Licence cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
windowsServerLicensing:
{
Description: Windows Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
softwareAssuranceCost:
{
Description: Software assurance (SA) cost. ,
Format: float ,
Required: True ,
}
number ,
licensesPerCore:
{
Description: Licenses per core. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rhelLinuxServerLicensing:
{
Description: Linux Rhel Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
suseLinuxServerLicensing:
{
Description: Linux Suse Server licensing settings. ,
Required: True ,
}
{
licenseCost:
{
Description: Licence Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
virtualizationSoftwareSettings:
{
Description: Virtualization software settings. ,
Required: True ,
}
{
vMwareCloudFoundationLicenseCost:
{
Description: VMware cloud foundation license cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
storageSettings:
{
Description: Storage settings. ,
Required: True ,
}
{
costPerGbPerYear:
{
Description: Cost per gigabyte per year. ,
Format: float ,
Required: True ,
}
number ,
maintainanceCostPercentageToAcquisitionCost:
{
Description: Maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
}
,
networkSettings:
{
Description: Network settings. ,
Required: True ,
}
{
maintenanceCostPercentage:
{
Description: Network maintenance cost percentage. ,
Format: float ,
Required: True ,
}
number ,
physicalServersPerCabinet:
{
Description: Number of physical servers per cabinet ,
Format: int32 ,
Required: True ,
}
integer ,
averageCostPerCabinet:
{
Description: Average cost per cabinet ,
Format: float ,
Required: True ,
}
number ,
}
,
facilitySettings:
{
Description: Facility settings. ,
Required: True ,
}
{
facilitiesCostPerKwh:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
powerUtilizationEfficiency:
{
Description: Power utilization Efficiency. ,
Format: float ,
Required: True ,
}
number ,
}
,
laborSettings:
{
Description: Labour settings. ,
Required: True ,
}
{
physicalServersPerAdmin:
{
Description: Physical servers per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
virtualMachinesPerAdmin:
{
Description: Virtual machines per administrator. ,
Format: int32 ,
Required: True ,
}
integer ,
hourlyAdminCost:
{
Description: Hourly administrator cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
securitySettings:
{
Description: Security settings. ,
Required: True ,
}
{
serverSecurityCostPerServerPerYear:
{
Description: Physical servers per administrator. ,
Format: float ,
Required: True ,
}
number ,
sqlServerSecurityCostPerServerPerYear:
{
Description: Virtual machines per administrator. ,
Format: float ,
Required: True ,
}
number ,
}
,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
hypervVirtualizationManagementSettings:
{
Description: HyperV Virtualization Management Settings. ,
Required: True ,
}
{
numberOfPhysicalCoresPerLicense:
{
Description: Number of physical cores per licence. ,
Format: int32 ,
Required: True ,
}
integer ,
softwareAssuranceCost:
{
Description: Software Assurance Cost. ,
Format: float ,
Required: True ,
}
number ,
licenseAndSupportList:
{
Description: Licence and support list. ,
Required: True ,
}
[
{
licenseCost:
{
Description: Cost of a licence. ,
Format: float ,
Required: True ,
}
number ,
licenseType:
{
Description: HyperV licence type. ,
Enum:
{
Unknown: Unknown HyperV License. ,
Datacentre: Datacentre HyperV License. ,
Standard: Standard HyperV License. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
thirdPartyManagementSettings:
{
Description: Third Party Management Settings. ,
Required: True ,
}
{
licenseCost:
{
Description: License Cost. ,
Format: float ,
Required: True ,
}
number ,
supportCost:
{
Description: Support Cost. ,
Format: float ,
Required: True ,
}
number ,
}
,
otherManagementCostsSettings:
{
Description: Other Management Costs Settings. ,
Required: True ,
}
{
monitoringCostPerServerPerYear:
{
Description: Monitoring Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
patchingCostPerServerPerYear:
{
Description: Patching Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
dataProtectionCostPerServerPerYear:
{
Description: Data Protection Cost Per Server Per Year. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
azureArcSettings:
{
Description: Azure arc settings. ,
Required: False ,
}
{
azureArcState:
{
Description: AzureArc state indicates whether to include azure arc related costs in on-premises or not. ,
Enum:
{
Disabled: AzureArc state disabled. ,
Enabled: AzureArc state enabled. ,
Unknown: AzureArc state unknown. ,
}
,
Required: True ,
}
enum ,
laborCostPercentage:
{
Description: Gets Azure arc labour cost percentage. ,
Format: float ,
Required: False ,
}
number ,
managementSettings:
{
Description: Management settings. ,
Required: False ,
}
{
monitoringSettings:
{
Description: Gets the azure arc monitoring settings. ,
Required: True ,
}
{
logsVolumeInGB:
{
Description: Logs volume settings. ,
Format: float ,
Required: True ,
}
number ,
alertRulesCount:
{
Description: Number of alert rules settings. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
state:
{
Description: Business case state. ,
Enum:
{
Unknown: Unknown State. ,
InProgress: InProgress State. ,
Completed: Completed State. ,
OutDated: OutDated State. ,
Invalid: Invalid State. ,
OutOfSync: OutOfSync State. ,
Failed: Failed State. ,
}
,
Required: False ,
}
enum ,
reportStatusDetails:
{
Description: Gets the state of business case reports. ,
Required: False ,
}
[
{
reportType:
{
Description: Report type. ,
Enum:
{
Unknown: Unknown Report Type. ,
Excel: Excel Report Type. ,
}
,
Required: False ,
}
enum ,
reportStatus:
{
Description: Report status. ,
Enum:
{
Unknown: Unknown Report Status. ,
None: None Report Status. ,
InProgress: InProgress Report Status. ,
Failed: Failed Report Status. ,
Completed: Completed Report Status. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
businessCaseScope:
{
Description: Gets the business case scope. ,
Required: False ,
}
{
scopeType:
{
Description: Scope type. ,
Enum:
{
Datacenter: Enum for Datacenter. ,
AzureResourceGraphQuery: Enum for ARG. ,
}
,
Required: True ,
}
enum ,
azureResourceGraphQuery:
{
Description: ARG query. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_Delete (new)
Description :  Delete a BusinessCase
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseAvsSummaryOperations_ListByParent (new)
Description :  List AvsSummary resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azureAvsSummary:
{
Description: The Azure Avs summary. ,
Required: False ,
}
{
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
avsNodeSummary:
{
Description: Avs virtual machine summary. ,
Required: False ,
}
{
serversSuitableForMigration:
{
Description: Servers suitable for migration. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfServers:
{
Description: The total number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The total number of Avs VM cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGb:
{
Description: The total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
avsNodeCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedAvsNodeTypeSummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
avsNodeType:
{
Description: AVS node type. ,
Required: False ,
}
string ,
numberOfNodes:
{
Description: Number of nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
failuresToTolerateAndRaidLevel:
{
Description: Failures to tolerate and RAID level for the Node. ,
Enum:
{
Unknown: Unknown FTT and RAID Level. ,
Ftt1Raid1: FTT 1 and RAID Level 1. ,
Ftt1Raid5: FTT 1 and RAID Level 5. ,
Ftt2Raid1: FTT 2 and RAID Level 1. ,
Ftt2Raid6: FTT 2 and RAID Level 6. ,
Ftt3Raid1: FTT 3 and RAID Level 1. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
estimatedExternalStorage:
{
Description: Estimated External Storage ,
Required: False ,
}
[
{
storageType:
{
Description: External storage type ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
totalStorageInGB:
{
Description: Total storage allocation in GB ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Percent storage utilization ,
Format: float ,
Required: False ,
}
number ,
totalStorageCost:
{
Description: Total storage cost ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
estimatedNetwork:
{
Description: Estimated Network ,
Required: False ,
}
[
{
skuType:
{
Description: Network SKU type. ,
Enum:
{
Unknown: Indicates un-supported network SKU. ,
None: Indicates No network SKU. ,
ExpressRouteUltra: Express Route network type with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
cost:
{
Description: Network Sku type cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
estimatedCostWithVcfByol:
{
Description: Estimated Cost With VCF BYOL ,
Format: float ,
Required: False ,
}
number ,
errors:
{
Description: Represents errors which might have occurred while calculating AVS Node Summary ,
Required: False ,
}
[
{
code:
{
Description: Error Code ,
Required: True ,
}
string ,
message:
{
Description: Description of the error occurred ,
Required: True ,
}
string ,
}
,
]
,
}
,
avsCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureAvsSustainabilityDetails:
{
Description: The AVS Azure Sustainability Details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremisesAvsSummary:
{
Description: The on premises IaaS summary. ,
Required: False ,
}
{
servers:
{
Description: The number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: Total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
cpuUtilization:
{
Description: The CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: The memory utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: The storage utilization. ,
Format: float ,
Required: False ,
}
number ,
onPremisesIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasCostForDecommissioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
osLicensingDetails:
{
Description: The OS licensing details. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionCost:
{
Description: The decommission cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByOperatingSystem:
{
Description: The distribution by operating system. ,
Required: False ,
}
[
{
osClassificationType:
{
Description: The Os classification type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the OS type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByVirtualization:
{
Description: The distribution by virtualization. ,
Required: False ,
}
[
{
virtualizationType:
{
Description: The Virtualization type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the Virtualization type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
iaasOsSupportStatusDistribution:
{
Description: Iaas OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasSqlSupportStatusDistribution:
{
Description: Iaas Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByOperatingSystemVersion:
{
Description: Distribution by Operating System Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlVersion:
{
Description: Distribution by Sql Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesIaasSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasDecommissionedSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseAvsSummaryOperations_Get (new)
Description :  Get a AvsSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
avsSummaryName:
{
Description: Gets the Name of the Avs Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azureAvsSummary:
{
Description: The Azure Avs summary. ,
Required: False ,
}
{
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
avsNodeSummary:
{
Description: Avs virtual machine summary. ,
Required: False ,
}
{
serversSuitableForMigration:
{
Description: Servers suitable for migration. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfServers:
{
Description: The total number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The total number of Avs VM cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGb:
{
Description: The total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
avsNodeCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedAvsNodeTypeSummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
avsNodeType:
{
Description: AVS node type. ,
Required: False ,
}
string ,
numberOfNodes:
{
Description: Number of nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
failuresToTolerateAndRaidLevel:
{
Description: Failures to tolerate and RAID level for the Node. ,
Enum:
{
Unknown: Unknown FTT and RAID Level. ,
Ftt1Raid1: FTT 1 and RAID Level 1. ,
Ftt1Raid5: FTT 1 and RAID Level 5. ,
Ftt2Raid1: FTT 2 and RAID Level 1. ,
Ftt2Raid6: FTT 2 and RAID Level 6. ,
Ftt3Raid1: FTT 3 and RAID Level 1. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
estimatedExternalStorage:
{
Description: Estimated External Storage ,
Required: False ,
}
[
{
storageType:
{
Description: External storage type ,
Enum:
{
Unknown: Indicates un-supported external storage. ,
None: Indicates No external storage. ,
AnfStandard: ANF external storage with Standard SKU. ,
AnfPremium: ANF external storage with Premium SKU. ,
AnfUltra: ANF external storage with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
totalStorageInGB:
{
Description: Total storage allocation in GB ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: Percent storage utilization ,
Format: float ,
Required: False ,
}
number ,
totalStorageCost:
{
Description: Total storage cost ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
estimatedNetwork:
{
Description: Estimated Network ,
Required: False ,
}
[
{
skuType:
{
Description: Network SKU type. ,
Enum:
{
Unknown: Indicates un-supported network SKU. ,
None: Indicates No network SKU. ,
ExpressRouteUltra: Express Route network type with Ultra SKU. ,
}
,
Required: False ,
}
enum ,
cost:
{
Description: Network Sku type cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
estimatedCostWithVcfByol:
{
Description: Estimated Cost With VCF BYOL ,
Format: float ,
Required: False ,
}
number ,
errors:
{
Description: Represents errors which might have occurred while calculating AVS Node Summary ,
Required: False ,
}
[
{
code:
{
Description: Error Code ,
Required: True ,
}
string ,
message:
{
Description: Description of the error occurred ,
Required: True ,
}
string ,
}
,
]
,
}
,
avsCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureAvsSustainabilityDetails:
{
Description: The AVS Azure Sustainability Details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremisesAvsSummary:
{
Description: The on premises IaaS summary. ,
Required: False ,
}
{
servers:
{
Description: The number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: Total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
cpuUtilization:
{
Description: The CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: The memory utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: The storage utilization. ,
Format: float ,
Required: False ,
}
number ,
onPremisesIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasCostForDecommissioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
osLicensingDetails:
{
Description: The OS licensing details. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionCost:
{
Description: The decommission cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByOperatingSystem:
{
Description: The distribution by operating system. ,
Required: False ,
}
[
{
osClassificationType:
{
Description: The Os classification type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the OS type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByVirtualization:
{
Description: The distribution by virtualization. ,
Required: False ,
}
[
{
virtualizationType:
{
Description: The Virtualization type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the Virtualization type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
iaasOsSupportStatusDistribution:
{
Description: Iaas OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasSqlSupportStatusDistribution:
{
Description: Iaas Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByOperatingSystemVersion:
{
Description: Distribution by Operating System Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlVersion:
{
Description: Distribution by Sql Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesIaasSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasDecommissionedSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_CompareSummary (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
azurePaasCostDetails:
{
Description: The azure PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureIaasCostDetails:
{
Description: The azure IaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureAvsCostDetails:
{
Description: The AVS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasCostDetails:
{
Description: The on premises IaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesAvsCostDetails:
{
Description: The on premises AVS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasDecommissionedCostDetails:
{
Description: The on premises PaaS decommissioned cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasDecommissionedCostDetails:
{
Description: The on premises IaaS decommissioned cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesAvsDecommissionedCostDetails:
{
Description: The on premises AVS decommissioned cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
futureCostDetails:
{
Description: Future state cost which includes Azure cost and Arc enabled on-premises cost based on the final migration percentage. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureArcEnabledOnPremisesCostDetails:
{
Description: The Azure arc enabled on-premises cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
futureAzureArcEnabledOnPremisesCostDetails:
{
Description: The final azure arc enabled on-premises cost based on the final migration percentage. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azurePaasCarbonEmissionsDetails:
{
Description: The Azure PaaS Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
azureIaasCarbonEmissionsDetails:
{
Description: The Azure IaaS Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
azureAvsCarbonEmissionsDetails:
{
Description: The Azure AvS Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesPaasCarbonEmissionsDetails:
{
Description: The on premises PaaS Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasCarbonEmissionsDetails:
{
Description: The on premises IaaS Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesAvsCarbonEmissionsDetails:
{
Description: The on premises Avs Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesPaasDecommissionedCarbonEmissionsDetails:
{
Description: The on premises PaaS decommissioned Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasDecommissionedCarbonEmissionsDetails:
{
Description: The on premises IaaS decommissioned Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesAvsDecommissionedCarbonEmissionsDetails:
{
Description: The on premises Avs decommissioned Carbon Emissions details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedAvsMachinesOperations_ListByParent (new)
Description :  List EvaluatedAvsMachine resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EvaluatedAvsMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineId:
{
Description: Machine Id. ,
Required: False ,
}
string ,
serverName:
{
Description: Server Name. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: Virtualization type. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating System (OS) name. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedAvsMachinesOperations_Get (new)
Description :  Get a EvaluatedAvsMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
evaluatedAvsMachineName:
{
Description: Business case Evaluated AVS machine ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineId:
{
Description: Machine Id. ,
Required: False ,
}
string ,
serverName:
{
Description: Server Name. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: Virtualization type. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating System (OS) name. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedMachinesOperations_ListByParent (new)
Description :  List EvaluatedMachine resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EvaluatedMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineId:
{
Description: Machine Id. ,
Required: False ,
}
string ,
serverName:
{
Description: Server Name. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: Virtualization type. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating System (OS) name. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedMachinesOperations_Get (new)
Description :  Get a EvaluatedMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
evaluatedMachineName:
{
Description: Business case Evaluated machine ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineId:
{
Description: Machine Id. ,
Required: False ,
}
string ,
serverName:
{
Description: Server Name. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: Virtualization type. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating System (OS) name. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedSqlEntitiesOperations_ListByParent (new)
Description :  List EvaluatedSqlEntity resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EvaluatedSqlEntity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: SQL Server version. ,
Required: False ,
}
string ,
sqlEdition:
{
Description: SQL Server edition. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is SQL Instance ready for migration. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: The virtualization type. ,
Required: False ,
}
string ,
dbCount:
{
Description: DB count in instance. ,
Format: int32 ,
Required: False ,
}
integer ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedSqlEntitiesOperations_Get (new)
Description :  Get a EvaluatedSqlEntity
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
evaluatedSqlEntityName:
{
Description: Business case Evaluated sql entity ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
activityState:
{
Description: Activity state. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: SQL Server version. ,
Required: False ,
}
string ,
sqlEdition:
{
Description: SQL Server edition. ,
Required: False ,
}
string ,
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
qualifyingOffer:
{
Description: Qualifying offer. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is SQL Instance ready for migration. ,
Required: False ,
}
string ,
virtualizationType:
{
Description: The virtualization type. ,
Required: False ,
}
string ,
dbCount:
{
Description: DB count in instance. ,
Format: int32 ,
Required: False ,
}
integer ,
supportStatus:
{
Description: End of Support status. ,
Enum:
{
Unknown: Unknown Supportability Status. ,
Mainstream: Mainstream Supportability Status. ,
Extended: Extended Supportability Status. ,
OutOfSupport: OutOfSupport Supportability Status. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedWebAppsOperations_ListByParent (new)
Description :  List EvaluatedWebApp resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EvaluatedWebApp items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
recommendedAzureSkuName:
{
Description: Recommended Azure SKU name. ,
Required: False ,
}
string ,
recommendedAzureSkuSize:
{
Description: Recommended Azure SKU size. ,
Required: False ,
}
string ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
workload:
{
Description: The workload. ,
Required: False ,
}
string ,
activityState:
{
Description: The activity state. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EvaluatedWebAppsOperations_Get (new)
Description :  Get a EvaluatedWebApp
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
evaluatedWebAppName:
{
Description: Business case Evaluated web App ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recommendedAzureTarget:
{
Description: Recommended Azure target. ,
Required: False ,
}
string ,
recommendedAzureSkuName:
{
Description: Recommended Azure SKU name. ,
Required: False ,
}
string ,
recommendedAzureSkuSize:
{
Description: Recommended Azure SKU size. ,
Required: False ,
}
string ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
workload:
{
Description: The workload. ,
Required: False ,
}
string ,
activityState:
{
Description: The activity state. ,
Required: False ,
}
string ,
readyForMigration:
{
Description: Is machine ready for migration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOperations_GetReportDownloadUrl (new)
Description :  Get the URL for downloading the business case in a report format.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
businessCaseReportUrl:
{
Description: Hyperlink to download report. ,
Required: False ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseIaasSummaryOperations_ListByParent (new)
Description :  List IaasSummary resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IaasSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azureIaasSummary:
{
Description: The Azure IaaS summary. ,
Required: False ,
}
{
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasVmSummary:
{
Description: Azure Iaas virtual machine summary. ,
Required: False ,
}
{
serversSuitableForMigration:
{
Description: Servers suitable for migration. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfServers:
{
Description: The total number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The total number of IaaS VM cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
azureVmCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedVmFamilySummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
azureVmFamily:
{
Description: The Azure VM family. ,
Required: False ,
}
string ,
numberOfMachines:
{
Description: The number of machines. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
costByStorageType:
{
Description: The cost by storage type. ,
Required: False ,
}
[
{
storageType:
{
Description: The storage type. ,
Required: False ,
}
string ,
cost:
{
Description: Cost per storage type. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasSqlSummary:
{
Description: Azure Iaas sql server summary. ,
Required: False ,
}
{
totalSqlEntities:
{
Description: Total SQL entities. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableSqlEntities:
{
Description: Suitable SQL entities. ,
Format: int32 ,
Required: False ,
}
integer ,
azureSqlCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedVmFamilySummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
azureVmFamily:
{
Description: The Azure VM family. ,
Required: False ,
}
string ,
numberOfMachines:
{
Description: The number of machines. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
costByStorageType:
{
Description: The cost by storage type. ,
Required: False ,
}
[
{
storageType:
{
Description: The storage type. ,
Required: False ,
}
string ,
cost:
{
Description: Cost per storage type. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureIaasSustainabilityDetails:
{
Description: The azure Iaas sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremisesIaasSummary:
{
Description: The on premises IaaS summary. ,
Required: False ,
}
{
servers:
{
Description: The number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: Total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
cpuUtilization:
{
Description: The CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: The memory utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: The storage utilization. ,
Format: float ,
Required: False ,
}
number ,
onPremisesIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasCostForDecommissioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
osLicensingDetails:
{
Description: The OS licensing details. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionCost:
{
Description: The decommission cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByOperatingSystem:
{
Description: The distribution by operating system. ,
Required: False ,
}
[
{
osClassificationType:
{
Description: The Os classification type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the OS type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByVirtualization:
{
Description: The distribution by virtualization. ,
Required: False ,
}
[
{
virtualizationType:
{
Description: The Virtualization type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the Virtualization type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
iaasOsSupportStatusDistribution:
{
Description: Iaas OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasSqlSupportStatusDistribution:
{
Description: Iaas Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByOperatingSystemVersion:
{
Description: Distribution by Operating System Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlVersion:
{
Description: Distribution by Sql Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesIaasSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasDecommissionedSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseIaasSummaryOperations_Get (new)
Description :  Get a IaasSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
iaasSummaryName:
{
Description: Gets the Name of the Iaas Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azureIaasSummary:
{
Description: The Azure IaaS summary. ,
Required: False ,
}
{
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasVmSummary:
{
Description: Azure Iaas virtual machine summary. ,
Required: False ,
}
{
serversSuitableForMigration:
{
Description: Servers suitable for migration. ,
Format: int32 ,
Required: False ,
}
integer ,
totalNumberOfServers:
{
Description: The total number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The total number of IaaS VM cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
azureVmCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedVmFamilySummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
azureVmFamily:
{
Description: The Azure VM family. ,
Required: False ,
}
string ,
numberOfMachines:
{
Description: The number of machines. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
costByStorageType:
{
Description: The cost by storage type. ,
Required: False ,
}
[
{
storageType:
{
Description: The storage type. ,
Required: False ,
}
string ,
cost:
{
Description: Cost per storage type. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasSqlSummary:
{
Description: Azure Iaas sql server summary. ,
Required: False ,
}
{
totalSqlEntities:
{
Description: Total SQL entities. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableSqlEntities:
{
Description: Suitable SQL entities. ,
Format: int32 ,
Required: False ,
}
integer ,
azureSqlCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedCost:
{
Description: Estimated cost. ,
Format: float ,
Required: False ,
}
number ,
osLicensingCost:
{
Description: OS licensing cost. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByRecommendedOffer:
{
Description: Estimated cost by offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
recommendedVmFamilySummary:
{
Description: The recommended VM family summary. ,
Required: False ,
}
[
{
azureVmFamily:
{
Description: The Azure VM family. ,
Required: False ,
}
string ,
numberOfMachines:
{
Description: The number of machines. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
costByStorageType:
{
Description: The cost by storage type. ,
Required: False ,
}
[
{
storageType:
{
Description: The storage type. ,
Required: False ,
}
string ,
cost:
{
Description: Cost per storage type. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azureIaasSustainabilityDetails:
{
Description: The azure Iaas sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremisesIaasSummary:
{
Description: The on premises IaaS summary. ,
Required: False ,
}
{
servers:
{
Description: The number of servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: The number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: Total memory in GB. ,
Format: float ,
Required: False ,
}
number ,
cpuUtilization:
{
Description: The CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: The memory utilization. ,
Format: float ,
Required: False ,
}
number ,
storageUtilization:
{
Description: The storage utilization. ,
Format: float ,
Required: False ,
}
number ,
onPremisesIaasCostDetails:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesIaasCostForDecommissioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
osLicensingDetails:
{
Description: The OS licensing details. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionCost:
{
Description: The decommission cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByOperatingSystem:
{
Description: The distribution by operating system. ,
Required: False ,
}
[
{
osClassificationType:
{
Description: The Os classification type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the OS type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByVirtualization:
{
Description: The distribution by virtualization. ,
Required: False ,
}
[
{
virtualizationType:
{
Description: The Virtualization type. ,
Required: False ,
}
string ,
count:
{
Description: The number of machines with the Virtualization type classification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
iaasOsSupportStatusDistribution:
{
Description: Iaas OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasSqlSupportStatusDistribution:
{
Description: Iaas Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionByOperatingSystemVersion:
{
Description: Distribution by Operating System Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlVersion:
{
Description: Distribution by Sql Version. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
onPremisesIaasSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesIaasDecommissionedSustainabilityDetails:
{
Description: The on premises Iaas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOverviewSummaryOperations_ListByParent (new)
Description :  List OverviewSummary resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OverviewSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
totalAzureCost:
{
Description: The total Azure cost.. ,
Format: float ,
Required: False ,
}
number ,
totalAzureIaasCost:
{
Description: The total Azure IaaS cost. ,
Format: float ,
Required: False ,
}
number ,
totalAzurePaasCost:
{
Description: The total Azure PaaS cost. ,
Format: float ,
Required: False ,
}
number ,
totalAzureAvsCost:
{
Description: The total Avs cost. ,
Format: float ,
Required: False ,
}
number ,
windowsAhubSavings:
{
Description: The windows ahub saving. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux ahub saving. ,
Format: float ,
Required: False ,
}
number ,
sqlAhubSavings:
{
Description: The sql ahub saving. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesCost:
{
Description: The total on premises cost. ,
Format: float ,
Required: False ,
}
number ,
esuSavingsFor4years:
{
Description: ESU Savings 4 Years. ,
Format: float ,
Required: False ,
}
number ,
managementCostSavings:
{
Description: The management cost saving. ,
Format: float ,
Required: False ,
}
number ,
securityCostSavings:
{
Description: The security cost saving. ,
Format: float ,
Required: False ,
}
number ,
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
serversDiscovered:
{
Description: Shows the discovered servers by virtualization platform. ,
Required: False ,
}
{
vmWare:
{
Description: Number of servers on VMWare. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperV:
{
Description: Number of servers on HyperV. ,
Format: int32 ,
Required: False ,
}
integer ,
physical:
{
Description: Number of physical servers. ,
Format: int32 ,
Required: False ,
}
integer ,
notApplicable:
{
Description: Number of servers whose virtualization is unknown. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
utilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasOsDistribution:
{
Description: Shows the infrastructure as a service machine OS distribution. ,
Required: False ,
}
{
windows:
{
Description: Number of Windows servers. ,
Format: int32 ,
Required: False ,
}
integer ,
linux:
{
Description: Number of Linux servers. ,
Format: int32 ,
Required: False ,
}
integer ,
other:
{
Description: Number of servers neither Windows or Linux. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osSupportStatusDistribution:
{
Description: OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlSupportStatusDistribution:
{
Description: Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
paasDistribution:
{
Description: Shows the distribution of platforms. ,
Required: False ,
}
{
sqlServers:
{
Description: Number of SQL Server machines. ,
Format: int32 ,
Required: False ,
}
integer ,
iisWebServers:
{
Description: Number of IIS Web servers. ,
Format: int32 ,
Required: False ,
}
integer ,
webAppDistribution:
{
Description: Distribution of webapps for each target type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
azureArcEnabledOnPremisesCost:
{
Description: The total Azure arc enabled on-premises cost assuming all on-premises infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureCostIncludingAzureArc:
{
Description: The final cost including azure and azure arc enabled on-premises considering the remaining on-prem infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureEsuSavingsFor4YearsIncludingAzureArc:
{
Description: ESU Savings in 4 Years considering the remaining on-prem infra each year is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureManagementCostSavingsIncludingAzureArc:
{
Description: The management cost saving considering the remaining on-prem infra is arc enabled ,
Format: float ,
Required: False ,
}
number ,
futureSecurityCostSavingsIncludingAzureArc:
{
Description: The security cost saving considering the remaining on-prem infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
azureArcServicesCost:
{
Description: The total cost of services offered by azure arc. ,
Format: float ,
Required: False ,
}
number ,
futureAzureIaasCost:
{
Description: The Iaas component of the future azure cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzurePaasCost:
{
Description: The Paas component of the future azure cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzureArcEnabledOnPremisesCost:
{
Description: The future azure arc cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzureArcServicesCost:
{
Description: The total cost of services offered by azure arc based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesSustainabilityDetails:
{
Description: The total on-premises sustainability estimates. ,
Required: True ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
totalAzureSustainabilityDetails:
{
Description: The total azure sustainability estimates. ,
Required: True ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCaseOverviewSummaryOperations_Get (new)
Description :  Get a OverviewSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
overviewSummaryName:
{
Description: Gets the Name of the Overview Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
totalAzureCost:
{
Description: The total Azure cost.. ,
Format: float ,
Required: False ,
}
number ,
totalAzureIaasCost:
{
Description: The total Azure IaaS cost. ,
Format: float ,
Required: False ,
}
number ,
totalAzurePaasCost:
{
Description: The total Azure PaaS cost. ,
Format: float ,
Required: False ,
}
number ,
totalAzureAvsCost:
{
Description: The total Avs cost. ,
Format: float ,
Required: False ,
}
number ,
windowsAhubSavings:
{
Description: The windows ahub saving. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux ahub saving. ,
Format: float ,
Required: False ,
}
number ,
sqlAhubSavings:
{
Description: The sql ahub saving. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesCost:
{
Description: The total on premises cost. ,
Format: float ,
Required: False ,
}
number ,
esuSavingsFor4years:
{
Description: ESU Savings 4 Years. ,
Format: float ,
Required: False ,
}
number ,
managementCostSavings:
{
Description: The management cost saving. ,
Format: float ,
Required: False ,
}
number ,
securityCostSavings:
{
Description: The security cost saving. ,
Format: float ,
Required: False ,
}
number ,
yearOnYearEstimates:
{
Description: Shows the year-on-year cost overall. ,
Required: False ,
}
{
onPremisesCost:
{
Description: Year-on-Year on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCost:
{
Description: Year-on-Year Azure cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
savings:
{
Description: Year-on-Year savings. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesCapexCost:
{
Description: Year-on-Year on-premises capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesOpexCost:
{
Description: Year-on-Year on-premises opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureCapexCost:
{
Description: Year-on-Year azure capex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureOpexCost:
{
Description: Year-on-Year azure opex cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
paybackPeriod:
{
Description: Payback period. ,
Format: int32 ,
Required: False ,
}
integer ,
azureArcEnabledOnPremisesCost:
{
Description: Year-on-Year azure arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureCost:
{
Description: Year-on-Year azure with arc enabled on-premises cost. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureAzureArcEnabledOnPremisesEsuCost:
{
Description: Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
futureOnPremisesEsuCost:
{
Description: Year-on-Year on-premises esu cost of the remaining infra on-premises. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: Cost for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
onPremisesEmissionsEstimates:
{
Description: Year-on-Year on-premises emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
azureEmissionsEstimates:
{
Description: Year-on-Year Azure emissions estimates. ,
Required: False ,
}
[
{
year:
{
Description: Year value. ,
Enum:
{
Year0: Year 0. ,
Year1: Year 1. ,
Year2: Year 2. ,
Year3: Year 3. ,
}
,
Required: True ,
}
enum ,
emissions:
{
Description: Emissions for the specified year. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
serversDiscovered:
{
Description: Shows the discovered servers by virtualization platform. ,
Required: False ,
}
{
vmWare:
{
Description: Number of servers on VMWare. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperV:
{
Description: Number of servers on HyperV. ,
Format: int32 ,
Required: False ,
}
integer ,
physical:
{
Description: Number of physical servers. ,
Format: int32 ,
Required: False ,
}
integer ,
notApplicable:
{
Description: Number of servers whose virtualization is unknown. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
utilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
iaasOsDistribution:
{
Description: Shows the infrastructure as a service machine OS distribution. ,
Required: False ,
}
{
windows:
{
Description: Number of Windows servers. ,
Format: int32 ,
Required: False ,
}
integer ,
linux:
{
Description: Number of Linux servers. ,
Format: int32 ,
Required: False ,
}
integer ,
other:
{
Description: Number of servers neither Windows or Linux. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osSupportStatusDistribution:
{
Description: OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlSupportStatusDistribution:
{
Description: Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
paasDistribution:
{
Description: Shows the distribution of platforms. ,
Required: False ,
}
{
sqlServers:
{
Description: Number of SQL Server machines. ,
Format: int32 ,
Required: False ,
}
integer ,
iisWebServers:
{
Description: Number of IIS Web servers. ,
Format: int32 ,
Required: False ,
}
integer ,
webAppDistribution:
{
Description: Distribution of webapps for each target type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
azureArcEnabledOnPremisesCost:
{
Description: The total Azure arc enabled on-premises cost assuming all on-premises infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureCostIncludingAzureArc:
{
Description: The final cost including azure and azure arc enabled on-premises considering the remaining on-prem infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureEsuSavingsFor4YearsIncludingAzureArc:
{
Description: ESU Savings in 4 Years considering the remaining on-prem infra each year is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
futureManagementCostSavingsIncludingAzureArc:
{
Description: The management cost saving considering the remaining on-prem infra is arc enabled ,
Format: float ,
Required: False ,
}
number ,
futureSecurityCostSavingsIncludingAzureArc:
{
Description: The security cost saving considering the remaining on-prem infra is arc enabled. ,
Format: float ,
Required: False ,
}
number ,
azureArcServicesCost:
{
Description: The total cost of services offered by azure arc. ,
Format: float ,
Required: False ,
}
number ,
futureAzureIaasCost:
{
Description: The Iaas component of the future azure cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzurePaasCost:
{
Description: The Paas component of the future azure cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzureArcEnabledOnPremisesCost:
{
Description: The future azure arc cost based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
futureAzureArcServicesCost:
{
Description: The total cost of services offered by azure arc based on the final migration percentage. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesSustainabilityDetails:
{
Description: The total on-premises sustainability estimates. ,
Required: True ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
totalAzureSustainabilityDetails:
{
Description: The total azure sustainability estimates. ,
Required: True ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCasePaasSummaryOperations_ListByParent (new)
Description :  List PaasSummary resources by BusinessCase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PaasSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azure:
{
Description: Shows the PaaS Azure summary. ,
Required: False ,
}
{
totalSqlEntities:
{
Description: Number of Sql instances. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableSqlEntities:
{
Description: Suitable Sql instances. ,
Format: int32 ,
Required: False ,
}
integer ,
totalWebApps:
{
Description: Number of web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableWebApps:
{
Description: Suitable web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: Number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory Utilization. ,
Format: float ,
Required: False ,
}
number ,
storage:
{
Description: Storage Utilization. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByTarget:
{
Description: Shows the estimated cost by target. ,
Required: False ,
}
{
azureSqlMiCost:
{
Description: Azure SQL MI cost. ,
Format: float ,
Required: False ,
}
number ,
azureSqlDbCost:
{
Description: Azure SQL DB cost. ,
Format: float ,
Required: False ,
}
number ,
appServiceCost:
{
Description: Azure App Service cost. ,
Format: float ,
Required: False ,
}
number ,
appServiceContainerCost:
{
Description: Azure App Service Containers cost. ,
Format: float ,
Required: False ,
}
number ,
azureKubernetesServiceCost:
{
Description: Azure Kubernetes Service cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedSqlServerLicensingCost:
{
Description: estimated SQL Server licensing cost. ,
Format: float ,
Required: False ,
}
number ,
azureSqlSummary:
{
Description: Shows the Azure SQL details. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommended offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTier:
{
Description: Distribution by service tiers, retaining just to support older Business cases. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTierForSqlMi:
{
Description: Distribution by service tiers for SQL MI. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTierForSqlDb:
{
Description: Distribution by service tiers for SQL DB. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureAppServiceSummary:
{
Description: Shows Azure App Service summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureAppServiceContainerSummary:
{
Description: Shows Azure App Service Container summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans or node pools recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureKubernetesServiceSummary:
{
Description: Shows Azure Kubernetes Service summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans or node pools recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
totalAzurePaasCost:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azurePaasSustainabilityDetails:
{
Description: The Azure PaaS Sustainability Emissions Details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremises:
{
Description: Shows platform as a service (PaaS) summary. ,
Required: False ,
}
{
totalServers:
{
Description: Total servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: CPU utilization percentage. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: Memory utilization percentage. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesPaasCost:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasCostForDecommisioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasLicensingCost:
{
Description: The on premises paas licensing cost. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionServerCost:
{
Description: The decommissioned server cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesSqlSummary:
{
Description: The on premises SQL summary. ,
Required: False ,
}
{
sqlInstances:
{
Description: The number of SQL instances. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlDatabases:
{
Description: The number of SQL databases. ,
Format: int32 ,
Required: False ,
}
integer ,
distributionBySqlVersion:
{
Description: Distribution by SQL version. ,
Required: False ,
}
[
{
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
numberOfInstances:
{
Description: Number of instances with the above SQL version. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
sqlOnPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
onPremisesWebAppSummary:
{
Description: The on premises web application summary. ,
Required: False ,
}
{
numberOfWebServers:
{
Description: The number of web servers. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfWebApplications:
{
Description: The number of web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfWebAppsPerType:
{
Description: The number of web applications per web application type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osSupportStatusDistribution:
{
Description: OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlSupportStatusDistribution:
{
Description: Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
onPremisesPaasSustainabilityDetails:
{
Description: The on premises PaaS sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesPaasDecommissionedSustainabilityDetails:
{
Description: The on premises Paas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BusinessCasePaasSummaryOperations_Get (new)
Description :  Get a PaasSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
businessCaseName:
{
Description: Business case ARM name ,
Required: True ,
}
string ,
paasSummaryName:
{
Description: Gets the Name of the Paas Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
azure:
{
Description: Shows the PaaS Azure summary. ,
Required: False ,
}
{
totalSqlEntities:
{
Description: Number of Sql instances. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableSqlEntities:
{
Description: Suitable Sql instances. ,
Format: int32 ,
Required: False ,
}
integer ,
totalWebApps:
{
Description: Number of web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
suitableWebApps:
{
Description: Suitable web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
cores:
{
Description: Number of cores. ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory Utilization. ,
Format: float ,
Required: False ,
}
number ,
storage:
{
Description: Storage Utilization. ,
Format: float ,
Required: False ,
}
number ,
estimatedCostByTarget:
{
Description: Shows the estimated cost by target. ,
Required: False ,
}
{
azureSqlMiCost:
{
Description: Azure SQL MI cost. ,
Format: float ,
Required: False ,
}
number ,
azureSqlDbCost:
{
Description: Azure SQL DB cost. ,
Format: float ,
Required: False ,
}
number ,
appServiceCost:
{
Description: Azure App Service cost. ,
Format: float ,
Required: False ,
}
number ,
appServiceContainerCost:
{
Description: Azure App Service Containers cost. ,
Format: float ,
Required: False ,
}
number ,
azureKubernetesServiceCost:
{
Description: Azure Kubernetes Service cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
estimatedSqlServerLicensingCost:
{
Description: estimated SQL Server licensing cost. ,
Format: float ,
Required: False ,
}
number ,
azureSqlSummary:
{
Description: Shows the Azure SQL details. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommended offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTier:
{
Description: Distribution by service tiers, retaining just to support older Business cases. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTierForSqlMi:
{
Description: Distribution by service tiers for SQL MI. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionByServiceTierForSqlDb:
{
Description: Distribution by service tiers for SQL DB. ,
Required: False ,
}
[
{
serviceTierName:
{
Description: The service tier name. ,
Required: False ,
}
string ,
serviceTierNumber:
{
Description: The number of sql entities with this tier. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureAppServiceSummary:
{
Description: Shows Azure App Service summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureAppServiceContainerSummary:
{
Description: Shows Azure App Service Container summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans or node pools recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
azureKubernetesServiceSummary:
{
Description: Shows Azure Kubernetes Service summary. ,
Required: False ,
}
{
estimatedCostByOffer:
{
Description: Estimated cost by recommendation offer. ,
Required: False ,
}
[
{
offerName:
{
Description: The offer name. ,
Required: False ,
}
string ,
cost:
{
Description: Cost for the offer. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
distributionBySku:
{
Description: Distribution by SKU. ,
Required: False ,
}
[
{
skuName:
{
Description: The SKU name. ,
Required: False ,
}
string ,
cost:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: The number of service plans or node pools recommended. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
distributionByApp:
{
Description: Distribution by application type. ,
Required: False ,
}
[
{
webAppType:
{
Description: WebApp type. ,
Enum:
{
Unknown: Unknown WebApp Type. ,
ASPNET: ASPNET Type. ,
Java: Java Tomcat Type. ,
}
,
Required: False ,
}
enum ,
numberOfWebApps:
{
Description: The cost details. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
totalAzurePaasCost:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
azurePaasSustainabilityDetails:
{
Description: The Azure PaaS Sustainability Emissions Details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
onPremises:
{
Description: Shows platform as a service (PaaS) summary. ,
Required: False ,
}
{
totalServers:
{
Description: Total servers. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: CPU utilization percentage. ,
Format: float ,
Required: False ,
}
number ,
memoryUtilization:
{
Description: Memory utilization percentage. ,
Format: float ,
Required: False ,
}
number ,
totalOnPremisesPaasCost:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasCostForDecommisioned:
{
Description: The on premises PaaS cost. ,
Required: False ,
}
{
storageCost:
{
Description: The storage cost. ,
Format: float ,
Required: False ,
}
number ,
computeCost:
{
Description: The compute cost. ,
Format: float ,
Required: False ,
}
number ,
itLaborCost:
{
Description: The IT labor cost. ,
Format: float ,
Required: False ,
}
number ,
networkCost:
{
Description: The network cost. ,
Format: float ,
Required: False ,
}
number ,
ahubSavings:
{
Description: The windows AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
linuxAhubSavings:
{
Description: The linux AhubSavings. ,
Format: float ,
Required: False ,
}
number ,
securityCost:
{
Description: Security Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostDetails:
{
Description: Management Cost Details. ,
Required: False ,
}
{
managementCost:
{
Description: Management Cost. ,
Format: float ,
Required: False ,
}
number ,
managementCostComponents:
{
Description: Management Cost Components. ,
Required: False ,
}
[
{
name:
{
Description: Name of Management Cost Component. ,
Enum:
{
Unknown: Unknown Management Cost Component. ,
SystemCenterLicenseCost: System Center License Cost. ,
VSphereManagementCost: VSphere eManagement Cost. ,
ThirdPartyManagementCost: Third Party Management Cost. ,
OtherMonitoringCost: Other Monitoring Cost. ,
OtherDataProtectionCost: Other Data Protection Cost. ,
OtherPatchingCost: Other Patching Cost. ,
AzureMonitoringCost: Azure Monitoring Cost. ,
AzurePatchingCost: Azure Patching Cost. ,
AzureDataProtectionCost: Azure Data Protection Cost. ,
AzureArcMonitoringCost: Azure Arc Monitoring Cost. ,
AzureArcPatchingCost: Azure Arc Patching Cost. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Cost of Management Component. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
esuSavings:
{
Description: esu savings. ,
Format: float ,
Required: False ,
}
number ,
facilitiesCost:
{
Description: The facilities cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesPaasLicensingCost:
{
Description: The on premises paas licensing cost. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
totalCost:
{
Description: The total cost. ,
Format: float ,
Required: False ,
}
number ,
decomissionServerCost:
{
Description: The decommissioned server cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
onPremisesSqlSummary:
{
Description: The on premises SQL summary. ,
Required: False ,
}
{
sqlInstances:
{
Description: The number of SQL instances. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlDatabases:
{
Description: The number of SQL databases. ,
Format: int32 ,
Required: False ,
}
integer ,
distributionBySqlVersion:
{
Description: Distribution by SQL version. ,
Required: False ,
}
[
{
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
numberOfInstances:
{
Description: Number of instances with the above SQL version. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
sqlOnPremisesUtilizationData:
{
Description: The SQL on premises utilization insights. ,
Required: False ,
}
{
numberOfActiveEntities:
{
Description: The number of active entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInactiveEntities:
{
Description: The number of inactive entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfDecommisionEntities:
{
Description: The number of decommission entities. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUnknownEntities:
{
Description: The number of unknown entities. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
distributionBySqlEdition:
{
Description: Distribution by Sql Edition. ,
Required: False ,
}
[
{
type:
{
Description: Distribution Type. ,
Required: False ,
}
string ,
count:
{
Description: Distribution Count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
onPremisesWebAppSummary:
{
Description: The on premises web application summary. ,
Required: False ,
}
{
numberOfWebServers:
{
Description: The number of web servers. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfWebApplications:
{
Description: The number of web applications. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfWebAppsPerType:
{
Description: The number of web applications per web application type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osSupportStatusDistribution:
{
Description: OS Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlSupportStatusDistribution:
{
Description: Sql Support Status Distribution. ,
Required: False ,
}
{
unknownSupport:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
mainStream:
{
Description: Mainstream support. ,
Format: int32 ,
Required: False ,
}
integer ,
extended:
{
Description: Extended support. ,
Format: int32 ,
Required: False ,
}
integer ,
outOfSupport:
{
Description: Out of support. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
osServicePackInsight:
{
Description: OS Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sqlServicePackInsight:
{
Description: Sql Service Pack Insight. ,
Required: False ,
}
{
unknownServicePack:
{
Description: Unknown support. ,
Format: int32 ,
Required: False ,
}
integer ,
patched:
{
Description: Patched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
unpatched:
{
Description: Unpatched Service Pack Insight. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
onPremisesPaasSustainabilityDetails:
{
Description: The on premises PaaS sustainability details. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
onPremisesPaasDecommissionedSustainabilityDetails:
{
Description: The on premises Paas Sustainability details for Decommissioned. ,
Required: False ,
}
{
scope1:
{
Description: Scope 1 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope2:
{
Description: Scope 2 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
scope3:
{
Description: Scope 3 emissions in metric tons of CO2 equivalent (MTCO2e). ,
Required: True ,
}
{
compute:
{
Description: The compute emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
storage:
{
Description: The storage emissions in metric tons of CO2 equivalent (MTCO2e). ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HypervCollectorsOperations_ListByParent (new)
Description :  List HypervCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HypervCollectorsOperations_Get (new)
Description :  Get a HypervCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
hypervCollectorName:
{
Description: Hyper-V collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HypervCollectorsOperations_Create (new)
Description :  Create a HypervCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
hypervCollectorName:
{
Description: Hyper-V collector ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Hyper-V collector resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HypervCollectorsOperations_Delete (new)
Description :  Delete a HypervCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
hypervCollectorName:
{
Description: Hyper-V collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportSqlCollectorOperations_ListByParent (new)
Description :  List ImportSqlCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importSqlCollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportSqlCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: The sql db extended details. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: When was import SQL collector first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was import SQL collector last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportSqlCollectorOperations_Get (new)
Description :  Get a ImportSqlCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importSqlCollectors/{importSqlCollectorsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importSqlCollectorsName:
{
Description: Import SQL Collector arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: The sql db extended details. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: When was import SQL collector first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was import SQL collector last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportSqlCollectorOperations_Create (new)
Description :  Create a ImportSqlCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importSqlCollectors/{importSqlCollectorsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importSqlCollectorsName:
{
Description: Import SQL Collector arm name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: The sql db extended details. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: When was import SQL collector first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was import SQL collector last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: The sql db extended details. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: When was import SQL collector first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was import SQL collector last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Import SQL Collector REST resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: The sql db extended details. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: When was import SQL collector first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was import SQL collector last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportSqlCollectorOperations_Delete (new)
Description :  Delete a ImportSqlCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importSqlCollectors/{importSqlCollectorsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importSqlCollectorsName:
{
Description: Import SQL Collector arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportCollectorsOperations_ListByParent (new)
Description :  List ImportCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportCollectorsOperations_Get (new)
Description :  Get a ImportCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importCollectorName:
{
Description: Import collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportCollectorsOperations_Create (new)
Description :  Create a ImportCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importCollectorName:
{
Description: Import collector ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Import collector resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ImportCollectorsOperations_Delete (new)
Description :  Delete a ImportCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
importCollectorName:
{
Description: Import collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerCollectorsOperations_ListByParent (new)
Description :  List ServerCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerCollectorsOperations_Get (new)
Description :  Get a ServerCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
serverCollectorName:
{
Description: Physical server collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerCollectorsOperations_Create (new)
Description :  Create a ServerCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
serverCollectorName:
{
Description: Physical server collector ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Physical server collector resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerCollectorsOperations_Delete (new)
Description :  Delete a ServerCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
serverCollectorName:
{
Description: Physical server collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlCollectorOperations_ListByParent (new)
Description :  List SqlCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlCollectorOperations_Get (new)
Description :  Get a SqlCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Sql collector ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlCollectorOperations_Create (new)
Description :  Create a SqlCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Sql collector ARM name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The SQL collector REST object. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlCollectorOperations_Delete (new)
Description :  Delete a SqlCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Sql collector ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmwareCollectorsOperations_ListByParent (new)
Description :  List VmwareCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmwareCollectorsOperations_Get (new)
Description :  Get a VmwareCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
vmWareCollectorName:
{
Description: VMware collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmwareCollectorsOperations_Create (new)
Description :  Create a VmwareCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
vmWareCollectorName:
{
Description: VMware collector ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: VMware collector resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmwareCollectorsOperations_Delete (new)
Description :  Delete a VmwareCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
vmWareCollectorName:
{
Description: VMware collector ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppCollectorOperations_ListByParent (new)
Description :  List WebAppCollector resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppCollector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppCollectorOperations_Get (new)
Description :  Get a WebAppCollector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Web app collector ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppCollectorOperations_Create (new)
Description :  Create a WebAppCollector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Web app collector ARM name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The web app collector REST object. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
agentProperties:
{
Description: Gets or sets the collector agent properties. ,
Required: False ,
}
{
id:
{
Description: Gets the collector agent id. ,
Required: False ,
}
string ,
version:
{
Description: Gets the collector agent version. ,
Required: False ,
}
string ,
lastHeartbeatUtc:
{
Description: Gets the collector last heartbeat time. ,
Format: date-time ,
Required: False ,
}
string ,
spnDetails:
{
Description: Gets or sets the SPN details. ,
Required: False ,
}
{
authority:
{
Description: Gets the AAD authority endpoint. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets the AAD application id. ,
Required: False ,
}
string ,
audience:
{
Description: Gets the AAD audience url. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets the object id of the AAD application. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets the tenant id of the AAD application. ,
Required: False ,
}
string ,
}
,
}
,
discoverySiteId:
{
Description: Gets the discovery site id. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Gets the Timestamp when collector was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when collector was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppCollectorOperations_Delete (new)
Description :  Delete a WebAppCollector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
collectorName:
{
Description: Web app collector ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentOperations_ListByParent (new)
Description :  List HeterogeneousAssessment resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HeterogeneousAssessment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
assessmentArmIds:
{
Description: Arm id of partner assessments. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
lastCalculatedOn:
{
Description: Timestamp for the last successfully calculated summary for the assessment. ,
Format: date-time ,
Required: False ,
}
string ,
confidenceRatingInPercentage:
{
Description: Confidence rating in percentage. ,
Format: float ,
Required: False ,
}
number ,
azureLocation:
{
Description: Azure location for assessment. ,
Required: False ,
}
string ,
sizingCriterion:
{
Description: Sizing criterion for assessment. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
schemaVersion:
{
Description: Schema version. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentOperations_Get (new)
Description :  Get a HeterogeneousAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Heterogeneous Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
assessmentArmIds:
{
Description: Arm id of partner assessments. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
lastCalculatedOn:
{
Description: Timestamp for the last successfully calculated summary for the assessment. ,
Format: date-time ,
Required: False ,
}
string ,
confidenceRatingInPercentage:
{
Description: Confidence rating in percentage. ,
Format: float ,
Required: False ,
}
number ,
azureLocation:
{
Description: Azure location for assessment. ,
Required: False ,
}
string ,
sizingCriterion:
{
Description: Sizing criterion for assessment. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
schemaVersion:
{
Description: Schema version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentOperations_Create (new)
Description :  Create a HeterogeneousAssessment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Heterogeneous Assessment ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
assessmentArmIds:
{
Description: Arm id of partner assessments. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
lastCalculatedOn:
{
Description: Timestamp for the last successfully calculated summary for the assessment. ,
Format: date-time ,
Required: False ,
}
string ,
confidenceRatingInPercentage:
{
Description: Confidence rating in percentage. ,
Format: float ,
Required: False ,
}
number ,
azureLocation:
{
Description: Azure location for assessment. ,
Required: False ,
}
string ,
sizingCriterion:
{
Description: Sizing criterion for assessment. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
schemaVersion:
{
Description: Schema version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
assessmentArmIds:
{
Description: Arm id of partner assessments. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
lastCalculatedOn:
{
Description: Timestamp for the last successfully calculated summary for the assessment. ,
Format: date-time ,
Required: False ,
}
string ,
confidenceRatingInPercentage:
{
Description: Confidence rating in percentage. ,
Format: float ,
Required: False ,
}
number ,
azureLocation:
{
Description: Azure location for assessment. ,
Required: False ,
}
string ,
sizingCriterion:
{
Description: Sizing criterion for assessment. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
schemaVersion:
{
Description: Schema version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Heterogeneous assessment resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
assessmentArmIds:
{
Description: Arm id of partner assessments. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
lastCalculatedOn:
{
Description: Timestamp for the last successfully calculated summary for the assessment. ,
Format: date-time ,
Required: False ,
}
string ,
confidenceRatingInPercentage:
{
Description: Confidence rating in percentage. ,
Format: float ,
Required: False ,
}
number ,
azureLocation:
{
Description: Azure location for assessment. ,
Required: False ,
}
string ,
sizingCriterion:
{
Description: Sizing criterion for assessment. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
schemaVersion:
{
Description: Schema version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentOperations_Delete (new)
Description :  Delete a HeterogeneousAssessment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Heterogeneous Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentSummaryOperations_ListByParent (new)
Description :  List HeterogeneousAssessmentSummary resources by HeterogeneousAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Heterogeneous Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HeterogeneousAssessmentSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
assessmentName:
{
Description: The assessment name ,
Required: False ,
}
string ,
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
migrationPaths:
{
Description: Gets the migration type summaries. ,
Required: False ,
}
[
{
migrationType:
{
Description: Gets the migration type. ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: Gets the Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: Gets the readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
readinessSummary:
{
Description: Gets the readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
confidenceScore:
{
Description: Gets the confidence score. ,
Format: float ,
Required: False ,
}
number ,
costComponents:
{
Description: Gets the cost components. ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
Unknown: Unknown Cost Component ,
MonthlyAzureHybridCostSavings: Monthly Azure Hybrid Cost Savings ,
MonthlySecurityCost: Monthly Security Cost ,
MonthlyPremiumV2StorageCost: Monthly Premium V2 Storage Cost ,
MonthlyLinuxAzureHybridCostSavings: Monthly Linux Azure Hybrid Cost Savings ,
MonthlyAvsNodeCost: Monthly Avs Node Cost ,
MonthlyExternalStorageCost: Monthly External Storage Cost ,
MonthlyNetworkCost: Monthly Network Cost ,
MonthlyVcfByolCostDifference: Monthly Vcf Byol Cost Difference ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
savingComponent:
{
Description: Gets the saving component. ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings Component ,
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings Component ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HeterogeneousAssessmentSummaryOperations_Get (new)
Description :  Get a HeterogeneousAssessmentSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/heterogeneousAssessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Heterogeneous Assessment ARM name ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the Heterogeneous assessment Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
assessmentName:
{
Description: The assessment name ,
Required: False ,
}
string ,
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
migrationPaths:
{
Description: Gets the migration type summaries. ,
Required: False ,
}
[
{
migrationType:
{
Description: Gets the migration type. ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: Gets the Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: Gets the readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
readinessSummary:
{
Description: Gets the readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
confidenceScore:
{
Description: Gets the confidence score. ,
Format: float ,
Required: False ,
}
number ,
costComponents:
{
Description: Gets the cost components. ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
Unknown: Unknown Cost Component ,
MonthlyAzureHybridCostSavings: Monthly Azure Hybrid Cost Savings ,
MonthlySecurityCost: Monthly Security Cost ,
MonthlyPremiumV2StorageCost: Monthly Premium V2 Storage Cost ,
MonthlyLinuxAzureHybridCostSavings: Monthly Linux Azure Hybrid Cost Savings ,
MonthlyAvsNodeCost: Monthly Avs Node Cost ,
MonthlyExternalStorageCost: Monthly External Storage Cost ,
MonthlyNetworkCost: Monthly Network Cost ,
MonthlyVcfByolCostDifference: Monthly Vcf Byol Cost Difference ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
savingComponent:
{
Description: Gets the saving component. ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings Component ,
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings Component ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineGraphAssessmentOptionsOperations_ListByParent (new)
Description :  List MachineGraphAssessmentOptions resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MachineGraphAssessmentOptions items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineGraphAssessmentOptionsOperations_Get (new)
Description :  Get a MachineGraphAssessmentOptions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentsV2Operations_ListByParent (new)
Description :  List MachineAssessmentV2 resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MachineAssessmentV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
azureSecurityOfferingType:
{
Description: The azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
azureDiskTypes:
{
Description: The disk type for the assessment. ,
Required: False ,
}
[
string ,
]
,
azurePricingTier:
{
Description: Gets or sets Azure Pricing Tier - Free, Basic, etc. ,
Enum:
{
Standard: Standard Azure Pricing Tier ,
Basic: Basic Azure Pricing Tier ,
}
,
Required: False ,
}
enum ,
azureStorageRedundancy:
{
Description: Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. ,
Enum:
{
Unknown: Unknown Azure Storage Redundancy ,
LocallyRedundant: LocallyRedundant Azure Storage Redundancy ,
ZoneRedundant: ZoneRedundant Azure Storage Redundancy ,
GeoRedundant: GeoRedundant Azure Storage Redundancy ,
ReadAccessGeoRedundant: ReadAccessGeoRedundant Azure Storage Redundancy ,
}
,
Required: False ,
}
enum ,
azureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
linuxAzureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the linux azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
azureVmFamilies:
{
Description: Gets or sets the Azure VM families. ,
Required: False ,
}
[
string ,
]
,
vmUptime:
{
Description: Gets or sets the duration for which the VMs are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Number of days in a month for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Number of hours per day for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentsV2Operations_Get (new)
Description :  Get a MachineAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
azureSecurityOfferingType:
{
Description: The azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
azureDiskTypes:
{
Description: The disk type for the assessment. ,
Required: False ,
}
[
string ,
]
,
azurePricingTier:
{
Description: Gets or sets Azure Pricing Tier - Free, Basic, etc. ,
Enum:
{
Standard: Standard Azure Pricing Tier ,
Basic: Basic Azure Pricing Tier ,
}
,
Required: False ,
}
enum ,
azureStorageRedundancy:
{
Description: Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. ,
Enum:
{
Unknown: Unknown Azure Storage Redundancy ,
LocallyRedundant: LocallyRedundant Azure Storage Redundancy ,
ZoneRedundant: ZoneRedundant Azure Storage Redundancy ,
GeoRedundant: GeoRedundant Azure Storage Redundancy ,
ReadAccessGeoRedundant: ReadAccessGeoRedundant Azure Storage Redundancy ,
}
,
Required: False ,
}
enum ,
azureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
linuxAzureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the linux azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
azureVmFamilies:
{
Description: Gets or sets the Azure VM families. ,
Required: False ,
}
[
string ,
]
,
vmUptime:
{
Description: Gets or sets the duration for which the VMs are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Number of days in a month for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Number of hours per day for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentsV2Operations_Create (new)
Description :  Create a MachineAssessmentV2
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
azureSecurityOfferingType:
{
Description: The azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
azureDiskTypes:
{
Description: The disk type for the assessment. ,
Required: False ,
}
[
string ,
]
,
azurePricingTier:
{
Description: Gets or sets Azure Pricing Tier - Free, Basic, etc. ,
Enum:
{
Standard: Standard Azure Pricing Tier ,
Basic: Basic Azure Pricing Tier ,
}
,
Required: False ,
}
enum ,
azureStorageRedundancy:
{
Description: Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. ,
Enum:
{
Unknown: Unknown Azure Storage Redundancy ,
LocallyRedundant: LocallyRedundant Azure Storage Redundancy ,
ZoneRedundant: ZoneRedundant Azure Storage Redundancy ,
GeoRedundant: GeoRedundant Azure Storage Redundancy ,
ReadAccessGeoRedundant: ReadAccessGeoRedundant Azure Storage Redundancy ,
}
,
Required: False ,
}
enum ,
azureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
linuxAzureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the linux azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
azureVmFamilies:
{
Description: Gets or sets the Azure VM families. ,
Required: False ,
}
[
string ,
]
,
vmUptime:
{
Description: Gets or sets the duration for which the VMs are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Number of days in a month for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Number of hours per day for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
azureSecurityOfferingType:
{
Description: The azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
azureDiskTypes:
{
Description: The disk type for the assessment. ,
Required: False ,
}
[
string ,
]
,
azurePricingTier:
{
Description: Gets or sets Azure Pricing Tier - Free, Basic, etc. ,
Enum:
{
Standard: Standard Azure Pricing Tier ,
Basic: Basic Azure Pricing Tier ,
}
,
Required: False ,
}
enum ,
azureStorageRedundancy:
{
Description: Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. ,
Enum:
{
Unknown: Unknown Azure Storage Redundancy ,
LocallyRedundant: LocallyRedundant Azure Storage Redundancy ,
ZoneRedundant: ZoneRedundant Azure Storage Redundancy ,
GeoRedundant: GeoRedundant Azure Storage Redundancy ,
ReadAccessGeoRedundant: ReadAccessGeoRedundant Azure Storage Redundancy ,
}
,
Required: False ,
}
enum ,
azureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
linuxAzureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the linux azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
azureVmFamilies:
{
Description: Gets or sets the Azure VM families. ,
Required: False ,
}
[
string ,
]
,
vmUptime:
{
Description: Gets or sets the duration for which the VMs are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Number of days in a month for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Number of hours per day for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Machine assessment V2 resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
azureSecurityOfferingType:
{
Description: The azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
azureDiskTypes:
{
Description: The disk type for the assessment. ,
Required: False ,
}
[
string ,
]
,
azurePricingTier:
{
Description: Gets or sets Azure Pricing Tier - Free, Basic, etc. ,
Enum:
{
Standard: Standard Azure Pricing Tier ,
Basic: Basic Azure Pricing Tier ,
}
,
Required: False ,
}
enum ,
azureStorageRedundancy:
{
Description: Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. ,
Enum:
{
Unknown: Unknown Azure Storage Redundancy ,
LocallyRedundant: LocallyRedundant Azure Storage Redundancy ,
ZoneRedundant: ZoneRedundant Azure Storage Redundancy ,
GeoRedundant: GeoRedundant Azure Storage Redundancy ,
ReadAccessGeoRedundant: ReadAccessGeoRedundant Azure Storage Redundancy ,
}
,
Required: False ,
}
enum ,
azureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
linuxAzureHybridUseBenefit:
{
Description: Gets or sets the user configurable setting to display the linux azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Azure Hybrid Use Benefit ,
Yes: Yes Azure Hybrid Use Benefit ,
No: No Azure Hybrid Use Benefit ,
}
,
Required: False ,
}
enum ,
azureVmFamilies:
{
Description: Gets or sets the Azure VM families. ,
Required: False ,
}
[
string ,
]
,
vmUptime:
{
Description: Gets or sets the duration for which the VMs are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Number of days in a month for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Number of hours per day for VM uptime. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentsV2Operations_Delete (new)
Description :  Delete a MachineAssessmentV2
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedMachinesV2Operations_ListByParent (new)
Description :  List AssessedMachineV2 resources by MachineAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}/assessedMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedMachineV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
extendedDetails:
{
Description: The assessed machine extended details. ,
Required: False ,
}
{
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
disks:
{
Description: Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
displayName:
{
Description: The disk display name. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gets the gigabytes provisioned. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
hostProcessor:
{
Description: Gets or sets the processor details of the host. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name \ model of a processor. ,
Required: False ,
}
string ,
numberOfSockets:
{
Description: Gets or sets the number of sockets. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfCoresPerSocket:
{
Description: Gets or sets the number of cores in a socket. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkAdapters:
{
Description: List of Network Adapters that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
netGigabytesTransmittedPerMonth:
{
Description: Gets the net gigabytes transmitted per month. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: Gets the mac address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: Gets the ip addresses. ,
Required: False ,
}
[
string ,
]
,
megabytesPerSecondRecieved:
{
Description: Gets the megabytes per second received. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the megabytes per second transmitted. ,
Format: float ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
}
,
]
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
errors:
{
Description: List of errors for this machine. ,
Required: False ,
}
[
{
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the Run as account ID. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the Appliance name. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
agentScenario:
{
Description: Gets the agent scenario where this error occurred. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the error possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action for the error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the error message parameters. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
impactedAssessmentType:
{
Description: Gets the type of assessment impacted by this error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedMachinesV2Operations_Get (new)
Description :  Get a AssessedMachineV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
assessedMachineName:
{
Description: Machine assessment V2 Assessed Machine ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
extendedDetails:
{
Description: The assessed machine extended details. ,
Required: False ,
}
{
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
disks:
{
Description: Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
displayName:
{
Description: The disk display name. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gets the gigabytes provisioned. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
hostProcessor:
{
Description: Gets or sets the processor details of the host. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name \ model of a processor. ,
Required: False ,
}
string ,
numberOfSockets:
{
Description: Gets or sets the number of sockets. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfCoresPerSocket:
{
Description: Gets or sets the number of cores in a socket. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkAdapters:
{
Description: List of Network Adapters that were assessed as part of this machine's assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
netGigabytesTransmittedPerMonth:
{
Description: Gets the net gigabytes transmitted per month. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: Gets the mac address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: Gets the ip addresses. ,
Required: False ,
}
[
string ,
]
,
megabytesPerSecondRecieved:
{
Description: Gets the megabytes per second received. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the megabytes per second transmitted. ,
Format: float ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
}
,
]
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
errors:
{
Description: List of errors for this machine. ,
Required: False ,
}
[
{
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the Run as account ID. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the Appliance name. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
agentScenario:
{
Description: Gets the agent scenario where this error occurred. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the error possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action for the error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the error message parameters. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
impactedAssessmentType:
{
Description: Gets the type of assessment impacted by this error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentsV2Operations_DownloadUrl (new)
Description :  Get the URL for downloading the assessment in a report format.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentV2SummaryOperations_ListByParent (new)
Description :  List MachineAssessmentV2Summary resources by MachineAssessmentV2
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MachineAssessmentV2Summary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineAssessmentV2SummaryOperations_Get (new)
Description :  Get a MachineAssessmentV2Summary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: Machine Assessment V2 ARM name ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the Machine Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlGraphAssessmentOptionsOperations_ListByParent (new)
Description :  List SqlGraphAssessmentOptions resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlGraphAssessmentOptions items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlGraphAssessmentOptionsOperations_Get (new)
Description :  Get a SqlGraphAssessmentOptions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3Operations_ListByParent (new)
Description :  List SqlAssessmentV3 resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlAssessmentV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
osLicense:
{
Description: Gets or sets user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Os License ,
Yes: Yes Os License ,
No: No Os License ,
}
,
Required: False ,
}
enum ,
entityUptime:
{
Description: Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Gets the days per month. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Gets the hours per day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredTargets:
{
Description: Gets or sets SQL the preferred azure targets. ,
Required: False ,
}
[
string ,
]
,
azureSqlManagedInstanceSettings:
{
Description: Gets or sets user configurable SQL managed instance settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlInstanceType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Azure Sql Instance Type ,
Automatic: Automatic Azure Sql Instance Type ,
SingleInstance: SingleInstance Azure Sql Instance Type ,
InstancePools: InstancePools Azure Sql Instance Type ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlDatabaseSettings:
{
Description: Gets or sets user configurable SQL database settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlDataBaseType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Data Base Type ,
Automatic: Automatic Data Base Type ,
SingleDatabase: SingleDatabase Data Base Type ,
ElasticPool: ElasticPool Data Base Type ,
}
,
Required: False ,
}
enum ,
azureSqlComputeTier:
{
Description: Gets or sets the azure SQL compute tier. ,
Enum:
{
Unknown: Unknown - Compute Tier ,
Automatic: Automatic - Compute Tier ,
Provisioned: Provisioned - Compute Tier ,
Serverless: Serverless - Compute Tier ,
}
,
Required: False ,
}
enum ,
azureSqlPurchaseModel:
{
Description: Gets or sets the azure SQL purchase model. ,
Enum:
{
Unknown: Unknown Purchase Model ,
VCore: VCore Purchase Model ,
DTU: DTU Purchase Model ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlVmSettings:
{
Description: Gets or sets user configurable SQL VM settings. ,
Required: False ,
}
{
instanceSeries:
{
Description: Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). ,
Required: False ,
}
[
string ,
]
,
}
,
multiSubnetIntent:
{
Description: Gets or sets user preference indicating intent of multi-subnet configuration. ,
Enum:
{
None: None - Multi Subnet Intent ,
HighAvailability: HighAvailability - Multi Subnet Intent ,
DisasterRecovery: DisasterRecovery - Multi Subnet Intent ,
}
,
Required: False ,
}
enum ,
asyncCommitModeIntent:
{
Description: Gets or sets user preference indicating intent of async commit mode. ,
Enum:
{
None: None - Async Commit Mode Intent ,
HighAvailability: HighAvailability - Async Commit Mode Intent ,
DisasterRecovery: DisasterRecovery - Async Commit Mode Intent ,
}
,
Required: False ,
}
enum ,
isInternetAccessAvailable:
{
Description: Gets or sets a value indicating whether internet access is available. ,
Required: False ,
}
boolean ,
disasterRecoveryLocation:
{
Description: Gets or sets the Azure Location or Azure region where to which the machines will be migrated. ,
Enum:
{
Unknown: Unknown Location for Azure ,
EastAsia: EastAsia Location for Azure ,
SoutheastAsia: SoutheastAsia Location for Azure ,
AustraliaEast: AustraliaEast Location for Azure ,
AustraliaSoutheast: AustraliaSoutheast Location for Azure ,
BrazilSouth: BrazilSouth Location for Azure ,
CanadaCentral: CanadaCentral Location for Azure ,
CanadaEast: CanadaEast Location for Azure ,
WestEurope: WestEurope Location for Azure ,
NorthEurope: NorthEurope Location for Azure ,
CentralIndia: CentralIndia Location for Azure ,
SouthIndia: SouthIndia Location for Azure ,
WestIndia: WestIndia Location for Azure ,
JapanEast: JapanEast Location for Azure ,
JapanWest: JapanWest Location for Azure ,
KoreaCentral: KoreaCentral Location for Azure ,
KoreaSouth: KoreaSouth Location for Azure ,
UkWest: UkWest Location for Azure ,
UkSouth: UkSouth Location for Azure ,
NorthCentralUs: NorthCentralUs Location for Azure ,
EastUs: EastUs Location for Azure ,
WestUs2: WestUs2 Location for Azure ,
SouthCentralUs: SouthCentralUs Location for Azure ,
CentralUs: CentralUs Location for Azure ,
EastUs2: EastUs2 Location for Azure ,
WestUs: WestUs Location for Azure ,
WestCentralUs: WestCentralUs Location for Azure ,
GermanyCentral: GermanyCentral Location for Azure ,
GermanyNortheast: GermanyNortheast Location for Azure ,
ChinaNorth: ChinaNorth Location for Azure ,
ChinaEast: ChinaEast Location for Azure ,
USGovArizona: USGovArizona Location for Azure ,
USGovTexas: USGovTexas Location for Azure ,
USGovIowa: USGovIowa Location for Azure ,
USGovVirginia: USGovVirginia Location for Azure ,
USDoDCentral: USDoDCentral Location for Azure ,
USDoDEast: USDoDEast Location for Azure ,
FranceCentral: FranceCentral Location for Azure ,
AustraliaCentral: AustraliaCentral Location for Azure ,
SouthAfricaNorth: SouthAfricaNorth Location for Azure ,
FranceSouth: FranceSouth Location for Azure ,
AustraliaCentral2: AustraliaCentral2 Location for Azure ,
SouthAfricaWest: SouthAfricaWest Location for Azure ,
GermanyNorth: GermanyNorth Location for Azure ,
GermanyWestCentral: GermanyWestCentral Location for Azure ,
NorwayEast: NorwayEast Location for Azure ,
NorwayWest: NorwayWest Location for Azure ,
ChinaEast2: ChinaEast2 Location for Azure ,
ChinaNorth2: ChinaNorth2 Location for Azure ,
SwitzerlandNorth: SwitzerlandNorth Location for Azure ,
SwitzerlandWest: SwitzerlandWest Location for Azure ,
UAENorth: UAENorth Location for Azure ,
UAECentral: UAECentral Location for Azure ,
UsNatEast: UsNatEast Location for Azure ,
UsNatWest: UsNatWest Location for Azure ,
UsSecEast: UsSecEast Location for Azure ,
UsSecCentral: UsSecCentral Location for Azure ,
UsSecWest: UsSecWest Location for Azure ,
SwedenCentral: SwedenCentral Location for Azure ,
QatarCentral: QatarCentral Location for Azure ,
JioIndiaWest: JioIndiaWest Location for Azure ,
ItalyNorth: ItalyNorth Location for Azure ,
PolandCentral: PolandCentral Location for Azure ,
IsraelCentral: IsraelCentral Location for Azure ,
MexicoCentral: MexicoCentral Location for Azure ,
NewZealandNorth: NewZealandNorth Location for Azure ,
SpainCentral: SpainCentral Location for Azure ,
}
,
Required: False ,
}
enum ,
enableHadrAssessment:
{
Description: Gets or sets a value indicating whether HADR assessments needs to be created. ,
Required: False ,
}
boolean ,
azureSecurityOfferingType:
{
Description: Gets or sets a value indicating azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
sqlServerLicense:
{
Description: SQL server license. ,
Enum:
{
Unknown: Unknown - Sql Server License ,
Yes: Has Sql Server License ,
No: No Sql Server License ,
}
,
Required: False ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3Operations_Get (new)
Description :  Get a SqlAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
osLicense:
{
Description: Gets or sets user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Os License ,
Yes: Yes Os License ,
No: No Os License ,
}
,
Required: False ,
}
enum ,
entityUptime:
{
Description: Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Gets the days per month. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Gets the hours per day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredTargets:
{
Description: Gets or sets SQL the preferred azure targets. ,
Required: False ,
}
[
string ,
]
,
azureSqlManagedInstanceSettings:
{
Description: Gets or sets user configurable SQL managed instance settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlInstanceType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Azure Sql Instance Type ,
Automatic: Automatic Azure Sql Instance Type ,
SingleInstance: SingleInstance Azure Sql Instance Type ,
InstancePools: InstancePools Azure Sql Instance Type ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlDatabaseSettings:
{
Description: Gets or sets user configurable SQL database settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlDataBaseType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Data Base Type ,
Automatic: Automatic Data Base Type ,
SingleDatabase: SingleDatabase Data Base Type ,
ElasticPool: ElasticPool Data Base Type ,
}
,
Required: False ,
}
enum ,
azureSqlComputeTier:
{
Description: Gets or sets the azure SQL compute tier. ,
Enum:
{
Unknown: Unknown - Compute Tier ,
Automatic: Automatic - Compute Tier ,
Provisioned: Provisioned - Compute Tier ,
Serverless: Serverless - Compute Tier ,
}
,
Required: False ,
}
enum ,
azureSqlPurchaseModel:
{
Description: Gets or sets the azure SQL purchase model. ,
Enum:
{
Unknown: Unknown Purchase Model ,
VCore: VCore Purchase Model ,
DTU: DTU Purchase Model ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlVmSettings:
{
Description: Gets or sets user configurable SQL VM settings. ,
Required: False ,
}
{
instanceSeries:
{
Description: Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). ,
Required: False ,
}
[
string ,
]
,
}
,
multiSubnetIntent:
{
Description: Gets or sets user preference indicating intent of multi-subnet configuration. ,
Enum:
{
None: None - Multi Subnet Intent ,
HighAvailability: HighAvailability - Multi Subnet Intent ,
DisasterRecovery: DisasterRecovery - Multi Subnet Intent ,
}
,
Required: False ,
}
enum ,
asyncCommitModeIntent:
{
Description: Gets or sets user preference indicating intent of async commit mode. ,
Enum:
{
None: None - Async Commit Mode Intent ,
HighAvailability: HighAvailability - Async Commit Mode Intent ,
DisasterRecovery: DisasterRecovery - Async Commit Mode Intent ,
}
,
Required: False ,
}
enum ,
isInternetAccessAvailable:
{
Description: Gets or sets a value indicating whether internet access is available. ,
Required: False ,
}
boolean ,
disasterRecoveryLocation:
{
Description: Gets or sets the Azure Location or Azure region where to which the machines will be migrated. ,
Enum:
{
Unknown: Unknown Location for Azure ,
EastAsia: EastAsia Location for Azure ,
SoutheastAsia: SoutheastAsia Location for Azure ,
AustraliaEast: AustraliaEast Location for Azure ,
AustraliaSoutheast: AustraliaSoutheast Location for Azure ,
BrazilSouth: BrazilSouth Location for Azure ,
CanadaCentral: CanadaCentral Location for Azure ,
CanadaEast: CanadaEast Location for Azure ,
WestEurope: WestEurope Location for Azure ,
NorthEurope: NorthEurope Location for Azure ,
CentralIndia: CentralIndia Location for Azure ,
SouthIndia: SouthIndia Location for Azure ,
WestIndia: WestIndia Location for Azure ,
JapanEast: JapanEast Location for Azure ,
JapanWest: JapanWest Location for Azure ,
KoreaCentral: KoreaCentral Location for Azure ,
KoreaSouth: KoreaSouth Location for Azure ,
UkWest: UkWest Location for Azure ,
UkSouth: UkSouth Location for Azure ,
NorthCentralUs: NorthCentralUs Location for Azure ,
EastUs: EastUs Location for Azure ,
WestUs2: WestUs2 Location for Azure ,
SouthCentralUs: SouthCentralUs Location for Azure ,
CentralUs: CentralUs Location for Azure ,
EastUs2: EastUs2 Location for Azure ,
WestUs: WestUs Location for Azure ,
WestCentralUs: WestCentralUs Location for Azure ,
GermanyCentral: GermanyCentral Location for Azure ,
GermanyNortheast: GermanyNortheast Location for Azure ,
ChinaNorth: ChinaNorth Location for Azure ,
ChinaEast: ChinaEast Location for Azure ,
USGovArizona: USGovArizona Location for Azure ,
USGovTexas: USGovTexas Location for Azure ,
USGovIowa: USGovIowa Location for Azure ,
USGovVirginia: USGovVirginia Location for Azure ,
USDoDCentral: USDoDCentral Location for Azure ,
USDoDEast: USDoDEast Location for Azure ,
FranceCentral: FranceCentral Location for Azure ,
AustraliaCentral: AustraliaCentral Location for Azure ,
SouthAfricaNorth: SouthAfricaNorth Location for Azure ,
FranceSouth: FranceSouth Location for Azure ,
AustraliaCentral2: AustraliaCentral2 Location for Azure ,
SouthAfricaWest: SouthAfricaWest Location for Azure ,
GermanyNorth: GermanyNorth Location for Azure ,
GermanyWestCentral: GermanyWestCentral Location for Azure ,
NorwayEast: NorwayEast Location for Azure ,
NorwayWest: NorwayWest Location for Azure ,
ChinaEast2: ChinaEast2 Location for Azure ,
ChinaNorth2: ChinaNorth2 Location for Azure ,
SwitzerlandNorth: SwitzerlandNorth Location for Azure ,
SwitzerlandWest: SwitzerlandWest Location for Azure ,
UAENorth: UAENorth Location for Azure ,
UAECentral: UAECentral Location for Azure ,
UsNatEast: UsNatEast Location for Azure ,
UsNatWest: UsNatWest Location for Azure ,
UsSecEast: UsSecEast Location for Azure ,
UsSecCentral: UsSecCentral Location for Azure ,
UsSecWest: UsSecWest Location for Azure ,
SwedenCentral: SwedenCentral Location for Azure ,
QatarCentral: QatarCentral Location for Azure ,
JioIndiaWest: JioIndiaWest Location for Azure ,
ItalyNorth: ItalyNorth Location for Azure ,
PolandCentral: PolandCentral Location for Azure ,
IsraelCentral: IsraelCentral Location for Azure ,
MexicoCentral: MexicoCentral Location for Azure ,
NewZealandNorth: NewZealandNorth Location for Azure ,
SpainCentral: SpainCentral Location for Azure ,
}
,
Required: False ,
}
enum ,
enableHadrAssessment:
{
Description: Gets or sets a value indicating whether HADR assessments needs to be created. ,
Required: False ,
}
boolean ,
azureSecurityOfferingType:
{
Description: Gets or sets a value indicating azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
sqlServerLicense:
{
Description: SQL server license. ,
Enum:
{
Unknown: Unknown - Sql Server License ,
Yes: Has Sql Server License ,
No: No Sql Server License ,
}
,
Required: False ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3Operations_Create (new)
Description :  Create a SqlAssessmentV3
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
osLicense:
{
Description: Gets or sets user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Os License ,
Yes: Yes Os License ,
No: No Os License ,
}
,
Required: False ,
}
enum ,
entityUptime:
{
Description: Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Gets the days per month. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Gets the hours per day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredTargets:
{
Description: Gets or sets SQL the preferred azure targets. ,
Required: False ,
}
[
string ,
]
,
azureSqlManagedInstanceSettings:
{
Description: Gets or sets user configurable SQL managed instance settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlInstanceType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Azure Sql Instance Type ,
Automatic: Automatic Azure Sql Instance Type ,
SingleInstance: SingleInstance Azure Sql Instance Type ,
InstancePools: InstancePools Azure Sql Instance Type ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlDatabaseSettings:
{
Description: Gets or sets user configurable SQL database settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlDataBaseType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Data Base Type ,
Automatic: Automatic Data Base Type ,
SingleDatabase: SingleDatabase Data Base Type ,
ElasticPool: ElasticPool Data Base Type ,
}
,
Required: False ,
}
enum ,
azureSqlComputeTier:
{
Description: Gets or sets the azure SQL compute tier. ,
Enum:
{
Unknown: Unknown - Compute Tier ,
Automatic: Automatic - Compute Tier ,
Provisioned: Provisioned - Compute Tier ,
Serverless: Serverless - Compute Tier ,
}
,
Required: False ,
}
enum ,
azureSqlPurchaseModel:
{
Description: Gets or sets the azure SQL purchase model. ,
Enum:
{
Unknown: Unknown Purchase Model ,
VCore: VCore Purchase Model ,
DTU: DTU Purchase Model ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlVmSettings:
{
Description: Gets or sets user configurable SQL VM settings. ,
Required: False ,
}
{
instanceSeries:
{
Description: Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). ,
Required: False ,
}
[
string ,
]
,
}
,
multiSubnetIntent:
{
Description: Gets or sets user preference indicating intent of multi-subnet configuration. ,
Enum:
{
None: None - Multi Subnet Intent ,
HighAvailability: HighAvailability - Multi Subnet Intent ,
DisasterRecovery: DisasterRecovery - Multi Subnet Intent ,
}
,
Required: False ,
}
enum ,
asyncCommitModeIntent:
{
Description: Gets or sets user preference indicating intent of async commit mode. ,
Enum:
{
None: None - Async Commit Mode Intent ,
HighAvailability: HighAvailability - Async Commit Mode Intent ,
DisasterRecovery: DisasterRecovery - Async Commit Mode Intent ,
}
,
Required: False ,
}
enum ,
isInternetAccessAvailable:
{
Description: Gets or sets a value indicating whether internet access is available. ,
Required: False ,
}
boolean ,
disasterRecoveryLocation:
{
Description: Gets or sets the Azure Location or Azure region where to which the machines will be migrated. ,
Enum:
{
Unknown: Unknown Location for Azure ,
EastAsia: EastAsia Location for Azure ,
SoutheastAsia: SoutheastAsia Location for Azure ,
AustraliaEast: AustraliaEast Location for Azure ,
AustraliaSoutheast: AustraliaSoutheast Location for Azure ,
BrazilSouth: BrazilSouth Location for Azure ,
CanadaCentral: CanadaCentral Location for Azure ,
CanadaEast: CanadaEast Location for Azure ,
WestEurope: WestEurope Location for Azure ,
NorthEurope: NorthEurope Location for Azure ,
CentralIndia: CentralIndia Location for Azure ,
SouthIndia: SouthIndia Location for Azure ,
WestIndia: WestIndia Location for Azure ,
JapanEast: JapanEast Location for Azure ,
JapanWest: JapanWest Location for Azure ,
KoreaCentral: KoreaCentral Location for Azure ,
KoreaSouth: KoreaSouth Location for Azure ,
UkWest: UkWest Location for Azure ,
UkSouth: UkSouth Location for Azure ,
NorthCentralUs: NorthCentralUs Location for Azure ,
EastUs: EastUs Location for Azure ,
WestUs2: WestUs2 Location for Azure ,
SouthCentralUs: SouthCentralUs Location for Azure ,
CentralUs: CentralUs Location for Azure ,
EastUs2: EastUs2 Location for Azure ,
WestUs: WestUs Location for Azure ,
WestCentralUs: WestCentralUs Location for Azure ,
GermanyCentral: GermanyCentral Location for Azure ,
GermanyNortheast: GermanyNortheast Location for Azure ,
ChinaNorth: ChinaNorth Location for Azure ,
ChinaEast: ChinaEast Location for Azure ,
USGovArizona: USGovArizona Location for Azure ,
USGovTexas: USGovTexas Location for Azure ,
USGovIowa: USGovIowa Location for Azure ,
USGovVirginia: USGovVirginia Location for Azure ,
USDoDCentral: USDoDCentral Location for Azure ,
USDoDEast: USDoDEast Location for Azure ,
FranceCentral: FranceCentral Location for Azure ,
AustraliaCentral: AustraliaCentral Location for Azure ,
SouthAfricaNorth: SouthAfricaNorth Location for Azure ,
FranceSouth: FranceSouth Location for Azure ,
AustraliaCentral2: AustraliaCentral2 Location for Azure ,
SouthAfricaWest: SouthAfricaWest Location for Azure ,
GermanyNorth: GermanyNorth Location for Azure ,
GermanyWestCentral: GermanyWestCentral Location for Azure ,
NorwayEast: NorwayEast Location for Azure ,
NorwayWest: NorwayWest Location for Azure ,
ChinaEast2: ChinaEast2 Location for Azure ,
ChinaNorth2: ChinaNorth2 Location for Azure ,
SwitzerlandNorth: SwitzerlandNorth Location for Azure ,
SwitzerlandWest: SwitzerlandWest Location for Azure ,
UAENorth: UAENorth Location for Azure ,
UAECentral: UAECentral Location for Azure ,
UsNatEast: UsNatEast Location for Azure ,
UsNatWest: UsNatWest Location for Azure ,
UsSecEast: UsSecEast Location for Azure ,
UsSecCentral: UsSecCentral Location for Azure ,
UsSecWest: UsSecWest Location for Azure ,
SwedenCentral: SwedenCentral Location for Azure ,
QatarCentral: QatarCentral Location for Azure ,
JioIndiaWest: JioIndiaWest Location for Azure ,
ItalyNorth: ItalyNorth Location for Azure ,
PolandCentral: PolandCentral Location for Azure ,
IsraelCentral: IsraelCentral Location for Azure ,
MexicoCentral: MexicoCentral Location for Azure ,
NewZealandNorth: NewZealandNorth Location for Azure ,
SpainCentral: SpainCentral Location for Azure ,
}
,
Required: False ,
}
enum ,
enableHadrAssessment:
{
Description: Gets or sets a value indicating whether HADR assessments needs to be created. ,
Required: False ,
}
boolean ,
azureSecurityOfferingType:
{
Description: Gets or sets a value indicating azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
sqlServerLicense:
{
Description: SQL server license. ,
Enum:
{
Unknown: Unknown - Sql Server License ,
Yes: Has Sql Server License ,
No: No Sql Server License ,
}
,
Required: False ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
osLicense:
{
Description: Gets or sets user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Os License ,
Yes: Yes Os License ,
No: No Os License ,
}
,
Required: False ,
}
enum ,
entityUptime:
{
Description: Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Gets the days per month. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Gets the hours per day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredTargets:
{
Description: Gets or sets SQL the preferred azure targets. ,
Required: False ,
}
[
string ,
]
,
azureSqlManagedInstanceSettings:
{
Description: Gets or sets user configurable SQL managed instance settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlInstanceType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Azure Sql Instance Type ,
Automatic: Automatic Azure Sql Instance Type ,
SingleInstance: SingleInstance Azure Sql Instance Type ,
InstancePools: InstancePools Azure Sql Instance Type ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlDatabaseSettings:
{
Description: Gets or sets user configurable SQL database settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlDataBaseType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Data Base Type ,
Automatic: Automatic Data Base Type ,
SingleDatabase: SingleDatabase Data Base Type ,
ElasticPool: ElasticPool Data Base Type ,
}
,
Required: False ,
}
enum ,
azureSqlComputeTier:
{
Description: Gets or sets the azure SQL compute tier. ,
Enum:
{
Unknown: Unknown - Compute Tier ,
Automatic: Automatic - Compute Tier ,
Provisioned: Provisioned - Compute Tier ,
Serverless: Serverless - Compute Tier ,
}
,
Required: False ,
}
enum ,
azureSqlPurchaseModel:
{
Description: Gets or sets the azure SQL purchase model. ,
Enum:
{
Unknown: Unknown Purchase Model ,
VCore: VCore Purchase Model ,
DTU: DTU Purchase Model ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlVmSettings:
{
Description: Gets or sets user configurable SQL VM settings. ,
Required: False ,
}
{
instanceSeries:
{
Description: Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). ,
Required: False ,
}
[
string ,
]
,
}
,
multiSubnetIntent:
{
Description: Gets or sets user preference indicating intent of multi-subnet configuration. ,
Enum:
{
None: None - Multi Subnet Intent ,
HighAvailability: HighAvailability - Multi Subnet Intent ,
DisasterRecovery: DisasterRecovery - Multi Subnet Intent ,
}
,
Required: False ,
}
enum ,
asyncCommitModeIntent:
{
Description: Gets or sets user preference indicating intent of async commit mode. ,
Enum:
{
None: None - Async Commit Mode Intent ,
HighAvailability: HighAvailability - Async Commit Mode Intent ,
DisasterRecovery: DisasterRecovery - Async Commit Mode Intent ,
}
,
Required: False ,
}
enum ,
isInternetAccessAvailable:
{
Description: Gets or sets a value indicating whether internet access is available. ,
Required: False ,
}
boolean ,
disasterRecoveryLocation:
{
Description: Gets or sets the Azure Location or Azure region where to which the machines will be migrated. ,
Enum:
{
Unknown: Unknown Location for Azure ,
EastAsia: EastAsia Location for Azure ,
SoutheastAsia: SoutheastAsia Location for Azure ,
AustraliaEast: AustraliaEast Location for Azure ,
AustraliaSoutheast: AustraliaSoutheast Location for Azure ,
BrazilSouth: BrazilSouth Location for Azure ,
CanadaCentral: CanadaCentral Location for Azure ,
CanadaEast: CanadaEast Location for Azure ,
WestEurope: WestEurope Location for Azure ,
NorthEurope: NorthEurope Location for Azure ,
CentralIndia: CentralIndia Location for Azure ,
SouthIndia: SouthIndia Location for Azure ,
WestIndia: WestIndia Location for Azure ,
JapanEast: JapanEast Location for Azure ,
JapanWest: JapanWest Location for Azure ,
KoreaCentral: KoreaCentral Location for Azure ,
KoreaSouth: KoreaSouth Location for Azure ,
UkWest: UkWest Location for Azure ,
UkSouth: UkSouth Location for Azure ,
NorthCentralUs: NorthCentralUs Location for Azure ,
EastUs: EastUs Location for Azure ,
WestUs2: WestUs2 Location for Azure ,
SouthCentralUs: SouthCentralUs Location for Azure ,
CentralUs: CentralUs Location for Azure ,
EastUs2: EastUs2 Location for Azure ,
WestUs: WestUs Location for Azure ,
WestCentralUs: WestCentralUs Location for Azure ,
GermanyCentral: GermanyCentral Location for Azure ,
GermanyNortheast: GermanyNortheast Location for Azure ,
ChinaNorth: ChinaNorth Location for Azure ,
ChinaEast: ChinaEast Location for Azure ,
USGovArizona: USGovArizona Location for Azure ,
USGovTexas: USGovTexas Location for Azure ,
USGovIowa: USGovIowa Location for Azure ,
USGovVirginia: USGovVirginia Location for Azure ,
USDoDCentral: USDoDCentral Location for Azure ,
USDoDEast: USDoDEast Location for Azure ,
FranceCentral: FranceCentral Location for Azure ,
AustraliaCentral: AustraliaCentral Location for Azure ,
SouthAfricaNorth: SouthAfricaNorth Location for Azure ,
FranceSouth: FranceSouth Location for Azure ,
AustraliaCentral2: AustraliaCentral2 Location for Azure ,
SouthAfricaWest: SouthAfricaWest Location for Azure ,
GermanyNorth: GermanyNorth Location for Azure ,
GermanyWestCentral: GermanyWestCentral Location for Azure ,
NorwayEast: NorwayEast Location for Azure ,
NorwayWest: NorwayWest Location for Azure ,
ChinaEast2: ChinaEast2 Location for Azure ,
ChinaNorth2: ChinaNorth2 Location for Azure ,
SwitzerlandNorth: SwitzerlandNorth Location for Azure ,
SwitzerlandWest: SwitzerlandWest Location for Azure ,
UAENorth: UAENorth Location for Azure ,
UAECentral: UAECentral Location for Azure ,
UsNatEast: UsNatEast Location for Azure ,
UsNatWest: UsNatWest Location for Azure ,
UsSecEast: UsSecEast Location for Azure ,
UsSecCentral: UsSecCentral Location for Azure ,
UsSecWest: UsSecWest Location for Azure ,
SwedenCentral: SwedenCentral Location for Azure ,
QatarCentral: QatarCentral Location for Azure ,
JioIndiaWest: JioIndiaWest Location for Azure ,
ItalyNorth: ItalyNorth Location for Azure ,
PolandCentral: PolandCentral Location for Azure ,
IsraelCentral: IsraelCentral Location for Azure ,
MexicoCentral: MexicoCentral Location for Azure ,
NewZealandNorth: NewZealandNorth Location for Azure ,
SpainCentral: SpainCentral Location for Azure ,
}
,
Required: False ,
}
enum ,
enableHadrAssessment:
{
Description: Gets or sets a value indicating whether HADR assessments needs to be created. ,
Required: False ,
}
boolean ,
azureSecurityOfferingType:
{
Description: Gets or sets a value indicating azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
sqlServerLicense:
{
Description: SQL server license. ,
Enum:
{
Unknown: Unknown - Sql Server License ,
Yes: Has Sql Server License ,
No: No Sql Server License ,
}
,
Required: False ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: SQL Assessment REST resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
osLicense:
{
Description: Gets or sets user configurable setting to display the azure hybrid use benefit. ,
Enum:
{
Unknown: Unknown Os License ,
Yes: Yes Os License ,
No: No Os License ,
}
,
Required: False ,
}
enum ,
entityUptime:
{
Description: Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. ,
Required: False ,
}
{
daysPerMonth:
{
Description: Gets the days per month. ,
Format: int32 ,
Required: False ,
}
integer ,
hoursPerDay:
{
Description: Gets the hours per day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredTargets:
{
Description: Gets or sets SQL the preferred azure targets. ,
Required: False ,
}
[
string ,
]
,
azureSqlManagedInstanceSettings:
{
Description: Gets or sets user configurable SQL managed instance settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlInstanceType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Azure Sql Instance Type ,
Automatic: Automatic Azure Sql Instance Type ,
SingleInstance: SingleInstance Azure Sql Instance Type ,
InstancePools: InstancePools Azure Sql Instance Type ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlDatabaseSettings:
{
Description: Gets or sets user configurable SQL database settings. ,
Required: False ,
}
{
azureSqlServiceTier:
{
Description: Gets or sets the azure SQL service tier. ,
Enum:
{
SqlService_Unknown: SqlService_Unknown Sql Service Tier V3 ,
SqlService_Automatic: SqlService_Automatic Sql Service Tier V3 ,
SqlService_GeneralPurpose: SqlService_GeneralPurpose Sql Service Tier V3 ,
SqlService_BusinessCritical: SqlService_BusinessCritical Sql Service Tier V3 ,
SqlService_HyperScale: SqlService_HyperScale Sql Service Tier V3 ,
}
,
Required: False ,
}
enum ,
azureSqlDataBaseType:
{
Description: Gets or sets the azure PAAS SQL instance type. ,
Enum:
{
Unknown: Unknown Data Base Type ,
Automatic: Automatic Data Base Type ,
SingleDatabase: SingleDatabase Data Base Type ,
ElasticPool: ElasticPool Data Base Type ,
}
,
Required: False ,
}
enum ,
azureSqlComputeTier:
{
Description: Gets or sets the azure SQL compute tier. ,
Enum:
{
Unknown: Unknown - Compute Tier ,
Automatic: Automatic - Compute Tier ,
Provisioned: Provisioned - Compute Tier ,
Serverless: Serverless - Compute Tier ,
}
,
Required: False ,
}
enum ,
azureSqlPurchaseModel:
{
Description: Gets or sets the azure SQL purchase model. ,
Enum:
{
Unknown: Unknown Purchase Model ,
VCore: VCore Purchase Model ,
DTU: DTU Purchase Model ,
}
,
Required: False ,
}
enum ,
}
,
azureSqlVmSettings:
{
Description: Gets or sets user configurable SQL VM settings. ,
Required: False ,
}
{
instanceSeries:
{
Description: Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). ,
Required: False ,
}
[
string ,
]
,
}
,
multiSubnetIntent:
{
Description: Gets or sets user preference indicating intent of multi-subnet configuration. ,
Enum:
{
None: None - Multi Subnet Intent ,
HighAvailability: HighAvailability - Multi Subnet Intent ,
DisasterRecovery: DisasterRecovery - Multi Subnet Intent ,
}
,
Required: False ,
}
enum ,
asyncCommitModeIntent:
{
Description: Gets or sets user preference indicating intent of async commit mode. ,
Enum:
{
None: None - Async Commit Mode Intent ,
HighAvailability: HighAvailability - Async Commit Mode Intent ,
DisasterRecovery: DisasterRecovery - Async Commit Mode Intent ,
}
,
Required: False ,
}
enum ,
isInternetAccessAvailable:
{
Description: Gets or sets a value indicating whether internet access is available. ,
Required: False ,
}
boolean ,
disasterRecoveryLocation:
{
Description: Gets or sets the Azure Location or Azure region where to which the machines will be migrated. ,
Enum:
{
Unknown: Unknown Location for Azure ,
EastAsia: EastAsia Location for Azure ,
SoutheastAsia: SoutheastAsia Location for Azure ,
AustraliaEast: AustraliaEast Location for Azure ,
AustraliaSoutheast: AustraliaSoutheast Location for Azure ,
BrazilSouth: BrazilSouth Location for Azure ,
CanadaCentral: CanadaCentral Location for Azure ,
CanadaEast: CanadaEast Location for Azure ,
WestEurope: WestEurope Location for Azure ,
NorthEurope: NorthEurope Location for Azure ,
CentralIndia: CentralIndia Location for Azure ,
SouthIndia: SouthIndia Location for Azure ,
WestIndia: WestIndia Location for Azure ,
JapanEast: JapanEast Location for Azure ,
JapanWest: JapanWest Location for Azure ,
KoreaCentral: KoreaCentral Location for Azure ,
KoreaSouth: KoreaSouth Location for Azure ,
UkWest: UkWest Location for Azure ,
UkSouth: UkSouth Location for Azure ,
NorthCentralUs: NorthCentralUs Location for Azure ,
EastUs: EastUs Location for Azure ,
WestUs2: WestUs2 Location for Azure ,
SouthCentralUs: SouthCentralUs Location for Azure ,
CentralUs: CentralUs Location for Azure ,
EastUs2: EastUs2 Location for Azure ,
WestUs: WestUs Location for Azure ,
WestCentralUs: WestCentralUs Location for Azure ,
GermanyCentral: GermanyCentral Location for Azure ,
GermanyNortheast: GermanyNortheast Location for Azure ,
ChinaNorth: ChinaNorth Location for Azure ,
ChinaEast: ChinaEast Location for Azure ,
USGovArizona: USGovArizona Location for Azure ,
USGovTexas: USGovTexas Location for Azure ,
USGovIowa: USGovIowa Location for Azure ,
USGovVirginia: USGovVirginia Location for Azure ,
USDoDCentral: USDoDCentral Location for Azure ,
USDoDEast: USDoDEast Location for Azure ,
FranceCentral: FranceCentral Location for Azure ,
AustraliaCentral: AustraliaCentral Location for Azure ,
SouthAfricaNorth: SouthAfricaNorth Location for Azure ,
FranceSouth: FranceSouth Location for Azure ,
AustraliaCentral2: AustraliaCentral2 Location for Azure ,
SouthAfricaWest: SouthAfricaWest Location for Azure ,
GermanyNorth: GermanyNorth Location for Azure ,
GermanyWestCentral: GermanyWestCentral Location for Azure ,
NorwayEast: NorwayEast Location for Azure ,
NorwayWest: NorwayWest Location for Azure ,
ChinaEast2: ChinaEast2 Location for Azure ,
ChinaNorth2: ChinaNorth2 Location for Azure ,
SwitzerlandNorth: SwitzerlandNorth Location for Azure ,
SwitzerlandWest: SwitzerlandWest Location for Azure ,
UAENorth: UAENorth Location for Azure ,
UAECentral: UAECentral Location for Azure ,
UsNatEast: UsNatEast Location for Azure ,
UsNatWest: UsNatWest Location for Azure ,
UsSecEast: UsSecEast Location for Azure ,
UsSecCentral: UsSecCentral Location for Azure ,
UsSecWest: UsSecWest Location for Azure ,
SwedenCentral: SwedenCentral Location for Azure ,
QatarCentral: QatarCentral Location for Azure ,
JioIndiaWest: JioIndiaWest Location for Azure ,
ItalyNorth: ItalyNorth Location for Azure ,
PolandCentral: PolandCentral Location for Azure ,
IsraelCentral: IsraelCentral Location for Azure ,
MexicoCentral: MexicoCentral Location for Azure ,
NewZealandNorth: NewZealandNorth Location for Azure ,
SpainCentral: SpainCentral Location for Azure ,
}
,
Required: False ,
}
enum ,
enableHadrAssessment:
{
Description: Gets or sets a value indicating whether HADR assessments needs to be created. ,
Required: False ,
}
boolean ,
azureSecurityOfferingType:
{
Description: Gets or sets a value indicating azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: False ,
}
enum ,
sqlServerLicense:
{
Description: SQL server license. ,
Enum:
{
Unknown: Unknown - Sql Server License ,
Yes: Has Sql Server License ,
No: No Sql Server License ,
}
,
Required: False ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3Operations_Delete (new)
Description :  Delete a SqlAssessmentV3
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlDatabaseV3Operations_ListByParent (new)
Description :  List AssessedSqlDatabaseV3 resources by SqlAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlDatabases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedSqlDatabaseV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
impactedObjects:
{
Description: Gets the list of impacted objects. ,
Required: False ,
}
[
{
objectName:
{
Description: Gets the object name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
shouldProvisionReplicas:
{
Description: Gets a value indicating whether replicas should be provisioned. ,
Required: False ,
}
boolean ,
skuReplicationMode:
{
Description: Gets the replication mode. ,
Enum:
{
NotApplicable: NotApplicable Sku Replication Mode ,
ActiveGeoReplication: ActiveGeoReplication Sku Replication Mode ,
FailoverGroupInstance: FailoverGroupInstance Sku Replication Mode ,
}
,
Required: False ,
}
enum ,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
recommendationReasonings:
{
Description: The product support status. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
migrationTargetPlatform:
{
Description: Gets the migration target platform. ,
Enum:
{
Unknown: Unknown - Target Type ,
Recommended: Recommended - Target Type ,
AzureSqlDatabase: AzureSqlDatabase - Target Type ,
AzureSqlManagedInstance: AzureSqlManagedInstance - Target Type ,
AzureSqlVirtualMachine: AzureSqlVirtualMachine - Target Type ,
AzureVirtualMachine: AzureVirtualMachine - Target Type ,
}
,
Required: False ,
}
enum ,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The sql db extended details. ,
Required: False ,
}
{
linkedAvailabilityGroupOverview:
{
Description: The linked availability group overview. ,
Required: False ,
}
{
availabilityGroupId:
{
Description: Gets the availability group id. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets the availability group name. ,
Required: False ,
}
string ,
sqlAvailabilityGroupSdsArmId:
{
Description: Gets the availability group arm id. ,
Required: False ,
}
string ,
sqlAvailabilityGroupEntityId:
{
Description: Gets the availability group entity id. ,
Required: False ,
}
string ,
sqlAvailabilityReplicaId:
{
Description: Gets the availability replica id. ,
Required: False ,
}
string ,
}
,
productSupportStatus:
{
Description: The product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
bufferCacheSizeInMB:
{
Description: the aggregated cache size of this database. ,
Format: float ,
Required: False ,
}
number ,
isDatabaseHighlyAvailable:
{
Description: The product support status. ,
Required: False ,
}
boolean ,
databaseSizeInMB:
{
Description: The product support status. ,
Format: float ,
Required: False ,
}
number ,
compatibilityLevel:
{
Description: Database compatibility level. ,
Enum:
{
Unknown: Unknown - Compatibility Level ,
CompatLevel80: CompatLevel80 - Compatibility Level ,
CompatLevel90: CompatLevel90 - Compatibility Level ,
CompatLevel100: CompatLevel100 - Compatibility Level ,
CompatLevel110: CompatLevel110 - Compatibility Level ,
CompatLevel120: CompatLevel120 - Compatibility Level ,
CompatLevel130: CompatLevel130 - Compatibility Level ,
CompatLevel140: CompatLevel140 - Compatibility Level ,
CompatLevel150: CompatLevel150 - Compatibility Level ,
}
,
Required: False ,
}
enum ,
percentageCoresUtilization:
{
Description: The percentage of the total number of cores being utilized by the SQL database. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: The read throughput of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: The write throughput of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: The read operations per second of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: The write operations per second of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
sqlVersion:
{
Description: Gets or sets the SQL version. ,
Required: True ,
}
string ,
sqlEdition:
{
Description: Gets or sets the SQL edition. ,
Required: True ,
}
string ,
isClustered:
{
Description: Gets or sets a value indicating whether the parent SQL instance is clustered or not. ,
Required: False ,
}
boolean ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether the high availability is enabled or not. ,
Required: False ,
}
boolean ,
}
,
createdTimestamp:
{
Description: When was assessed SQL database first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was assessed SQL database last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlDatabaseV3Operations_Get (new)
Description :  Get a AssessedSqlDatabaseV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
assessedSqlDatabaseName:
{
Description: Sql assessment Assessed Databases ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
impactedObjects:
{
Description: Gets the list of impacted objects. ,
Required: False ,
}
[
{
objectName:
{
Description: Gets the object name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
shouldProvisionReplicas:
{
Description: Gets a value indicating whether replicas should be provisioned. ,
Required: False ,
}
boolean ,
skuReplicationMode:
{
Description: Gets the replication mode. ,
Enum:
{
NotApplicable: NotApplicable Sku Replication Mode ,
ActiveGeoReplication: ActiveGeoReplication Sku Replication Mode ,
FailoverGroupInstance: FailoverGroupInstance Sku Replication Mode ,
}
,
Required: False ,
}
enum ,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
recommendationReasonings:
{
Description: The product support status. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
migrationTargetPlatform:
{
Description: Gets the migration target platform. ,
Enum:
{
Unknown: Unknown - Target Type ,
Recommended: Recommended - Target Type ,
AzureSqlDatabase: AzureSqlDatabase - Target Type ,
AzureSqlManagedInstance: AzureSqlManagedInstance - Target Type ,
AzureSqlVirtualMachine: AzureSqlVirtualMachine - Target Type ,
AzureVirtualMachine: AzureVirtualMachine - Target Type ,
}
,
Required: False ,
}
enum ,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The sql db extended details. ,
Required: False ,
}
{
linkedAvailabilityGroupOverview:
{
Description: The linked availability group overview. ,
Required: False ,
}
{
availabilityGroupId:
{
Description: Gets the availability group id. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets the availability group name. ,
Required: False ,
}
string ,
sqlAvailabilityGroupSdsArmId:
{
Description: Gets the availability group arm id. ,
Required: False ,
}
string ,
sqlAvailabilityGroupEntityId:
{
Description: Gets the availability group entity id. ,
Required: False ,
}
string ,
sqlAvailabilityReplicaId:
{
Description: Gets the availability replica id. ,
Required: False ,
}
string ,
}
,
productSupportStatus:
{
Description: The product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
bufferCacheSizeInMB:
{
Description: the aggregated cache size of this database. ,
Format: float ,
Required: False ,
}
number ,
isDatabaseHighlyAvailable:
{
Description: The product support status. ,
Required: False ,
}
boolean ,
databaseSizeInMB:
{
Description: The product support status. ,
Format: float ,
Required: False ,
}
number ,
compatibilityLevel:
{
Description: Database compatibility level. ,
Enum:
{
Unknown: Unknown - Compatibility Level ,
CompatLevel80: CompatLevel80 - Compatibility Level ,
CompatLevel90: CompatLevel90 - Compatibility Level ,
CompatLevel100: CompatLevel100 - Compatibility Level ,
CompatLevel110: CompatLevel110 - Compatibility Level ,
CompatLevel120: CompatLevel120 - Compatibility Level ,
CompatLevel130: CompatLevel130 - Compatibility Level ,
CompatLevel140: CompatLevel140 - Compatibility Level ,
CompatLevel150: CompatLevel150 - Compatibility Level ,
}
,
Required: False ,
}
enum ,
percentageCoresUtilization:
{
Description: The percentage of the total number of cores being utilized by the SQL database. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: The read throughput of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: The write throughput of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: The read operations per second of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: The write operations per second of the SQL database. ,
Format: float ,
Required: False ,
}
number ,
sqlVersion:
{
Description: Gets or sets the SQL version. ,
Required: True ,
}
string ,
sqlEdition:
{
Description: Gets or sets the SQL edition. ,
Required: True ,
}
string ,
isClustered:
{
Description: Gets or sets a value indicating whether the parent SQL instance is clustered or not. ,
Required: False ,
}
boolean ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether the high availability is enabled or not. ,
Required: False ,
}
boolean ,
}
,
createdTimestamp:
{
Description: When was assessed SQL database first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was assessed SQL database last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlInstanceV3Operations_ListByParent (new)
Description :  List AssessedSqlInstanceV3 resources by SqlAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedSqlInstanceV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
impactedObjects:
{
Description: Gets the list of impacted objects. ,
Required: False ,
}
[
{
objectName:
{
Description: Gets the object name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
shouldProvisionReplicas:
{
Description: Gets a value indicating whether replicas should be provisioned. ,
Required: False ,
}
boolean ,
skuReplicationMode:
{
Description: Gets the replication mode. ,
Enum:
{
NotApplicable: NotApplicable Sku Replication Mode ,
ActiveGeoReplication: ActiveGeoReplication Sku Replication Mode ,
FailoverGroupInstance: FailoverGroupInstance Sku Replication Mode ,
}
,
Required: False ,
}
enum ,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
recommendationReasonings:
{
Description: The product support status. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
migrationTargetPlatform:
{
Description: Gets the migration target platform. ,
Enum:
{
Unknown: Unknown - Target Type ,
Recommended: Recommended - Target Type ,
AzureSqlDatabase: AzureSqlDatabase - Target Type ,
AzureSqlManagedInstance: AzureSqlManagedInstance - Target Type ,
AzureSqlVirtualMachine: AzureSqlVirtualMachine - Target Type ,
AzureVirtualMachine: AzureVirtualMachine - Target Type ,
}
,
Required: False ,
}
enum ,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The sql instance extended details. ,
Required: False ,
}
{
memoryInUseInMB:
{
Description: Gets or sets the memory used by SQL instance in megabytes. ,
Format: float ,
Required: False ,
}
number ,
hasScanOccurred:
{
Description: Gets or sets a value indicating whether SQL instance has been deep discovered. ,
Required: False ,
}
boolean ,
storageTypeBasedDetails:
{
Description: Gets the storage details. ,
Required: False ,
}
[
{
storageType:
{
Description: Gets the storage type. ,
Required: False ,
}
string ,
diskSizeInMB:
{
Description: Gets the disk size in mb. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
fciMetadata:
{
Description: Gets the FCI metadata if this instance represents an FCI instance. ,
Required: False ,
}
{
state:
{
Description: Gets the Sql fci meta data state. ,
Enum:
{
Unknown: Unknown - Sql FCI Metadata State ,
Inherited: Inherited - Sql FCI Metadata State ,
Initializing: Initializing - Sql FCI Metadata State ,
Online: Online - Sql FCI Metadata State ,
Offline: Offline - Sql FCI Metadata State ,
Failed: Failed - Sql FCI Metadata State ,
Pending: Pending - Sql FCI Metadata State ,
OnlinePending: OnlinePending - Sql FCI Metadata State ,
OfflinePending: OfflinePending - Sql FCI Metadata State ,
}
,
Required: False ,
}
enum ,
isMultiSubnet:
{
Description: Gets whether fci is multi subnet. ,
Required: False ,
}
boolean ,
fciSharedDiskCount:
{
Description: Gets the fci shared disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityReplicaSummary:
{
Description: Gets the overview counts of availability replicas in the assessed instance, by commit mode and read type. ,
Required: False ,
}
{
numberOfSynchronousReadReplicas:
{
Description: Gets the number Of synchronous read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfSynchronousNonReadReplicas:
{
Description: Gets the number Of synchronous non read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAsynchronousReadReplicas:
{
Description: Gets the number Of asynchronous read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAsynchronousNonReadReplicas:
{
Description: Gets the number Of asynchronous non read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfPrimaryReplicas:
{
Description: Gets the number Of primary replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
isClustered:
{
Description: Gets a value indicating whether the SQL instance is clustered or not. ,
Required: False ,
}
boolean ,
isHighAvailabilityEnabled:
{
Description: Gets a value indicating whether the high availability is enabled or not. ,
Required: False ,
}
boolean ,
recommendedTargetReasonings:
{
Description: Gets the list of recommended target reasoning. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
sqlEdition:
{
Description: SQL instance edition. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: SQL instance version. ,
Required: False ,
}
string ,
numberOfCoresAllocated:
{
Description: Number of CPU cores assigned to the SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: The percentage of the total number of cores being utilized by the SQL instance. ,
Format: float ,
Required: False ,
}
number ,
logicalDisks:
{
Description: The logical disk details. ,
Required: False ,
}
[
{
diskId:
{
Description: Gets the disk id. ,
Required: False ,
}
string ,
diskSizeInMB:
{
Description: Gets the disk size in mb. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
databaseSummary:
{
Description: The databases summary. ,
Required: False ,
}
{
numberOfUserDatabases:
{
Description: Gets the number of user databases. ,
Format: int32 ,
Required: False ,
}
integer ,
totalDatabaseSizeInMB:
{
Description: Gets the total database size in MB. ,
Format: float ,
Required: False ,
}
number ,
largestDatabaseSizeInMB:
{
Description: Gets the largest database size in MB. ,
Format: float ,
Required: False ,
}
number ,
totalDiscoveredUserDatabases:
{
Description: Gets the total discovered user databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
createdTimestamp:
{
Description: When was assessed SQL instance first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was assessed SQL instance last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlInstanceV3Operations_Get (new)
Description :  Get a AssessedSqlInstanceV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
assessedSqlInstanceName:
{
Description: Sql assessment Assessed Instance ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
impactedObjects:
{
Description: Gets the list of impacted objects. ,
Required: False ,
}
[
{
objectName:
{
Description: Gets the object name. ,
Required: False ,
}
string ,
objectType:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
shouldProvisionReplicas:
{
Description: Gets a value indicating whether replicas should be provisioned. ,
Required: False ,
}
boolean ,
skuReplicationMode:
{
Description: Gets the replication mode. ,
Enum:
{
NotApplicable: NotApplicable Sku Replication Mode ,
ActiveGeoReplication: ActiveGeoReplication Sku Replication Mode ,
FailoverGroupInstance: FailoverGroupInstance Sku Replication Mode ,
}
,
Required: False ,
}
enum ,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
recommendationReasonings:
{
Description: The product support status. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
migrationTargetPlatform:
{
Description: Gets the migration target platform. ,
Enum:
{
Unknown: Unknown - Target Type ,
Recommended: Recommended - Target Type ,
AzureSqlDatabase: AzureSqlDatabase - Target Type ,
AzureSqlManagedInstance: AzureSqlManagedInstance - Target Type ,
AzureSqlVirtualMachine: AzureSqlVirtualMachine - Target Type ,
AzureVirtualMachine: AzureVirtualMachine - Target Type ,
}
,
Required: False ,
}
enum ,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
]
,
extendedDetails:
{
Description: The sql instance extended details. ,
Required: False ,
}
{
memoryInUseInMB:
{
Description: Gets or sets the memory used by SQL instance in megabytes. ,
Format: float ,
Required: False ,
}
number ,
hasScanOccurred:
{
Description: Gets or sets a value indicating whether SQL instance has been deep discovered. ,
Required: False ,
}
boolean ,
storageTypeBasedDetails:
{
Description: Gets the storage details. ,
Required: False ,
}
[
{
storageType:
{
Description: Gets the storage type. ,
Required: False ,
}
string ,
diskSizeInMB:
{
Description: Gets the disk size in mb. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
fciMetadata:
{
Description: Gets the FCI metadata if this instance represents an FCI instance. ,
Required: False ,
}
{
state:
{
Description: Gets the Sql fci meta data state. ,
Enum:
{
Unknown: Unknown - Sql FCI Metadata State ,
Inherited: Inherited - Sql FCI Metadata State ,
Initializing: Initializing - Sql FCI Metadata State ,
Online: Online - Sql FCI Metadata State ,
Offline: Offline - Sql FCI Metadata State ,
Failed: Failed - Sql FCI Metadata State ,
Pending: Pending - Sql FCI Metadata State ,
OnlinePending: OnlinePending - Sql FCI Metadata State ,
OfflinePending: OfflinePending - Sql FCI Metadata State ,
}
,
Required: False ,
}
enum ,
isMultiSubnet:
{
Description: Gets whether fci is multi subnet. ,
Required: False ,
}
boolean ,
fciSharedDiskCount:
{
Description: Gets the fci shared disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityReplicaSummary:
{
Description: Gets the overview counts of availability replicas in the assessed instance, by commit mode and read type. ,
Required: False ,
}
{
numberOfSynchronousReadReplicas:
{
Description: Gets the number Of synchronous read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfSynchronousNonReadReplicas:
{
Description: Gets the number Of synchronous non read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAsynchronousReadReplicas:
{
Description: Gets the number Of asynchronous read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfAsynchronousNonReadReplicas:
{
Description: Gets the number Of asynchronous non read replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfPrimaryReplicas:
{
Description: Gets the number Of primary replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
isClustered:
{
Description: Gets a value indicating whether the SQL instance is clustered or not. ,
Required: False ,
}
boolean ,
isHighAvailabilityEnabled:
{
Description: Gets a value indicating whether the high availability is enabled or not. ,
Required: False ,
}
boolean ,
recommendedTargetReasonings:
{
Description: Gets the list of recommended target reasoning. ,
Required: False ,
}
[
{
reasoningId:
{
Description: Gets the reasoning id. ,
Required: False ,
}
string ,
reasoningString:
{
Description: Gets the reasoning status. ,
Required: False ,
}
string ,
reasoningCategory:
{
Description: Gets the reasoning category. ,
Required: False ,
}
string ,
contextParameters:
{
Description: Gets the Sql recommended reasoning parameters. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
sqlEdition:
{
Description: SQL instance edition. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: SQL instance version. ,
Required: False ,
}
string ,
numberOfCoresAllocated:
{
Description: Number of CPU cores assigned to the SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: The percentage of the total number of cores being utilized by the SQL instance. ,
Format: float ,
Required: False ,
}
number ,
logicalDisks:
{
Description: The logical disk details. ,
Required: False ,
}
[
{
diskId:
{
Description: Gets the disk id. ,
Required: False ,
}
string ,
diskSizeInMB:
{
Description: Gets the disk size in mb. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
databaseSummary:
{
Description: The databases summary. ,
Required: False ,
}
{
numberOfUserDatabases:
{
Description: Gets the number of user databases. ,
Format: int32 ,
Required: False ,
}
integer ,
totalDatabaseSizeInMB:
{
Description: Gets the total database size in MB. ,
Format: float ,
Required: False ,
}
number ,
largestDatabaseSizeInMB:
{
Description: Gets the largest database size in MB. ,
Format: float ,
Required: False ,
}
number ,
totalDiscoveredUserDatabases:
{
Description: Gets the total discovered user databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
createdTimestamp:
{
Description: When was assessed SQL instance first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was assessed SQL instance last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlMachinesV3Operations_ListByParent (new)
Description :  List AssessedSqlMachineV3 resources by SqlAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter query. ,
Required: False ,
}
string ,
pageSize:
{
Description: Optional parameter for page size. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total record count. ,
Format: int32 ,
Required: False ,
}
integer ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedSqlMachineV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
extendedDetails:
{
Description: The sql instance extended details. ,
Required: False ,
}
{
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID for the machine. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN for the machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
disks:
{
Description: Gets the list of data disks that were assessed as part of this assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
displayName:
{
Description: The disk display name. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gets the gigabytes provisioned. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
networkAdapters:
{
Description: Gets the list of network adapters that were assessed as part of this assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
netGigabytesTransmittedPerMonth:
{
Description: Gets the net gigabytes transmitted per month. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: Gets the mac address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: Gets the ip addresses. ,
Required: False ,
}
[
string ,
]
,
megabytesPerSecondRecieved:
{
Description: Gets the megabytes per second received. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the megabytes per second transmitted. ,
Format: float ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
}
,
]
,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
}
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedSqlMachinesV3Operations_Get (new)
Description :  Get a AssessedSqlMachineV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
assessedSqlMachineName:
{
Description: Sql assessment Assessed Machine ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
migrationGuidelines:
{
Description: Gets the list of migration guidelines applicable to this target. ,
Required: False ,
}
[
{
guidelineId:
{
Description: Gets the guideline id. ,
Required: False ,
}
string ,
migrationGuidelineCategory:
{
Description: Gets the migration guideline category. ,
Enum:
{
Unknown: Unknown - Sql Migration Guideline Category ,
General: General - Sql Migration Guideline Category ,
FailoverCluterInstanceGuideLine: FailoverCluterInstanceGuideLine - Sql Migration Guideline Category ,
AvailabilityGroupGuideline: AvailabilityGroupGuideline - Sql Migration Guideline Category ,
}
,
Required: False ,
}
enum ,
migrationGuidelineContext:
{
Description: Gets the migration guideline context. ,
Required: False ,
}
[
{
contextKey:
{
Description: Gets the reasoning context key. ,
Required: False ,
}
string ,
contextValue:
{
Description: Gets the reasoning context value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
extendedDetails:
{
Description: The sql instance extended details. ,
Required: False ,
}
{
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID for the machine. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN for the machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: Gets the product support status related details. ,
Required: False ,
}
{
currentVersion:
{
Description: Gets or sets current version of ServicePack. ,
Required: False ,
}
string ,
servicePackStatus:
{
Description: Gets or sets ServicePack of the product. ,
Required: False ,
}
string ,
esuStatus:
{
Description: Gets or sets the Extended Security Update ESU status. ,
Required: False ,
}
string ,
supportStatus:
{
Description: Gets or sets the support status of the product. ,
Required: False ,
}
string ,
eta:
{
Description: Gets or sets the ETA. ,
Format: int32 ,
Required: False ,
}
integer ,
currentEsuYear:
{
Description: Gets or sets the current ESU support year. ,
Required: False ,
}
string ,
mainstreamEndDate:
{
Description: Gets or sets the main stream end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSupportEndDate:
{
Description: Gets or sets the extended support end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear1EndDate:
{
Description: Gets or sets the extended security update year 1 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear2EndDate:
{
Description: Gets or sets the extended security update year 2 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
extendedSecurityUpdateYear3EndDate:
{
Description: Gets or sets the extended security update year 3 end date of the product. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
disks:
{
Description: Gets the list of data disks that were assessed as part of this assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
displayName:
{
Description: The disk display name. ,
Required: False ,
}
string ,
gigabytesProvisioned:
{
Description: Gets the gigabytes provisioned. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfRead:
{
Description: Gets the megabytes per second of read. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Gets the megabytes per second of write. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Gets the number of read operations per second. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Gets the number of write operations per second. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
networkAdapters:
{
Description: Gets the list of network adapters that were assessed as part of this assessment. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
netGigabytesTransmittedPerMonth:
{
Description: Gets the net gigabytes transmitted per month. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: Gets the mac address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: Gets the ip addresses. ,
Required: False ,
}
[
string ,
]
,
megabytesPerSecondRecieved:
{
Description: Gets the megabytes per second received. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondTransmitted:
{
Description: Gets the megabytes per second transmitted. ,
Format: float ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the Machine. ,
Required: False ,
}
string ,
}
,
]
,
bootType:
{
Description: Boot type of machine discovered in private data center. ,
Enum:
{
Unknown: Unknown - Machine Boot Type ,
EFI: EFI - Machine Boot Type ,
BIOS: BIOS - Machine Boot Type ,
NotSpecified: NotSpecified - Machine Boot Type ,
}
,
Required: False ,
}
enum ,
operatingSystemType:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemName:
{
Description: Operating system as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Operating system version as reported by datacenter management solution. ,
Required: False ,
}
string ,
operatingSystemArchitecture:
{
Description: Operating system architecture as reported by datacenter management solution. ,
Enum:
{
Unknown: Unknown - Guest operating system architecture ,
X86: X86 - Guest operating system architecture ,
X64: X64 - Guest operating system architecture ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description for the machine. ,
Required: False ,
}
string ,
megabytesOfMemory:
{
Description: Megabytes of memory found allocated for the machine in private data center. ,
Format: float ,
Required: False ,
}
number ,
numberOfCores:
{
Description: Number of CPU cores found on the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageCoresUtilization:
{
Description: Percentile of Percentage of Cores Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Percentile of Percentage of Memory Utilized noted during time period T. Here N and T are settings on Assessment. ,
Format: float ,
Required: False ,
}
number ,
}
,
assessedMachineType:
{
Description: Assessed machine type. ,
Enum:
{
Unknown: Unknown - Assessed machine type ,
AssessedMachine: AssessedMachine - Assessed machine type ,
AvsAssessedMachine: AvsAssessedMachine - Assessed machine type ,
SqlAssessedMachine: SqlAssessedMachine - Assessed machine type ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: When was machine first created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: When was machine last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3Operations_DownloadUrl (new)
Description :  Get the URL for downloading the assessment in a report format.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3SummaryOperations_ListByParent (new)
Description :  List SqlAssessmentV3Summary resources by SqlAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlAssessmentV3Summary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAssessmentV3SummaryOperations_Get (new)
Description :  Get a SqlAssessmentV3Summary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: SQL Assessment arm name. ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the SQL Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppGraphAssessmentOptionsOperations_ListByParent (new)
Description :  List WepAppGraphAssessmentOptions resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WepAppGraphAssessmentOptions items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppGraphAssessmentOptionsOperations_Get (new)
Description :  Get a WepAppGraphAssessmentOptions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edges:
{
Description: Gets or sets the edges. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3Operations_ListByParent (new)
Description :  List WebAppAssessmentV3 resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppAssessmentV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
appSvcNativeSettings:
{
Description: App Service native settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
appSvcContainerSettings:
{
Description: App Service container settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
azureSecurityOfferingType:
{
Description: Azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3Operations_Get (new)
Description :  Get a WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
appSvcNativeSettings:
{
Description: App Service native settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
appSvcContainerSettings:
{
Description: App Service container settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
azureSecurityOfferingType:
{
Description: Azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3Operations_Create (new)
Description :  Create a WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
appSvcNativeSettings:
{
Description: App Service native settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
appSvcContainerSettings:
{
Description: App Service container settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
azureSecurityOfferingType:
{
Description: Azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
appSvcNativeSettings:
{
Description: App Service native settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
appSvcContainerSettings:
{
Description: App Service container settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
azureSecurityOfferingType:
{
Description: Azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: WebApp assessment resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: Gets or sets the scope of assessment. ,
Required: False ,
}
{
scopeType:
{
Description: The scope type ,
Enum:
{
ServerGroupId: ServerGroupId - Scope type ,
AzureResourceGraphQuery: AzureResourceGraphQuery - Scope type ,
}
,
Required: False ,
}
enum ,
serverGroupId:
{
Description: The server group arm id. ,
Required: False ,
}
string ,
azureResourceGraphQuery:
{
Description: The ARG query. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Gets or sets the settings for the assessment. ,
Required: False ,
}
{
azureLocation:
{
Description: Azure Location or Azure region where to which the machines will be migrated. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which prices should be reported. ,
Enum:
{
Unknown: Unknown Currency for Azure ,
USD: USD Currency for Azure ,
DKK: DKK Currency for Azure ,
CAD: CAD Currency for Azure ,
IDR: IDR Currency for Azure ,
JPY: JPY Currency for Azure ,
KRW: KRW Currency for Azure ,
NZD: NZD Currency for Azure ,
NOK: NOK Currency for Azure ,
RUB: RUB Currency for Azure ,
SAR: SAR Currency for Azure ,
ZAR: ZAR Currency for Azure ,
SEK: SEK Currency for Azure ,
TRY: TRY Currency for Azure ,
GBP: GBP Currency for Azure ,
MXN: MXN Currency for Azure ,
MYR: MYR Currency for Azure ,
INR: INR Currency for Azure ,
HKD: HKD Currency for Azure ,
BRL: BRL Currency for Azure ,
TWD: TWD Currency for Azure ,
EUR: EUR Currency for Azure ,
CHF: CHF Currency for Azure ,
ARS: ARS Currency for Azure ,
AUD: AUD Currency for Azure ,
CNY: CNY Currency for Azure ,
}
,
Required: False ,
}
enum ,
scalingFactor:
{
Description: Percentage of buffer that user wants on performance metrics when recommending Azure sizes. ,
Format: float ,
Required: False ,
}
number ,
discountPercentage:
{
Description: Custom discount percentage. ,
Format: float ,
Required: False ,
}
number ,
sizingCriterion:
{
Description: Assessment sizing criterion. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
performanceData:
{
Description: Gets or sets the performance data. ,
Required: False ,
}
{
percentile:
{
Description: Percentile of the utilization data values to be considered while assessing machines. ,
Enum:
{
Percentile50: Percentile 50. ,
Percentile90: Percentile 90. ,
Percentile95: Percentile 95. ,
Percentile99: Percentile 99. ,
PercentileUnknown: Percentile unknown. ,
}
,
Required: False ,
}
enum ,
timeRange:
{
Description: Time Range for which the historic utilization data should be considered for assessment. ,
Enum:
{
Day: Daily. ,
Week: Weekly. ,
Month: Monthly. ,
Custom: Custom Time Range. ,
}
,
Required: False ,
}
enum ,
perfDataStartTime:
{
Description: Gets or sets the start time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
perfDataEndTime:
{
Description: Gets or sets the end time to consider performance data for assessment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
savingsSettings:
{
Description: Gets or sets the savings settings. ,
Required: False ,
}
{
savingsOptions:
{
Description: Gets or sets the savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
azureOfferCode:
{
Description: Gets or sets the Azure offer code. ,
Enum:
{
Unknown: Unknown - Azure Offer ,
MSAZR0003P: MSAZR0003P Azure Offer ,
MSAZR0023P: MSAZR0023P Azure Offer ,
MSMCAZR0044P: MSMCAZR0044P Azure Offer ,
MSMCAZR0059P: MSMCAZR0059P Azure Offer ,
MSMCAZR0060P: MSMCAZR0060P Azure Offer ,
MSMCAZR0063P: MSMCAZR0063P Azure Offer ,
MSAZRUSGOV0003P: MSAZRUSGOV0003P Azure Offer ,
EA: EA Azure Offer ,
SavingsPlan1Year: SavingsPlan1Year Azure Offer ,
SavingsPlan3Year: SavingsPlan3Year Azure Offer ,
}
,
Required: False ,
}
enum ,
}
,
billingSettings:
{
Description: Gets or sets the billing settings. ,
Required: False ,
}
{
licensingProgram:
{
Description: Gets or sets the licensing program. ,
Enum:
{
Retail: Retail/Pay as you go. ,
Unknown: Not known ,
EA: Enterprise agreement. ,
MCA: Microsoft customer agreement. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Gets or sets the subscription ID for licensing program selected. ,
Required: False ,
}
string ,
}
,
environmentType:
{
Description: Gets or sets user configurable setting to display the environment type. ,
Enum:
{
Production: Production - Environment Type ,
Unknown: Unknown - Environment Type ,
DevTest: DevTest - Environment Type ,
}
,
Required: False ,
}
enum ,
appSvcNativeSettings:
{
Description: App Service native settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
appSvcContainerSettings:
{
Description: App Service container settings. ,
Required: True ,
}
{
isolationRequired:
{
Description: Gets or sets the isolation required. ,
Required: True ,
}
boolean ,
}
,
azureSecurityOfferingType:
{
Description: Azure security offering type. ,
Enum:
{
NO: NO - Azure Security Offering Type ,
MDC: MDC - Azure Security Offering Type ,
}
,
Required: True ,
}
enum ,
}
,
details:
{
Description: Gets or sets the details of the assessment. ,
Required: False ,
}
{
confidenceRatingInPercentage:
{
Description: Confidence Rating in Percentage. ,
Format: float ,
Required: False ,
}
number ,
pricesTimestamp:
{
Description: Last time when rates were queried. ,
Format: date-time ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date and Time when assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Date and Time when assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Whether assessment is in valid state and all machines have been assessed. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: False ,
}
enum ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Gets or sets the machine assessment ARM ID for VM fallback. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3Operations_Delete (new)
Description :  Delete a WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedWebAppsV3Operations_ListByParent (new)
Description :  List AssessedWebAppV3 resources by WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/assessedWebApps
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessedWebAppV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
createdTimestamp:
{
Description: Timestamp of the assessment creation. ,
Required: True ,
}
string ,
updatedTimestamp:
{
Description: Timestamp of the assessment last updated. ,
Required: True ,
}
string ,
webAppType:
{
Description: Type of assessed webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessedWebAppsV3Operations_Get (new)
Description :  Get a AssessedWebAppV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
assessedWebAppName:
{
Description: Assessed web app ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workloadType:
{
Description: The workload type ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
linkages:
{
Description: The linkages list. ,
Required: False ,
}
[
{
workloadName:
{
Description: The workload name ,
Required: False ,
}
string ,
linkageType:
{
Description: The linkage type. ,
Enum:
{
Parent: Parent - Linkage type ,
Source: Source - Linkage type ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: The linkage kind. ,
Enum:
{
Unknown: Unknown - Linkage kind ,
Machine: Machine - Linkage kind ,
Server: Server - Linkage kind ,
Instance: Instance - Linkage kind ,
WebServer: WebServer - Linkage kind ,
WebApplication: WebApplication - Linkage kind ,
Database: Database - Linkage kind ,
}
,
Required: False ,
}
enum ,
armId:
{
Description: The arm id. ,
Required: False ,
}
string ,
}
,
]
,
recommendations:
{
Description: The recommendation list. ,
Required: False ,
}
[
{
configuration:
{
Description: The configuration data. ,
Required: False ,
}
{
azureTarget:
{
Description: The azure target. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sizingCriterion:
{
Description: The azure target. ,
Enum:
{
PerformanceBased: Performance Data based Sizing. ,
AsOnPremises: As On Premises or Static Data based Sizing. ,
}
,
Required: False ,
}
enum ,
}
,
recommendedFor:
{
Description: The recommended details. ,
Required: False ,
}
{
strategies:
{
Description: The list of strategy type. ,
Required: False ,
}
[
string ,
]
,
}
,
migrationPlatform:
{
Description: The migration Platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
confidenceScore:
{
Description: The confidence score. ,
Format: float ,
Required: False ,
}
number ,
migrationSuitability:
{
Description: The migration suitability. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
securitySuitability:
{
Description: The security suitability. ,
Required: False ,
}
{
readiness:
{
Description: The security suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
totalCost:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The total cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
migrationIssues:
{
Description: The migration issues list. ,
Required: False ,
}
[
{
issueCode:
{
Description: The issue id. ,
Required: False ,
}
string ,
issueCategory:
{
Description: The issue category. ,
Enum:
{
Issue: Issue - Migration Issues Category ,
Warning: Warning - Migration Issues Category ,
Internal: Internal - Migration Issues Category ,
}
,
Required: False ,
}
enum ,
issueDescription:
{
Description: The issue description. ,
Required: False ,
}
string ,
possibleCause:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedActions:
{
Description: The recommended action. ,
Required: False ,
}
[
string ,
]
,
moreInformation:
{
Description: The more information list. ,
Required: False ,
}
[
{
title:
{
Description: The title of the information. ,
Required: True ,
}
string ,
url:
{
Description: The URL of the information. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
skus:
{
Description: The Skus list. ,
Required: False ,
}
[
{
kind:
{
Description: The Sku kind. ,
Enum:
{
Endpoint: Endpoint - Sku Kind ,
Details: Details - Sku Kind ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri. ,
Required: False ,
}
string ,
displayName:
{
Description: The sku name. ,
Required: False ,
}
string ,
id:
{
Description: The sku id. ,
Required: False ,
}
string ,
type:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
sources:
{
Description: The source name. ,
Required: False ,
}
[
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
migrationSuitability:
{
Description: The sku type. ,
Required: False ,
}
{
readiness:
{
Description: The migration suitability. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
details:
{
Description: The sku details. ,
Required: False ,
}
{
skuType:
{
Description: The sku type. ,
Enum:
{
Unknown: Unknown - Sku type ,
Compute: Compute - Sku type ,
Storage: Storage - Sku type ,
Network: Network - Sku type ,
AppServicePlan: AppServicePlan - Sku type ,
AzureSpringApps: AzureSpringApps - Sku type ,
}
,
Required: False ,
}
enum ,
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
value:
{
Description: The value. ,
Required: False ,
}
string ,
}
,
]
,
totalCost:
{
Description: The sku cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
totalSavings:
{
Description: The sku savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
createdTimestamp:
{
Description: Timestamp of the assessment creation. ,
Required: True ,
}
string ,
updatedTimestamp:
{
Description: Timestamp of the assessment last updated. ,
Required: True ,
}
string ,
webAppType:
{
Description: Type of assessed webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3Operations_DownloadUrl (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3SummaryOperations_ListByParent (new)
Description :  List WebAppAssessmentV3Summary resources by WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppAssessmentV3Summary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
discoveredEntityLightSummary:
{
Description: Light summary of the discovered entity. ,
Required: False ,
}
{
numberOfServers:
{
Description: Gets or sets the number of servers. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfWebApps:
{
Description: Gets or sets the number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfMachines:
{
Description: Gets or sets the number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppAssessmentV3SummaryOperations_Get (new)
Description :  Get a WebAppAssessmentV3Summary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the WebApp assessment Summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
discoveredEntityLightSummary:
{
Description: Light summary of the discovered entity. ,
Required: False ,
}
{
numberOfServers:
{
Description: Gets or sets the number of servers. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfWebApps:
{
Description: Gets or sets the number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfMachines:
{
Description: Gets or sets the number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppServicePlansOperations_ListByParent (new)
Description :  List WebAppServicePlanV3 resources by WebAppAssessmentV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/webAppServicePlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppServicePlanV3 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
webAppTargetType:
{
Description: Target type of the webapp. ,
Enum:
{
Unknown: Unknown - Web App Target type ,
AzureAppService: AzureAppService - Web App Target type ,
AzureAppServiceContainer: AzureAppServiceContainer - Web App Target type ,
}
,
Required: True ,
}
enum ,
webAppType:
{
Description: Type of webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
webAppServicePlanName:
{
Description: Webapp service plan name. ,
Required: True ,
}
string ,
numberOfWebApps:
{
Description: Number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Monthly cost of the web app service plan. ,
Format: double ,
Required: True ,
}
number ,
storage:
{
Description: Storage used by the web app service plan. ,
Format: double ,
Required: True ,
}
number ,
scaleOutInstances:
{
Description: Number of scale-out instances. ,
Format: int32 ,
Required: True ,
}
integer ,
cores:
{
Description: Number of cores. ,
Format: int32 ,
Required: True ,
}
integer ,
ram:
{
Description: Amount of RAM. ,
Format: double ,
Required: True ,
}
number ,
webAppSkuName:
{
Description: SKU name of the web app. ,
Required: True ,
}
string ,
webAppSkuSize:
{
Description: SKU size of the web app. ,
Required: True ,
}
string ,
createdTimestamp:
{
Description: Timestamp when the web app service plan was created. ,
Format: date-time ,
Required: True ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the web app service plan was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
costComponents:
{
Description: Cost components of the web app service plan. ,
Required: True ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
Unknown: Unknown Cost Component ,
MonthlyAzureHybridCostSavings: Monthly Azure Hybrid Cost Savings ,
MonthlySecurityCost: Monthly Security Cost ,
MonthlyPremiumV2StorageCost: Monthly Premium V2 Storage Cost ,
MonthlyLinuxAzureHybridCostSavings: Monthly Linux Azure Hybrid Cost Savings ,
MonthlyAvsNodeCost: Monthly Avs Node Cost ,
MonthlyExternalStorageCost: Monthly External Storage Cost ,
MonthlyNetworkCost: Monthly Network Cost ,
MonthlyVcfByolCostDifference: Monthly Vcf Byol Cost Difference ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebAppServicePlansOperations_Get (new)
Description :  Get a WebAppServicePlanV3
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessments/{assessmentName}/webAppServicePlans/{servicePlanName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
assessmentName:
{
Description: WebApp Assessment ARM name ,
Required: True ,
}
string ,
servicePlanName:
{
Description: Gets the Name of the WebApp assessment service plan. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
webAppTargetType:
{
Description: Target type of the webapp. ,
Enum:
{
Unknown: Unknown - Web App Target type ,
AzureAppService: AzureAppService - Web App Target type ,
AzureAppServiceContainer: AzureAppServiceContainer - Web App Target type ,
}
,
Required: True ,
}
enum ,
webAppType:
{
Description: Type of webapp. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
webAppServicePlanName:
{
Description: Webapp service plan name. ,
Required: True ,
}
string ,
numberOfWebApps:
{
Description: Number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
monthlyCost:
{
Description: Monthly cost of the web app service plan. ,
Format: double ,
Required: True ,
}
number ,
storage:
{
Description: Storage used by the web app service plan. ,
Format: double ,
Required: True ,
}
number ,
scaleOutInstances:
{
Description: Number of scale-out instances. ,
Format: int32 ,
Required: True ,
}
integer ,
cores:
{
Description: Number of cores. ,
Format: int32 ,
Required: True ,
}
integer ,
ram:
{
Description: Amount of RAM. ,
Format: double ,
Required: True ,
}
number ,
webAppSkuName:
{
Description: SKU name of the web app. ,
Required: True ,
}
string ,
webAppSkuSize:
{
Description: SKU size of the web app. ,
Required: True ,
}
string ,
createdTimestamp:
{
Description: Timestamp when the web app service plan was created. ,
Format: date-time ,
Required: True ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the web app service plan was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
costComponents:
{
Description: Cost components of the web app service plan. ,
Required: True ,
}
[
{
name:
{
Description: Gets the name of the component. ,
Enum:
{
Unknown: Unknown Cost Component ,
MonthlyAzureHybridCostSavings: Monthly Azure Hybrid Cost Savings ,
MonthlySecurityCost: Monthly Security Cost ,
MonthlyPremiumV2StorageCost: Monthly Premium V2 Storage Cost ,
MonthlyLinuxAzureHybridCostSavings: Monthly Linux Azure Hybrid Cost Savings ,
MonthlyAvsNodeCost: Monthly Avs Node Cost ,
MonthlyExternalStorageCost: Monthly External Storage Cost ,
MonthlyNetworkCost: Monthly Network Cost ,
MonthlyVcfByolCostDifference: Monthly Vcf Byol Cost Difference ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the component. ,
Format: float ,
Required: False ,
}
number ,
description:
{
Description: The textual description of the component. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentOperations_ListByParent (new)
Description :  List CompoundAssessment resources by AssessmentProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CompoundAssessment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
targetAssessmentArmIds:
{
Description: ARM IDs of the target assessments. ,
Required: True ,
}
{
aks:
{
Description: ARM ID for Azure Kubernetes Service assessment. ,
Required: False ,
}
string ,
azureAppService:
{
Description: ARM ID for Azure App Service assessment. ,
Required: False ,
}
string ,
azureAppServiceContainer:
{
Description: ARM ID for Azure App Service Container assessment. ,
Required: False ,
}
string ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Fallback machine assessment ARM ID. ,
Required: False ,
}
string ,
details:
{
Description: Details of the compound assessment. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Timestamp when the assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the assessment. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentOperations_Get (new)
Description :  Get a CompoundAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
targetAssessmentArmIds:
{
Description: ARM IDs of the target assessments. ,
Required: True ,
}
{
aks:
{
Description: ARM ID for Azure Kubernetes Service assessment. ,
Required: False ,
}
string ,
azureAppService:
{
Description: ARM ID for Azure App Service assessment. ,
Required: False ,
}
string ,
azureAppServiceContainer:
{
Description: ARM ID for Azure App Service Container assessment. ,
Required: False ,
}
string ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Fallback machine assessment ARM ID. ,
Required: False ,
}
string ,
details:
{
Description: Details of the compound assessment. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Timestamp when the assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the assessment. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentOperations_Create (new)
Description :  Create a CompoundAssessment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
targetAssessmentArmIds:
{
Description: ARM IDs of the target assessments. ,
Required: True ,
}
{
aks:
{
Description: ARM ID for Azure Kubernetes Service assessment. ,
Required: False ,
}
string ,
azureAppService:
{
Description: ARM ID for Azure App Service assessment. ,
Required: False ,
}
string ,
azureAppServiceContainer:
{
Description: ARM ID for Azure App Service Container assessment. ,
Required: False ,
}
string ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Fallback machine assessment ARM ID. ,
Required: False ,
}
string ,
details:
{
Description: Details of the compound assessment. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Timestamp when the assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the assessment. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
targetAssessmentArmIds:
{
Description: ARM IDs of the target assessments. ,
Required: True ,
}
{
aks:
{
Description: ARM ID for Azure Kubernetes Service assessment. ,
Required: False ,
}
string ,
azureAppService:
{
Description: ARM ID for Azure App Service assessment. ,
Required: False ,
}
string ,
azureAppServiceContainer:
{
Description: ARM ID for Azure App Service Container assessment. ,
Required: False ,
}
string ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Fallback machine assessment ARM ID. ,
Required: False ,
}
string ,
details:
{
Description: Details of the compound assessment. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Timestamp when the assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the assessment. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Compound assessment resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
targetAssessmentArmIds:
{
Description: ARM IDs of the target assessments. ,
Required: True ,
}
{
aks:
{
Description: ARM ID for Azure Kubernetes Service assessment. ,
Required: False ,
}
string ,
azureAppService:
{
Description: ARM ID for Azure App Service assessment. ,
Required: False ,
}
string ,
azureAppServiceContainer:
{
Description: ARM ID for Azure App Service Container assessment. ,
Required: False ,
}
string ,
}
,
fallbackMachineAssessmentArmId:
{
Description: Fallback machine assessment ARM ID. ,
Required: False ,
}
string ,
details:
{
Description: Details of the compound assessment. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Timestamp when the assessment was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp when the assessment was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the assessment. ,
Enum:
{
Created: Assessment is Created. ,
Updated: Assessment is Updated. ,
Running: Assessment is currently running. ,
Completed: Assessment is Completed or Ready. ,
Invalid: Assessment is Failed i.e. it is now invalid. ,
OutOfSync: Assessment is Out of Sync. ,
OutDated: Assessment is Out Dated. ,
Deleted: Assessment is Deleted. ,
Failed: Assessment has Failed. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentOperations_Delete (new)
Description :  Delete a CompoundAssessment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentOperations_DownloadUrl (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}/downloadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
assessmentReportUrl:
{
Description: Hyperlink to download report. ,
Required: True ,
}
string ,
expirationTime:
{
Description: Expiry date of download url. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentSummaryOperations_ListByParent (new)
Description :  List WebAppCompoundAssessmentSummary resources by CompoundAssessment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppCompoundAssessmentSummary items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
assessmentName:
{
Description: Name of the assessment. ,
Required: False ,
}
string ,
discoveredLightSummary:
{
Description: Light summary of the compound assessment. ,
Required: False ,
}
{
numberOfWebApps:
{
Description: Number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfWebAppsPerType:
{
Description: Number of web apps per type. ,
Required: False ,
}
[
{
webAppType:
{
Description: Name of the web app type. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
ASP.Net: ASP.NET Web App. ,
Java: Java Web App. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: Count of the web app type. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
numberOfWebServersPerType:
{
Description: Number of web servers per type. ,
Required: False ,
}
[
{
webServerType:
{
Description: Name of the web app type. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: Count of the web app type. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
numberOfWebServers:
{
Description: Number of web servers. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfServers:
{
Description: Number of servers. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CompoundAssessmentSummaryOperations_Get (new)
Description :  Get a WebAppCompoundAssessmentSummary
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCompoundAssessments/{compoundAssessmentName}/summaries/{summaryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Assessment Project Name ,
Required: True ,
}
string ,
compoundAssessmentName:
{
Description: Compound Assessment ARM name ,
Required: True ,
}
string ,
summaryName:
{
Description: Gets the Name of the WebApp compound assessment summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The summary type ,
Enum:
{
Unknown: Unknown - Summary Type ,
Strategy: Strategy - Summary Type ,
Target: Target - Summary Type ,
}
,
Required: False ,
}
enum ,
summaryName:
{
Description: The summary name ,
Required: False ,
}
string ,
sources:
{
Description: The source details list. ,
Required: False ,
}
[
{
sourceName:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: The source type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targets:
{
Description: The target details list. ,
Required: False ,
}
[
{
targetName:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: The target type. ,
Enum:
{
Unknown: Unknown - Migration Workload type ,
Machine: Machine - Migration Workload type ,
Server: Server - Migration Workload type ,
Instance: Instance - Migration Workload type ,
WebServer: WebServer - Migration Workload type ,
WebApplication: WebApplication - Migration Workload type ,
Database: Database - Migration Workload type ,
Host: Host - Migration Workload type ,
ManagementServer: ManagementServer - Migration Workload type ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The migration platform. ,
Enum:
{
Unknown: Unknown - Migration Platform ,
PaaS: PaaS - Migration Platform ,
IaaS: IaaS - Migration Platform ,
SaaS: SaaS - Migration Platform ,
}
,
Required: False ,
}
enum ,
count:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetSourceMapping:
{
Description: The target source mapping. ,
Required: False ,
}
[
{
sourceRef:
{
Description: The source name. ,
Enum:
{
Unknown: Unknown - Assessment Source ,
Machine: Machine - Assessment Source ,
IIS: IIS - Assessment Source ,
TomCat: TomCat - Assessment Source ,
OracleServer: OracleServer - Assessment Source ,
OracleDatabase: OracleDatabase - Assessment Source ,
SAPInstance: SAPInstance - Assessment Source ,
SpringbootApplication: SpringbootApplication - Assessment Source ,
MySQLServer: MySQLServer - Assessment Source ,
SqlInstance: SqlInstance - Assessment Source ,
SqlDatabase: SqlDatabase - Assessment Source ,
WebApps: WebApps - Assessment Source ,
}
,
Required: False ,
}
enum ,
targetRef:
{
Description: The target name. ,
Enum:
{
Unknown: Unknown - Azure Target ,
SqlDatabase: SqlDatabase - Azure Target ,
SqlMI: SqlMI - Azure Target ,
FlexServerPG: FlexServerPG - Azure Target ,
OracleIaasVM: OracleIaasVM - Azure Target ,
AzureSpringApps: AzureSpringApps - Azure Target ,
SAPAzureInstance: SAPAzureInstance - Azure Target ,
AKS: AKS - Azure Target ,
MySQLAzureFlexServer: MySQLAzureFlexServer - Azure Target ,
AzureSQLVM: AzureSQLVM - Azure Target ,
AzureVM: AzureVM - Azure Target ,
AzureAppService: AzureAppService - Azure Target ,
AzureAppServiceContainer: AzureAppServiceContainer - Azure Target ,
Avs: Avs - Azure Target ,
}
,
Required: False ,
}
enum ,
sourceCount:
{
Description: The count of a type of source. ,
Format: int32 ,
Required: False ,
}
integer ,
targetCount:
{
Description: The count of a type of target. ,
Format: int32 ,
Required: False ,
}
integer ,
migrationDetails:
{
Description: The migration details. ,
Required: False ,
}
{
readinessSummary:
{
Description: The readiness summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
migrationType:
{
Description: The migration type ,
Enum:
{
Unknown: Unknown - Migration Type ,
Replatform: Replatform - Migration Type ,
Rehost: Rehost - Migration Type ,
Retain: Retain - Migration Type ,
Rearchitect: Rearchitect - Migration Type ,
}
,
Required: False ,
}
enum ,
}
,
managementDetails:
{
Description: The management details. ,
Required: False ,
}
[
{
name:
{
Description: The management summary name. ,
Enum:
{
No: No - Azure management Offering type ,
SCOMMI: SCOMMI - Azure management Offering type ,
AzMon: AzMon - Azure management Offering type ,
AUM: AUM - Azure management Offering type ,
AzureBackup: AzureBackup - Azure management Offering type ,
}
,
Required: False ,
}
enum ,
readinessSummary:
{
Description: The management suitability summary. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
Unknown: Unknown - Cloud Suitability Common ,
NotSuitable: NotSuitable - Cloud Suitability Common ,
Suitable: Suitable - Cloud Suitability Common ,
ConditionallySuitable: ConditionallySuitable - Cloud Suitability Common ,
ReadinessUnknown: ReadinessUnknown - Cloud Suitability Common ,
SuitableWithWarnings: SuitableWithWarnings - Cloud Suitability Common ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
costDetails:
{
Description: The cost details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsDetails:
{
Description: The savings details. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
confidenceScore:
{
Description: The confidence score. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
costComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
costDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyStorageCost: MonthlyStorageCost - Cost type ,
MonthlyComputeCost: MonthlyComputeCost - Cost type ,
MonthlyLicensingCost: MonthlyLicensingCost - Cost type ,
MonthlySecurityCost: MonthlySecurityCost - Cost type ,
MonthlyManagementCost: MonthlyManagementCost - Cost type ,
MonitoringService: MonitoringService - Cost type ,
DataProtectionService: DataProtectionService - Cost type ,
PatchingService: PatchingService - Cost type ,
MonthlyAzureHybridCost: MonthlyAzureHybridCost - Cost type ,
MonthlyPremiumV2StorageCost: MonthlyPremiumV2StorageCost - Cost type ,
MonthlyLinuxAzureHybridCost: MonthlyLinuxAzureHybridCost - Cost type ,
MonthlyUltraStorageCost: MonthlyUltraStorageCost - Cost type ,
MonthlyStandardSsdStorageCost: MonthlyStandardSsdStorageCost - Cost type ,
MonthlyBandwidthCost: MonthlyBandwidthCost - Cost type ,
MonthlyPremiumStorageCost: MonthlyPremiumStorageCost - Cost type ,
MonthlyUltraDiskCost: MonthlyUltraDiskCost - Cost type ,
MonthlyStandardHddStorageCost: MonthlyStandardHddStorageCost - Cost type ,
MonthlyAvsExternalStorageCost: MonthlyAvsExternalStorageCost - Cost type ,
MonthlyAvsNetworkCost: MonthlyAvsNetworkCost - Cost type ,
MonthlyAvsNodeCost: MonthlyAvsNodeCost - Cost type ,
TotalMonthlyCost: TotalMonthlyCost - Cost type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
savingsComponents:
{
Description: The cost components. ,
Required: False ,
}
[
{
savingOptions:
{
Description: The savings options. ,
Enum:
{
None: No savings options. ,
RI1Year: Reserved Instance for 1 year. ,
RI3Year: Reserved Instance for 3 years. ,
SavingsPlan1Year: The savings plan for 1 year. ,
SavingsPlan3Year: The savings plan for 3 years. ,
CustomAzureOfferCode: Custom azure offer code. ,
}
,
Required: False ,
}
enum ,
savingsDetail:
{
Description: The sku cost details per azure offer type. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Enum:
{
MonthlyAzureHybridCostSavings: MonthlyAzureHybridCostSavings - Savings type ,
MonthlyLinuxAzureHybridCostSavings: MonthlyLinuxAzureHybridCostSavings - Savings type ,
MonthlyAhubSqlCostSavings: MonthlyAhubSqlCostSavings - Savings type ,
MonthlyVcfByolCostDifference: MonthlyVcfByolCostDifference - Savings type ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
assessmentName:
{
Description: Name of the assessment. ,
Required: False ,
}
string ,
discoveredLightSummary:
{
Description: Light summary of the compound assessment. ,
Required: False ,
}
{
numberOfWebApps:
{
Description: Number of web apps. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfWebAppsPerType:
{
Description: Number of web apps per type. ,
Required: False ,
}
[
{
webAppType:
{
Description: Name of the web app type. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
ASP.Net: ASP.NET Web App. ,
Java: Java Web App. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: Count of the web app type. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
numberOfWebServersPerType:
{
Description: Number of web servers per type. ,
Required: False ,
}
[
{
webServerType:
{
Description: Name of the web app type. ,
Enum:
{
Unknown: Unknown. Indicates Missing Data. ,
IIS: ASP.NET Web App. ,
Tomcat: Java Web App. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: Count of the web app type. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
numberOfWebServers:
{
Description: Number of web servers. ,
Format: int32 ,
Required: True ,
}
integer ,
numberOfServers:
{
Description: Number of servers. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}