1. Packages
  2. Azure Native
  3. API Docs
  4. migrate
  5. getAssessment
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

azure-native.migrate.getAssessment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

    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:

    AssessmentName string

    Unique name of an assessment within a project.

    GroupName string

    Unique name of a group within a project.

    ProjectName string

    Name of the Azure Migrate project.

    ResourceGroupName string

    Name of the Azure Resource Group that project is part of.

    AssessmentName string

    Unique name of an assessment within a project.

    GroupName string

    Unique name of a group within a project.

    ProjectName string

    Name of the Azure Migrate project.

    ResourceGroupName string

    Name of the Azure Resource Group that project is part of.

    assessmentName String

    Unique name of an assessment within a project.

    groupName String

    Unique name of a group within a project.

    projectName String

    Name of the Azure Migrate project.

    resourceGroupName String

    Name of the Azure Resource Group that project is part of.

    assessmentName string

    Unique name of an assessment within a project.

    groupName string

    Unique name of a group within a project.

    projectName string

    Name of the Azure Migrate project.

    resourceGroupName string

    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_name str

    Name of the Azure Resource Group that project is part of.

    assessmentName String

    Unique name of an assessment within a project.

    groupName String

    Unique name of a group within a project.

    projectName String

    Name of the Azure Migrate project.

    resourceGroupName String

    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.AzureNative.Migrate.Outputs.AssessmentPropertiesResponse

    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 AssessmentPropertiesResponse

    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 AssessmentPropertiesResponse

    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 AssessmentPropertiesResponse

    Properties of the assessment.

    type string

    Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].

    eTag 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 AssessmentPropertiesResponse

    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].

    eTag String

    For optimistic concurrency control.

    Supporting Types

    AssessmentPropertiesResponse

    AzureDiskType string

    Storage type selected for this disk.

    AzureHybridUseBenefit string

    AHUB discount on windows virtual machines.

    AzureLocation string

    Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

    AzureOfferCode string

    Offer code according to which cost estimation is done.

    AzurePricingTier string

    Pricing tier for Size evaluation.

    AzureStorageRedundancy string

    Storage Redundancy type offered by Azure.

    AzureVmFamilies List<string>

    List of azure VM families.

    ConfidenceRatingInPercentage double

    Confidence rating percentage for assessment. Can be in the range [0, 100].

    CreatedTimestamp string

    Time when this project was created. Date-Time represented in ISO-8601 format.

    Currency string

    Currency to report prices in.

    DiscountPercentage double

    Custom discount percentage to be applied on final costs. Can be in the range [0, 100].

    EaSubscriptionId string

    Enterprise agreement subscription arm id.

    MonthlyBandwidthCost double

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyComputeCost double

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyPremiumStorageCost double

    Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyStandardSSDStorageCost double

    Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyStorageCost double

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    NumberOfMachines int

    Number of assessed machines part of this assessment.

    Percentile string

    Percentile of performance data used to recommend Azure size.

    PerfDataEndTime string

    End time to consider performance data for assessment

    PerfDataStartTime string

    Start time to consider performance data for assessment

    PricesTimestamp string

    Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.

    ReservedInstance string

    Azure reserved instance.

    ScalingFactor 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.

    SizingCriterion 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.

    TimeRange string

    Time range of performance data used to recommend a size.

    UpdatedTimestamp string

    Time when this project was last updated. Date-Time represented in ISO-8601 format.

    VmUptime Pulumi.AzureNative.Migrate.Inputs.VmUptimeResponse

    Specify the duration for which the VMs are up in the on-premises environment.

    AzureDiskType string

    Storage type selected for this disk.

    AzureHybridUseBenefit string

    AHUB discount on windows virtual machines.

    AzureLocation string

    Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

    AzureOfferCode string

    Offer code according to which cost estimation is done.

    AzurePricingTier string

    Pricing tier for Size evaluation.

    AzureStorageRedundancy string

    Storage Redundancy type offered by Azure.

    AzureVmFamilies []string

    List of azure VM families.

    ConfidenceRatingInPercentage float64

    Confidence rating percentage for assessment. Can be in the range [0, 100].

    CreatedTimestamp string

    Time when this project was created. Date-Time represented in ISO-8601 format.

    Currency string

    Currency to report prices in.

    DiscountPercentage float64

    Custom discount percentage to be applied on final costs. Can be in the range [0, 100].

    EaSubscriptionId string

    Enterprise agreement subscription arm id.

    MonthlyBandwidthCost float64

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyComputeCost float64

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyPremiumStorageCost float64

    Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyStandardSSDStorageCost float64

    Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    MonthlyStorageCost float64

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    NumberOfMachines int

    Number of assessed machines part of this assessment.

    Percentile string

    Percentile of performance data used to recommend Azure size.

    PerfDataEndTime string

    End time to consider performance data for assessment

    PerfDataStartTime string

    Start time to consider performance data for assessment

    PricesTimestamp string

    Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.

    ReservedInstance string

    Azure reserved instance.

    ScalingFactor 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.

    SizingCriterion 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.

    TimeRange string

    Time range of performance data used to recommend a size.

    UpdatedTimestamp string

    Time when this project was last updated. Date-Time represented in ISO-8601 format.

    VmUptime VmUptimeResponse

    Specify the duration for which the VMs are up in the on-premises environment.

    azureDiskType String

    Storage type selected for this disk.

    azureHybridUseBenefit String

    AHUB discount on windows virtual machines.

    azureLocation String

    Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

    azureOfferCode String

    Offer code according to which cost estimation is done.

    azurePricingTier String

    Pricing tier for Size evaluation.

    azureStorageRedundancy String

    Storage Redundancy type offered by Azure.

    azureVmFamilies List<String>

    List of azure VM families.

    confidenceRatingInPercentage Double

    Confidence rating percentage for assessment. Can be in the range [0, 100].

    createdTimestamp String

    Time when this project was created. Date-Time represented in ISO-8601 format.

    currency String

    Currency to report prices in.

    discountPercentage Double

    Custom discount percentage to be applied on final costs. Can be in the range [0, 100].

    eaSubscriptionId String

    Enterprise agreement subscription arm id.

    monthlyBandwidthCost Double

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyComputeCost Double

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyPremiumStorageCost Double

    Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStandardSSDStorageCost Double

    Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStorageCost Double

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    numberOfMachines Integer

    Number of assessed machines part of this assessment.

    percentile String

    Percentile of performance data used to recommend Azure size.

    perfDataEndTime String

    End time to consider performance data for assessment

    perfDataStartTime String

    Start time to consider performance data for assessment

    pricesTimestamp String

    Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.

    reservedInstance String

    Azure reserved instance.

    scalingFactor 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.

    sizingCriterion 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.

    timeRange String

    Time range of performance data used to recommend a size.

    updatedTimestamp String

    Time when this project was last updated. Date-Time represented in ISO-8601 format.

    vmUptime VmUptimeResponse

    Specify the duration for which the VMs are up in the on-premises environment.

    azureDiskType string

    Storage type selected for this disk.

    azureHybridUseBenefit string

    AHUB discount on windows virtual machines.

    azureLocation string

    Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

    azureOfferCode string

    Offer code according to which cost estimation is done.

    azurePricingTier string

    Pricing tier for Size evaluation.

    azureStorageRedundancy string

    Storage Redundancy type offered by Azure.

    azureVmFamilies string[]

    List of azure VM families.

    confidenceRatingInPercentage number

    Confidence rating percentage for assessment. Can be in the range [0, 100].

    createdTimestamp string

    Time when this project was created. Date-Time represented in ISO-8601 format.

    currency string

    Currency to report prices in.

    discountPercentage number

    Custom discount percentage to be applied on final costs. Can be in the range [0, 100].

    eaSubscriptionId string

    Enterprise agreement subscription arm id.

    monthlyBandwidthCost number

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyComputeCost number

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyPremiumStorageCost number

    Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStandardSSDStorageCost number

    Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStorageCost number

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    numberOfMachines number

    Number of assessed machines part of this assessment.

    percentile string

    Percentile of performance data used to recommend Azure size.

    perfDataEndTime string

    End time to consider performance data for assessment

    perfDataStartTime string

    Start time to consider performance data for assessment

    pricesTimestamp string

    Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.

    reservedInstance string

    Azure reserved instance.

    scalingFactor 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.

    sizingCriterion 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.

    timeRange string

    Time range of performance data used to recommend a size.

    updatedTimestamp string

    Time when this project was last updated. Date-Time represented in ISO-8601 format.

    vmUptime VmUptimeResponse

    Specify the duration for which the VMs are up in the on-premises environment.

    azure_disk_type str

    Storage type selected for this disk.

    azure_hybrid_use_benefit str

    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_code str

    Offer code according to which cost estimation is done.

    azure_pricing_tier str

    Pricing tier for Size evaluation.

    azure_storage_redundancy str

    Storage Redundancy type offered by Azure.

    azure_vm_families Sequence[str]

    List of azure VM families.

    confidence_rating_in_percentage float

    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_id str

    Enterprise agreement subscription arm id.

    monthly_bandwidth_cost float

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthly_compute_cost float

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthly_premium_storage_cost 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_ssd_storage_cost float

    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_cost float

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    number_of_machines int

    Number of assessed machines part of this assessment.

    percentile str

    Percentile of performance data used to recommend Azure size.

    perf_data_end_time str

    End time to consider performance data for assessment

    perf_data_start_time str

    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 VmUptimeResponse

    Specify the duration for which the VMs are up in the on-premises environment.

    azureDiskType String

    Storage type selected for this disk.

    azureHybridUseBenefit String

    AHUB discount on windows virtual machines.

    azureLocation String

    Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

    azureOfferCode String

    Offer code according to which cost estimation is done.

    azurePricingTier String

    Pricing tier for Size evaluation.

    azureStorageRedundancy String

    Storage Redundancy type offered by Azure.

    azureVmFamilies List<String>

    List of azure VM families.

    confidenceRatingInPercentage Number

    Confidence rating percentage for assessment. Can be in the range [0, 100].

    createdTimestamp String

    Time when this project was created. Date-Time represented in ISO-8601 format.

    currency String

    Currency to report prices in.

    discountPercentage Number

    Custom discount percentage to be applied on final costs. Can be in the range [0, 100].

    eaSubscriptionId String

    Enterprise agreement subscription arm id.

    monthlyBandwidthCost Number

    Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyComputeCost Number

    Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyPremiumStorageCost Number

    Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStandardSSDStorageCost Number

    Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    monthlyStorageCost Number

    Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.

    numberOfMachines Number

    Number of assessed machines part of this assessment.

    percentile String

    Percentile of performance data used to recommend Azure size.

    perfDataEndTime String

    End time to consider performance data for assessment

    perfDataStartTime String

    Start time to consider performance data for assessment

    pricesTimestamp String

    Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.

    reservedInstance String

    Azure reserved instance.

    scalingFactor 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.

    sizingCriterion 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.

    timeRange String

    Time range of performance data used to recommend a size.

    updatedTimestamp String

    Time when this project was last updated. Date-Time represented in ISO-8601 format.

    vmUptime Property Map

    Specify the duration for which the VMs are up in the on-premises environment.

    VmUptimeResponse

    DaysPerMonth double

    Number of days in a month for VM uptime.

    HoursPerDay double

    Number of hours per day for VM uptime.

    DaysPerMonth float64

    Number of days in a month for VM uptime.

    HoursPerDay float64

    Number of hours per day for VM uptime.

    daysPerMonth Double

    Number of days in a month for VM uptime.

    hoursPerDay Double

    Number of hours per day for VM uptime.

    daysPerMonth number

    Number of days in a month for VM uptime.

    hoursPerDay number

    Number of hours per day for VM uptime.

    days_per_month float

    Number of days in a month for VM uptime.

    hours_per_day float

    Number of hours per day for VM uptime.

    daysPerMonth Number

    Number of days in a month for VM uptime.

    hoursPerDay Number

    Number of hours per day for VM uptime.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi