Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. advisor
  5. Assessment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.advisor.Assessment

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

The Advisor assessment result data structure.

Uses Azure REST API version 2023-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-09-01-preview.

Example Usage

PutAssessment

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var assessment = new AzureNative.Advisor.Assessment("assessment", new()
    {
        AssessmentName = "assessment1",
        Locale = "en-us",
        TypeId = "23513bdb-e8a2-4f0b-8b6b-191ee1f52d34",
        WorkloadId = "f72b7134-800f-4f1b-a5bd-691e2140c7d5",
    });

});
Copy
package main

import (
	advisor "github.com/pulumi/pulumi-azure-native-sdk/advisor/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := advisor.NewAssessment(ctx, "assessment", &advisor.AssessmentArgs{
			AssessmentName: pulumi.String("assessment1"),
			Locale:         pulumi.String("en-us"),
			TypeId:         pulumi.String("23513bdb-e8a2-4f0b-8b6b-191ee1f52d34"),
			WorkloadId:     pulumi.String("f72b7134-800f-4f1b-a5bd-691e2140c7d5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.advisor.Assessment;
import com.pulumi.azurenative.advisor.AssessmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var assessment = new Assessment("assessment", AssessmentArgs.builder()
            .assessmentName("assessment1")
            .locale("en-us")
            .typeId("23513bdb-e8a2-4f0b-8b6b-191ee1f52d34")
            .workloadId("f72b7134-800f-4f1b-a5bd-691e2140c7d5")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const assessment = new azure_native.advisor.Assessment("assessment", {
    assessmentName: "assessment1",
    locale: "en-us",
    typeId: "23513bdb-e8a2-4f0b-8b6b-191ee1f52d34",
    workloadId: "f72b7134-800f-4f1b-a5bd-691e2140c7d5",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

assessment = azure_native.advisor.Assessment("assessment",
    assessment_name="assessment1",
    locale="en-us",
    type_id="23513bdb-e8a2-4f0b-8b6b-191ee1f52d34",
    workload_id="f72b7134-800f-4f1b-a5bd-691e2140c7d5")
Copy
resources:
  assessment:
    type: azure-native:advisor:Assessment
    properties:
      assessmentName: assessment1
      locale: en-us
      typeId: 23513bdb-e8a2-4f0b-8b6b-191ee1f52d34
      workloadId: f72b7134-800f-4f1b-a5bd-691e2140c7d5
Copy

Create Assessment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Assessment(name: string, args?: AssessmentArgs, opts?: CustomResourceOptions);
@overload
def Assessment(resource_name: str,
               args: Optional[AssessmentArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Assessment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               assessment_name: Optional[str] = None,
               locale: Optional[str] = None,
               type_id: Optional[str] = None,
               workload_id: Optional[str] = None)
func NewAssessment(ctx *Context, name string, args *AssessmentArgs, opts ...ResourceOption) (*Assessment, error)
public Assessment(string name, AssessmentArgs? args = null, CustomResourceOptions? opts = null)
public Assessment(String name, AssessmentArgs args)
public Assessment(String name, AssessmentArgs args, CustomResourceOptions options)

type: azure-native:advisor:Assessment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AssessmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AssessmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AssessmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AssessmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssessmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var assessmentResource = new AzureNative.Advisor.Assessment("assessmentResource", new()
{
    AssessmentName = "string",
    Locale = "string",
    TypeId = "string",
    WorkloadId = "string",
});
Copy
example, err := advisor.NewAssessment(ctx, "assessmentResource", &advisor.AssessmentArgs{
	AssessmentName: pulumi.String("string"),
	Locale:         pulumi.String("string"),
	TypeId:         pulumi.String("string"),
	WorkloadId:     pulumi.String("string"),
})
Copy
var assessmentResource = new Assessment("assessmentResource", AssessmentArgs.builder()
    .assessmentName("string")
    .locale("string")
    .typeId("string")
    .workloadId("string")
    .build());
Copy
assessment_resource = azure_native.advisor.Assessment("assessmentResource",
    assessment_name="string",
    locale="string",
    type_id="string",
    workload_id="string")
Copy
const assessmentResource = new azure_native.advisor.Assessment("assessmentResource", {
    assessmentName: "string",
    locale: "string",
    typeId: "string",
    workloadId: "string",
});
Copy
type: azure-native:advisor:Assessment
properties:
    assessmentName: string
    locale: string
    typeId: string
    workloadId: string
Copy

Assessment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Assessment resource accepts the following input properties:

AssessmentName Changes to this property will trigger replacement. string
Advisor assessment name.
Locale string
Assessment Type Locale.
TypeId string
Assessment Type Id.
WorkloadId string
Workload Id.
AssessmentName Changes to this property will trigger replacement. string
Advisor assessment name.
Locale string
Assessment Type Locale.
TypeId string
Assessment Type Id.
WorkloadId string
Workload Id.
assessmentName Changes to this property will trigger replacement. String
Advisor assessment name.
locale String
Assessment Type Locale.
typeId String
Assessment Type Id.
workloadId String
Workload Id.
assessmentName Changes to this property will trigger replacement. string
Advisor assessment name.
locale string
Assessment Type Locale.
typeId string
Assessment Type Id.
workloadId string
Workload Id.
assessment_name Changes to this property will trigger replacement. str
Advisor assessment name.
locale str
Assessment Type Locale.
type_id str
Assessment Type Id.
workload_id str
Workload Id.
assessmentName Changes to this property will trigger replacement. String
Advisor assessment name.
locale String
Assessment Type Locale.
typeId String
Assessment Type Id.
workloadId String
Workload Id.

Outputs

All input properties are implicitly available as output properties. Additionally, the Assessment resource produces the following output properties:

AssessmentId string
Assessment Id.
AzureApiVersion string
The Azure API version of the resource.
Description string
Assessment Type Description.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Assessment Name
Score int
Assessment Score.
State string
Assessment State.
SystemData Pulumi.AzureNative.Advisor.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource Type
TypeVersion string
Assessment Type Version.
WorkloadName string
Workload Name.
AssessmentId string
Assessment Id.
AzureApiVersion string
The Azure API version of the resource.
Description string
Assessment Type Description.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Assessment Name
Score int
Assessment Score.
State string
Assessment State.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource Type
TypeVersion string
Assessment Type Version.
WorkloadName string
Workload Name.
assessmentId String
Assessment Id.
azureApiVersion String
The Azure API version of the resource.
description String
Assessment Type Description.
id String
The provider-assigned unique ID for this managed resource.
name String
Assessment Name
score Integer
Assessment Score.
state String
Assessment State.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Resource Type
typeVersion String
Assessment Type Version.
workloadName String
Workload Name.
assessmentId string
Assessment Id.
azureApiVersion string
The Azure API version of the resource.
description string
Assessment Type Description.
id string
The provider-assigned unique ID for this managed resource.
name string
Assessment Name
score number
Assessment Score.
state string
Assessment State.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Resource Type
typeVersion string
Assessment Type Version.
workloadName string
Workload Name.
assessment_id str
Assessment Id.
azure_api_version str
The Azure API version of the resource.
description str
Assessment Type Description.
id str
The provider-assigned unique ID for this managed resource.
name str
Assessment Name
score int
Assessment Score.
state str
Assessment State.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Resource Type
type_version str
Assessment Type Version.
workload_name str
Workload Name.
assessmentId String
Assessment Id.
azureApiVersion String
The Azure API version of the resource.
description String
Assessment Type Description.
id String
The provider-assigned unique ID for this managed resource.
name String
Assessment Name
score Number
Assessment Score.
state String
Assessment State.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Resource Type
typeVersion String
Assessment Type Version.
workloadName String
Workload Name.

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:advisor:Assessment MCWAR1 /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native