azure-native.migrate.getAssessment
Explore with Pulumi AI
Get an existing assessment with the specified name. Returns a json object of type ‘assessment’ as specified in Models section. Azure REST API version: 2019-10-01.
Using getAssessment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAssessment(args: GetAssessmentArgs, opts?: InvokeOptions): Promise<GetAssessmentResult>
function getAssessmentOutput(args: GetAssessmentOutputArgs, opts?: InvokeOptions): Output<GetAssessmentResult>
def get_assessment(assessment_name: Optional[str] = None,
group_name: Optional[str] = None,
project_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAssessmentResult
def get_assessment_output(assessment_name: Optional[pulumi.Input[str]] = None,
group_name: Optional[pulumi.Input[str]] = None,
project_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAssessmentResult]
func LookupAssessment(ctx *Context, args *LookupAssessmentArgs, opts ...InvokeOption) (*LookupAssessmentResult, error)
func LookupAssessmentOutput(ctx *Context, args *LookupAssessmentOutputArgs, opts ...InvokeOption) LookupAssessmentResultOutput
> Note: This function is named LookupAssessment
in the Go SDK.
public static class GetAssessment
{
public static Task<GetAssessmentResult> InvokeAsync(GetAssessmentArgs args, InvokeOptions? opts = null)
public static Output<GetAssessmentResult> Invoke(GetAssessmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAssessmentResult> getAssessment(GetAssessmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:migrate:getAssessment
arguments:
# arguments dictionary
The following arguments are supported:
- Assessment
Name string Unique name of an assessment within a project.
- Group
Name string Unique name of a group within a project.
- Project
Name string Name of the Azure Migrate project.
- Resource
Group stringName Name of the Azure Resource Group that project is part of.
- Assessment
Name string Unique name of an assessment within a project.
- Group
Name string Unique name of a group within a project.
- Project
Name string Name of the Azure Migrate project.
- Resource
Group stringName Name of the Azure Resource Group that project is part of.
- assessment
Name String Unique name of an assessment within a project.
- group
Name String Unique name of a group within a project.
- project
Name String Name of the Azure Migrate project.
- resource
Group StringName Name of the Azure Resource Group that project is part of.
- assessment
Name string Unique name of an assessment within a project.
- group
Name string Unique name of a group within a project.
- project
Name string Name of the Azure Migrate project.
- resource
Group stringName Name of the Azure Resource Group that project is part of.
- assessment_
name str Unique name of an assessment within a project.
- group_
name str Unique name of a group within a project.
- project_
name str Name of the Azure Migrate project.
- resource_
group_ strname Name of the Azure Resource Group that project is part of.
- assessment
Name String Unique name of an assessment within a project.
- group
Name String Unique name of a group within a project.
- project
Name String Name of the Azure Migrate project.
- resource
Group StringName Name of the Azure Resource Group that project is part of.
getAssessment Result
The following output properties are available:
- Id string
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- Name string
Unique name of an assessment.
- Properties
Pulumi.
Azure Native. Migrate. Outputs. Assessment Properties Response Properties of the assessment.
- Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- ETag string
For optimistic concurrency control.
- Id string
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- Name string
Unique name of an assessment.
- Properties
Assessment
Properties Response Properties of the assessment.
- Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- ETag string
For optimistic concurrency control.
- id String
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- name String
Unique name of an assessment.
- properties
Assessment
Properties Response Properties of the assessment.
- type String
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- e
Tag String For optimistic concurrency control.
- id string
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- name string
Unique name of an assessment.
- properties
Assessment
Properties Response Properties of the assessment.
- type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- e
Tag string For optimistic concurrency control.
- id str
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- name str
Unique name of an assessment.
- properties
Assessment
Properties Response Properties of the assessment.
- type str
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- e_
tag str For optimistic concurrency control.
- id String
Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
- name String
Unique name of an assessment.
- properties Property Map
Properties of the assessment.
- type String
Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].
- e
Tag String For optimistic concurrency control.
Supporting Types
AssessmentPropertiesResponse
- Azure
Disk stringType Storage type selected for this disk.
- Azure
Hybrid stringUse Benefit AHUB discount on windows virtual machines.
- Azure
Location string Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- Azure
Offer stringCode Offer code according to which cost estimation is done.
- Azure
Pricing stringTier Pricing tier for Size evaluation.
- Azure
Storage stringRedundancy Storage Redundancy type offered by Azure.
- Azure
Vm List<string>Families List of azure VM families.
- Confidence
Rating doubleIn Percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- Created
Timestamp string Time when this project was created. Date-Time represented in ISO-8601 format.
- Currency string
Currency to report prices in.
- Discount
Percentage double Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- Ea
Subscription stringId Enterprise agreement subscription arm id.
- Monthly
Bandwidth doubleCost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Compute doubleCost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- double
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Standard doubleSSDStorage Cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Storage doubleCost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Number
Of intMachines Number of assessed machines part of this assessment.
- Percentile string
Percentile of performance data used to recommend Azure size.
- Perf
Data stringEnd Time End time to consider performance data for assessment
- Perf
Data stringStart Time Start time to consider performance data for assessment
- Prices
Timestamp string Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- Reserved
Instance string Azure reserved instance.
- Scaling
Factor double Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- Sizing
Criterion string Assessment sizing criterion.
- Stage string
User configurable setting that describes the status of the assessment.
- Status string
Whether the assessment has been created and is valid.
- Time
Range string Time range of performance data used to recommend a size.
- Updated
Timestamp string Time when this project was last updated. Date-Time represented in ISO-8601 format.
- Vm
Uptime Pulumi.Azure Native. Migrate. Inputs. Vm Uptime Response Specify the duration for which the VMs are up in the on-premises environment.
- Azure
Disk stringType Storage type selected for this disk.
- Azure
Hybrid stringUse Benefit AHUB discount on windows virtual machines.
- Azure
Location string Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- Azure
Offer stringCode Offer code according to which cost estimation is done.
- Azure
Pricing stringTier Pricing tier for Size evaluation.
- Azure
Storage stringRedundancy Storage Redundancy type offered by Azure.
- Azure
Vm []stringFamilies List of azure VM families.
- Confidence
Rating float64In Percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- Created
Timestamp string Time when this project was created. Date-Time represented in ISO-8601 format.
- Currency string
Currency to report prices in.
- Discount
Percentage float64 Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- Ea
Subscription stringId Enterprise agreement subscription arm id.
- Monthly
Bandwidth float64Cost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Compute float64Cost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- float64
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Standard float64SSDStorage Cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Monthly
Storage float64Cost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Number
Of intMachines Number of assessed machines part of this assessment.
- Percentile string
Percentile of performance data used to recommend Azure size.
- Perf
Data stringEnd Time End time to consider performance data for assessment
- Perf
Data stringStart Time Start time to consider performance data for assessment
- Prices
Timestamp string Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- Reserved
Instance string Azure reserved instance.
- Scaling
Factor float64 Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- Sizing
Criterion string Assessment sizing criterion.
- Stage string
User configurable setting that describes the status of the assessment.
- Status string
Whether the assessment has been created and is valid.
- Time
Range string Time range of performance data used to recommend a size.
- Updated
Timestamp string Time when this project was last updated. Date-Time represented in ISO-8601 format.
- Vm
Uptime VmUptime Response Specify the duration for which the VMs are up in the on-premises environment.
- azure
Disk StringType Storage type selected for this disk.
- azure
Hybrid StringUse Benefit AHUB discount on windows virtual machines.
- azure
Location String Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- azure
Offer StringCode Offer code according to which cost estimation is done.
- azure
Pricing StringTier Pricing tier for Size evaluation.
- azure
Storage StringRedundancy Storage Redundancy type offered by Azure.
- azure
Vm List<String>Families List of azure VM families.
- confidence
Rating DoubleIn Percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- created
Timestamp String Time when this project was created. Date-Time represented in ISO-8601 format.
- currency String
Currency to report prices in.
- discount
Percentage Double Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- ea
Subscription StringId Enterprise agreement subscription arm id.
- monthly
Bandwidth DoubleCost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Compute DoubleCost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Double
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Standard DoubleSSDStorage Cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Storage DoubleCost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- number
Of IntegerMachines Number of assessed machines part of this assessment.
- percentile String
Percentile of performance data used to recommend Azure size.
- perf
Data StringEnd Time End time to consider performance data for assessment
- perf
Data StringStart Time Start time to consider performance data for assessment
- prices
Timestamp String Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- reserved
Instance String Azure reserved instance.
- scaling
Factor Double Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- sizing
Criterion String Assessment sizing criterion.
- stage String
User configurable setting that describes the status of the assessment.
- status String
Whether the assessment has been created and is valid.
- time
Range String Time range of performance data used to recommend a size.
- updated
Timestamp String Time when this project was last updated. Date-Time represented in ISO-8601 format.
- vm
Uptime VmUptime Response Specify the duration for which the VMs are up in the on-premises environment.
- azure
Disk stringType Storage type selected for this disk.
- azure
Hybrid stringUse Benefit AHUB discount on windows virtual machines.
- azure
Location string Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- azure
Offer stringCode Offer code according to which cost estimation is done.
- azure
Pricing stringTier Pricing tier for Size evaluation.
- azure
Storage stringRedundancy Storage Redundancy type offered by Azure.
- azure
Vm string[]Families List of azure VM families.
- confidence
Rating numberIn Percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- created
Timestamp string Time when this project was created. Date-Time represented in ISO-8601 format.
- currency string
Currency to report prices in.
- discount
Percentage number Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- ea
Subscription stringId Enterprise agreement subscription arm id.
- monthly
Bandwidth numberCost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Compute numberCost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- number
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Standard numberSSDStorage Cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Storage numberCost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- number
Of numberMachines Number of assessed machines part of this assessment.
- percentile string
Percentile of performance data used to recommend Azure size.
- perf
Data stringEnd Time End time to consider performance data for assessment
- perf
Data stringStart Time Start time to consider performance data for assessment
- prices
Timestamp string Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- reserved
Instance string Azure reserved instance.
- scaling
Factor number Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- sizing
Criterion string Assessment sizing criterion.
- stage string
User configurable setting that describes the status of the assessment.
- status string
Whether the assessment has been created and is valid.
- time
Range string Time range of performance data used to recommend a size.
- updated
Timestamp string Time when this project was last updated. Date-Time represented in ISO-8601 format.
- vm
Uptime VmUptime Response Specify the duration for which the VMs are up in the on-premises environment.
- azure_
disk_ strtype Storage type selected for this disk.
- azure_
hybrid_ struse_ benefit AHUB discount on windows virtual machines.
- azure_
location str Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- azure_
offer_ strcode Offer code according to which cost estimation is done.
- azure_
pricing_ strtier Pricing tier for Size evaluation.
- azure_
storage_ strredundancy Storage Redundancy type offered by Azure.
- azure_
vm_ Sequence[str]families List of azure VM families.
- confidence_
rating_ floatin_ percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- created_
timestamp str Time when this project was created. Date-Time represented in ISO-8601 format.
- currency str
Currency to report prices in.
- discount_
percentage float Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- ea_
subscription_ strid Enterprise agreement subscription arm id.
- monthly_
bandwidth_ floatcost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly_
compute_ floatcost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- float
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly_
standard_ floatssd_ storage_ cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly_
storage_ floatcost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- number_
of_ intmachines Number of assessed machines part of this assessment.
- percentile str
Percentile of performance data used to recommend Azure size.
- perf_
data_ strend_ time End time to consider performance data for assessment
- perf_
data_ strstart_ time Start time to consider performance data for assessment
- prices_
timestamp str Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- reserved_
instance str Azure reserved instance.
- scaling_
factor float Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- sizing_
criterion str Assessment sizing criterion.
- stage str
User configurable setting that describes the status of the assessment.
- status str
Whether the assessment has been created and is valid.
- time_
range str Time range of performance data used to recommend a size.
- updated_
timestamp str Time when this project was last updated. Date-Time represented in ISO-8601 format.
- vm_
uptime VmUptime Response Specify the duration for which the VMs are up in the on-premises environment.
- azure
Disk StringType Storage type selected for this disk.
- azure
Hybrid StringUse Benefit AHUB discount on windows virtual machines.
- azure
Location String Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
- azure
Offer StringCode Offer code according to which cost estimation is done.
- azure
Pricing StringTier Pricing tier for Size evaluation.
- azure
Storage StringRedundancy Storage Redundancy type offered by Azure.
- azure
Vm List<String>Families List of azure VM families.
- confidence
Rating NumberIn Percentage Confidence rating percentage for assessment. Can be in the range [0, 100].
- created
Timestamp String Time when this project was created. Date-Time represented in ISO-8601 format.
- currency String
Currency to report prices in.
- discount
Percentage Number Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
- ea
Subscription StringId Enterprise agreement subscription arm id.
- monthly
Bandwidth NumberCost Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Compute NumberCost Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- Number
Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Standard NumberSSDStorage Cost Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- monthly
Storage NumberCost Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
- number
Of NumberMachines Number of assessed machines part of this assessment.
- percentile String
Percentile of performance data used to recommend Azure size.
- perf
Data StringEnd Time End time to consider performance data for assessment
- perf
Data StringStart Time Start time to consider performance data for assessment
- prices
Timestamp String Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
- reserved
Instance String Azure reserved instance.
- scaling
Factor Number Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
- sizing
Criterion String Assessment sizing criterion.
- stage String
User configurable setting that describes the status of the assessment.
- status String
Whether the assessment has been created and is valid.
- time
Range String Time range of performance data used to recommend a size.
- updated
Timestamp String Time when this project was last updated. Date-Time represented in ISO-8601 format.
- vm
Uptime Property Map Specify the duration for which the VMs are up in the on-premises environment.
VmUptimeResponse
- Days
Per doubleMonth Number of days in a month for VM uptime.
- Hours
Per doubleDay Number of hours per day for VM uptime.
- Days
Per float64Month Number of days in a month for VM uptime.
- Hours
Per float64Day Number of hours per day for VM uptime.
- days
Per DoubleMonth Number of days in a month for VM uptime.
- hours
Per DoubleDay Number of hours per day for VM uptime.
- days
Per numberMonth Number of days in a month for VM uptime.
- hours
Per numberDay Number of hours per day for VM uptime.
- days_
per_ floatmonth Number of days in a month for VM uptime.
- hours_
per_ floatday Number of hours per day for VM uptime.
- days
Per NumberMonth Number of days in a month for VM uptime.
- hours
Per NumberDay Number of hours per day for VM uptime.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0