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

2025/04/16 • 5 updated methods

MachineAssessmentsV2Operations_ListByParent (updated)
Description :  List MachineAssessmentV2 resources by AssessmentProject
Reference :  Link ¶

⚶ Changes

{
  "#id": "MachineAssessmentsV2Operations_ListByParent",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "settings": [
                  {
                    "@added_d32cd6c0d9cd4cd1ab26d12e3b626ec6": {
                      "#name": "azureVmSecurityOptions",
                      "Description": "Gets or sets the Azure VM security options.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Azure Vm Security Type",
                        "Enum": [
                          [
                            "Unknown",
                            "Unknown - Azure Vm Security Type"
                          ],
                          [
                            "Standard",
                            "Standard Azure Vm Security Type"
                          ],
                          [
                            "TVM",
                            "TVM Azure Vm Security Type"
                          ],
                          [
                            "CVM",
                            "CVM Azure Vm Security Type"
                          ]
                        ],
                        "Type": "string"
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
azureVmSecurityOptions:
{
Description: Gets or sets the Azure VM security options. ,
Required: False ,
}
[
string ,
]
,
}
,
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 (updated)
Description :  Get a MachineAssessmentV2
Reference :  Link ¶

⚶ Changes

{
  "#id": "MachineAssessmentsV2Operations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "settings": [
              {
                "@added_feb86b86491244688d2b5464fe71701b": {
                  "#name": "azureVmSecurityOptions",
                  "Description": "Gets or sets the Azure VM security options.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "Azure Vm Security Type",
                    "Enum": [
                      [
                        "Unknown",
                        "Unknown - Azure Vm Security Type"
                      ],
                      [
                        "Standard",
                        "Standard Azure Vm Security Type"
                      ],
                      [
                        "TVM",
                        "TVM Azure Vm Security Type"
                      ],
                      [
                        "CVM",
                        "CVM Azure Vm Security Type"
                      ]
                    ],
                    "Type": "string"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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 ,
}
,
azureVmSecurityOptions:
{
Description: Gets or sets the Azure VM security options. ,
Required: False ,
}
[
string ,
]
,
}
,
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 (updated)
Description :  Create a MachineAssessmentV2
Reference :  Link ¶

⚶ Changes

{
  "#id": "MachineAssessmentsV2Operations_Create",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "settings": [
              {
                "@added_bdd4db4ad93b4d929e992b6d632f6354": {
                  "#name": "azureVmSecurityOptions",
                  "Description": "Gets or sets the Azure VM security options.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "Azure Vm Security Type",
                    "Enum": [
                      [
                        "Unknown",
                        "Unknown - Azure Vm Security Type"
                      ],
                      [
                        "Standard",
                        "Standard Azure Vm Security Type"
                      ],
                      [
                        "TVM",
                        "TVM Azure Vm Security Type"
                      ],
                      [
                        "CVM",
                        "CVM Azure Vm Security Type"
                      ]
                    ],
                    "Type": "string"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "settings": [
              {
                "@added_7df564a34d7d4bba99fae8d1bb5cc8e5": {
                  "#name": "azureVmSecurityOptions",
                  "Description": "Gets or sets the Azure VM security options.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "Azure Vm Security Type",
                    "Enum": [
                      [
                        "Unknown",
                        "Unknown - Azure Vm Security Type"
                      ],
                      [
                        "Standard",
                        "Standard Azure Vm Security Type"
                      ],
                      [
                        "TVM",
                        "TVM Azure Vm Security Type"
                      ],
                      [
                        "CVM",
                        "CVM Azure Vm Security Type"
                      ]
                    ],
                    "Type": "string"
                  }
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "settings": [
              {
                "@added_7a251870ac794501ba5f6f8d0c267e33": {
                  "#name": "azureVmSecurityOptions",
                  "Description": "Gets or sets the Azure VM security options.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "Azure Vm Security Type",
                    "Enum": [
                      [
                        "Unknown",
                        "Unknown - Azure Vm Security Type"
                      ],
                      [
                        "Standard",
                        "Standard Azure Vm Security Type"
                      ],
                      [
                        "TVM",
                        "TVM Azure Vm Security Type"
                      ],
                      [
                        "CVM",
                        "CVM Azure Vm Security Type"
                      ]
                    ],
                    "Type": "string"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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 ,
}
,
azureVmSecurityOptions:
{
Description: Gets or sets the Azure VM security options. ,
Required: False ,
}
[
string ,
]
,
}
,
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 ,
}
,
azureVmSecurityOptions:
{
Description: Gets or sets the Azure VM security options. ,
Required: False ,
}
[
string ,
]
,
}
,
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 ,
}
,
azureVmSecurityOptions:
{
Description: Gets or sets the Azure VM security options. ,
Required: False ,
}
[
string ,
]
,
}
,
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 ,
}
,
]
,
}
,
}
AssessedMachinesV2Operations_ListByParent (updated)
Description :  List AssessedMachineV2 resources by MachineAssessmentV2
Reference :  Link ¶

⚶ Changes

{
  "#id": "AssessedMachinesV2Operations_ListByParent",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "recommendations": {
                  "Description": {
                    "new": "Machine Assessment Recommendation with additional properties.",
                    "old": "Recommendation details"
                  },
                  "$properties": {
                    "@added_d33adea31e344fcfb856ecd39496a4ef": {
                      "#name": "vmSecuritySuitabilityResults",
                      "Description": "VM Security Suitability Results.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "VM Security Suitability",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "vmSecurityType",
                            "Description": "Gets and sets the security type for this secure VM.",
                            "Enum": [
                              [
                                "Unknown",
                                "Unknown - Azure Vm Security Type"
                              ],
                              [
                                "Standard",
                                "Standard Azure Vm Security Type"
                              ],
                              [
                                "TVM",
                                "TVM Azure Vm Security Type"
                              ],
                              [
                                "CVM",
                                "CVM Azure Vm Security Type"
                              ]
                            ],
                            "Required": true,
                            "Type": "string"
                          },
                          {
                            "#name": "securitySuitability",
                            "Description": "Gets the suitability for this secure VM.",
                            "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": true,
                            "Type": "string"
                          },
                          {
                            "#name": "securitySuitabilityDetails",
                            "Description": "Gets the security suitability details for this VM.",
                            "Required": true,
                            "Type": "array",
                            "$items": {
                              "Description": "Azure Vm Security Suitability Detail",
                              "Enum": [
                                [
                                  "Unknown",
                                  "Unknown - Azure Vm Security Suitability Detail"
                                ],
                                [
                                  "NotApplicable",
                                  "NotApplicable - Azure Vm Security Suitability Detail"
                                ],
                                [
                                  "GuestOperatingSystemNotSupported",
                                  "GuestOperatingSystemNotSupported Azure Vm Security Suitability Detail"
                                ],
                                [
                                  "BootTypeNotSupported",
                                  "BootTypeNotSupported Azure Vm Security Suitability Detail"
                                ],
                                [
                                  "DiskSizeLarge",
                                  "DiskSizeLarge Azure Vm Security Suitability Detail"
                                ],
                                [
                                  "AllDiskSizeExceeds4TB",
                                  "Azure does not support VM with OS disk size greater than 4TB."
                                ],
                                [
                                  "AnyDiskSizeExceeds4TB",
                                  "Azure does not support VM with OS disk size greater than 4TB. If OS disk size is less than 4TB, proceed with migration."
                                ],
                                [
                                  "AnyDiskSizeExceeds4TBConditional",
                                  "Azure does not support VM with any disk size greater than 4TB. Please proceed only if you know the OS disk size is less than 4TB."
                                ],
                                [
                                  "OSNotSupported",
                                  "The VM is not ready to be migrated to Azure because the OS is not supported."
                                ],
                                [
                                  "StandardReady",
                                  "The VM is ready to be migrated to Azure with standard VM security type."
                                ],
                                [
                                  "TVMReady",
                                  "The VM is ready to be migrated to Azure with Trusted launch VM security type."
                                ],
                                [
                                  "StandardNotReadyOSNotSupported",
                                  "The VM is not ready to be migrated to Azure with standard VM security type because the OS is not supported."
                                ],
                                [
                                  "TVMNotReadyOSNotSupported",
                                  "The VM is not ready to be migrated to Azure with Trusted launch VM security type because the OS is not supported for Trusted launch VM. Get more information [here]."
                                ],
                                [
                                  "StandardNotReady2TBBiosBoot",
                                  "The VM is not ready to be migrated to Azure with standard VM security type. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type."
                                ],
                                [
                                  "AllDiskSizeExceeds2TB",
                                  "The VM is not ready to be migrated to Azure with Trusted launch VM security type. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type."
                                ],
                                [
                                  "DiskSize2TBConditionalReadyBiosBoot",
                                  "The VM readiness is unknown. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type. Please proceed with migration only if OS disk size is less than 2TB."
                                ],
                                [
                                  "TVMCannotMigrateOSNotSupported",
                                  "The VM cannot be migrated to Trusted launch VM because the OS is not supported. Learn more [here]."
                                ],
                                [
                                  "StandardCannotMigrateOSNotSupported",
                                  "The VM cannot be migrated to Azure because the OS is not supported."
                                ],
                                [
                                  "StandardCanMigrate",
                                  "The VM can be migrated to Azure with standard VM security type."
                                ],
                                [
                                  "TVMCanMigrateConditional",
                                  "The VM can be migrated to Trusted launch VM. Currently, Azure Migrate does not support migration to Trusted launch for VM with BIOS boot type. You can convert the VM post-migration to Trusted Launch VM. The steps are mentioned in this documentation."
                                ],
                                [
                                  "OSNameCannotBeRead",
                                  "Readiness is marked as unknown because the OS name cannot be read."
                                ],
                                [
                                  "TVMNotSupportedForBiosBoot",
                                  "Migration to Trusted Launch VM is not supported for BIOS boot type VMs at this time."
                                ]
                              ],
                              "Type": "string"
                            }
                          }
                        ]
                      }
                    },
                    "@added_8a9966c3c3974db9adebfbd36131f950": {
                      "#name": "recommendedVmSecurityType",
                      "Description": "Recommended security type for the VM.",
                      "Enum": [
                        [
                          "Unknown",
                          "Unknown - Azure Vm Security Type"
                        ],
                        [
                          "Standard",
                          "Standard Azure Vm Security Type"
                        ],
                        [
                          "TVM",
                          "TVM Azure Vm Security Type"
                        ],
                        [
                          "CVM",
                          "CVM Azure Vm Security Type"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
vmSecuritySuitabilityResults:
{
Description: VM Security Suitability Results. ,
Required: False ,
}
[
{
vmSecurityType:
{
Description: Gets and sets the security type for this secure VM. ,
Enum:
{
Unknown: Unknown - Azure Vm Security Type ,
Standard: Standard Azure Vm Security Type ,
TVM: TVM Azure Vm Security Type ,
CVM: CVM Azure Vm Security Type ,
}
,
Required: True ,
}
enum ,
securitySuitability:
{
Description: Gets the suitability for this secure VM. ,
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: True ,
}
enum ,
securitySuitabilityDetails:
{
Description: Gets the security suitability details for this VM. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
recommendedVmSecurityType:
{
Description: Recommended security type for the VM. ,
Enum:
{
Unknown: Unknown - Azure Vm Security Type ,
Standard: Standard Azure Vm Security Type ,
TVM: TVM Azure Vm Security Type ,
CVM: CVM Azure Vm Security Type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 (updated)
Description :  Get a AssessedMachineV2
Reference :  Link ¶

⚶ Changes

{
  "#id": "AssessedMachinesV2Operations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "recommendations": {
              "Description": {
                "new": "Machine Assessment Recommendation with additional properties.",
                "old": "Recommendation details"
              },
              "$properties": {
                "@added_88acdaf13d1448ca8c2f637470b8cda9": {
                  "#name": "vmSecuritySuitabilityResults",
                  "Description": "VM Security Suitability Results.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "VM Security Suitability",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "vmSecurityType",
                        "Description": "Gets and sets the security type for this secure VM.",
                        "Enum": [
                          [
                            "Unknown",
                            "Unknown - Azure Vm Security Type"
                          ],
                          [
                            "Standard",
                            "Standard Azure Vm Security Type"
                          ],
                          [
                            "TVM",
                            "TVM Azure Vm Security Type"
                          ],
                          [
                            "CVM",
                            "CVM Azure Vm Security Type"
                          ]
                        ],
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "securitySuitability",
                        "Description": "Gets the suitability for this secure VM.",
                        "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": true,
                        "Type": "string"
                      },
                      {
                        "#name": "securitySuitabilityDetails",
                        "Description": "Gets the security suitability details for this VM.",
                        "Required": true,
                        "Type": "array",
                        "$items": {
                          "Description": "Azure Vm Security Suitability Detail",
                          "Enum": [
                            [
                              "Unknown",
                              "Unknown - Azure Vm Security Suitability Detail"
                            ],
                            [
                              "NotApplicable",
                              "NotApplicable - Azure Vm Security Suitability Detail"
                            ],
                            [
                              "GuestOperatingSystemNotSupported",
                              "GuestOperatingSystemNotSupported Azure Vm Security Suitability Detail"
                            ],
                            [
                              "BootTypeNotSupported",
                              "BootTypeNotSupported Azure Vm Security Suitability Detail"
                            ],
                            [
                              "DiskSizeLarge",
                              "DiskSizeLarge Azure Vm Security Suitability Detail"
                            ],
                            [
                              "AllDiskSizeExceeds4TB",
                              "Azure does not support VM with OS disk size greater than 4TB."
                            ],
                            [
                              "AnyDiskSizeExceeds4TB",
                              "Azure does not support VM with OS disk size greater than 4TB. If OS disk size is less than 4TB, proceed with migration."
                            ],
                            [
                              "AnyDiskSizeExceeds4TBConditional",
                              "Azure does not support VM with any disk size greater than 4TB. Please proceed only if you know the OS disk size is less than 4TB."
                            ],
                            [
                              "OSNotSupported",
                              "The VM is not ready to be migrated to Azure because the OS is not supported."
                            ],
                            [
                              "StandardReady",
                              "The VM is ready to be migrated to Azure with standard VM security type."
                            ],
                            [
                              "TVMReady",
                              "The VM is ready to be migrated to Azure with Trusted launch VM security type."
                            ],
                            [
                              "StandardNotReadyOSNotSupported",
                              "The VM is not ready to be migrated to Azure with standard VM security type because the OS is not supported."
                            ],
                            [
                              "TVMNotReadyOSNotSupported",
                              "The VM is not ready to be migrated to Azure with Trusted launch VM security type because the OS is not supported for Trusted launch VM. Get more information [here]."
                            ],
                            [
                              "StandardNotReady2TBBiosBoot",
                              "The VM is not ready to be migrated to Azure with standard VM security type. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type."
                            ],
                            [
                              "AllDiskSizeExceeds2TB",
                              "The VM is not ready to be migrated to Azure with Trusted launch VM security type. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type."
                            ],
                            [
                              "DiskSize2TBConditionalReadyBiosBoot",
                              "The VM readiness is unknown. Azure does not support OS disk size greater than 2TB for VMs with BIOS boot type. Please proceed with migration only if OS disk size is less than 2TB."
                            ],
                            [
                              "TVMCannotMigrateOSNotSupported",
                              "The VM cannot be migrated to Trusted launch VM because the OS is not supported. Learn more [here]."
                            ],
                            [
                              "StandardCannotMigrateOSNotSupported",
                              "The VM cannot be migrated to Azure because the OS is not supported."
                            ],
                            [
                              "StandardCanMigrate",
                              "The VM can be migrated to Azure with standard VM security type."
                            ],
                            [
                              "TVMCanMigrateConditional",
                              "The VM can be migrated to Trusted launch VM. Currently, Azure Migrate does not support migration to Trusted launch for VM with BIOS boot type. You can convert the VM post-migration to Trusted Launch VM. The steps are mentioned in this documentation."
                            ],
                            [
                              "OSNameCannotBeRead",
                              "Readiness is marked as unknown because the OS name cannot be read."
                            ],
                            [
                              "TVMNotSupportedForBiosBoot",
                              "Migration to Trusted Launch VM is not supported for BIOS boot type VMs at this time."
                            ]
                          ],
                          "Type": "string"
                        }
                      }
                    ]
                  }
                },
                "@added_b8374128e2a74df19545018297de1d47": {
                  "#name": "recommendedVmSecurityType",
                  "Description": "Recommended security type for the VM.",
                  "Enum": [
                    [
                      "Unknown",
                      "Unknown - Azure Vm Security Type"
                    ],
                    [
                      "Standard",
                      "Standard Azure Vm Security Type"
                    ],
                    [
                      "TVM",
                      "TVM Azure Vm Security Type"
                    ],
                    [
                      "CVM",
                      "CVM Azure Vm Security Type"
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
vmSecuritySuitabilityResults:
{
Description: VM Security Suitability Results. ,
Required: False ,
}
[
{
vmSecurityType:
{
Description: Gets and sets the security type for this secure VM. ,
Enum:
{
Unknown: Unknown - Azure Vm Security Type ,
Standard: Standard Azure Vm Security Type ,
TVM: TVM Azure Vm Security Type ,
CVM: CVM Azure Vm Security Type ,
}
,
Required: True ,
}
enum ,
securitySuitability:
{
Description: Gets the suitability for this secure VM. ,
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: True ,
}
enum ,
securitySuitabilityDetails:
{
Description: Gets the security suitability details for this VM. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
recommendedVmSecurityType:
{
Description: Recommended security type for the VM. ,
Enum:
{
Unknown: Unknown - Azure Vm Security Type ,
Standard: Standard Azure Vm Security Type ,
TVM: TVM Azure Vm Security Type ,
CVM: CVM Azure Vm Security Type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
}
,
}