Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. testbase
  5. ImageDefinition
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.testbase.ImageDefinition

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

The test base image definition resource. Azure REST API version: 2023-11-01-preview.

Example Usage

ImageDefinitionCreate

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

return await Deployment.RunAsync(() => 
{
    var imageDefinition = new AzureNative.TestBase.ImageDefinition("imageDefinition", new()
    {
        Architecture = AzureNative.TestBase.ImageArchitecture.X64,
        ImageDefinitionName = "contoso-image-def",
        OsState = AzureNative.TestBase.ImageOSState.Generalized,
        ResourceGroupName = "contoso-rg1",
        SecurityType = AzureNative.TestBase.ImageSecurityType.Standard,
        TestBaseAccountName = "contoso-testBaseAccount1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := testbase.NewImageDefinition(ctx, "imageDefinition", &testbase.ImageDefinitionArgs{
			Architecture:        pulumi.String(testbase.ImageArchitectureX64),
			ImageDefinitionName: pulumi.String("contoso-image-def"),
			OsState:             pulumi.String(testbase.ImageOSStateGeneralized),
			ResourceGroupName:   pulumi.String("contoso-rg1"),
			SecurityType:        pulumi.String(testbase.ImageSecurityTypeStandard),
			TestBaseAccountName: pulumi.String("contoso-testBaseAccount1"),
		})
		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.testbase.ImageDefinition;
import com.pulumi.azurenative.testbase.ImageDefinitionArgs;
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 imageDefinition = new ImageDefinition("imageDefinition", ImageDefinitionArgs.builder()
            .architecture("x64")
            .imageDefinitionName("contoso-image-def")
            .osState("Generalized")
            .resourceGroupName("contoso-rg1")
            .securityType("Standard")
            .testBaseAccountName("contoso-testBaseAccount1")
            .build());

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

const imageDefinition = new azure_native.testbase.ImageDefinition("imageDefinition", {
    architecture: azure_native.testbase.ImageArchitecture.X64,
    imageDefinitionName: "contoso-image-def",
    osState: azure_native.testbase.ImageOSState.Generalized,
    resourceGroupName: "contoso-rg1",
    securityType: azure_native.testbase.ImageSecurityType.Standard,
    testBaseAccountName: "contoso-testBaseAccount1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

image_definition = azure_native.testbase.ImageDefinition("imageDefinition",
    architecture=azure_native.testbase.ImageArchitecture.X64,
    image_definition_name="contoso-image-def",
    os_state=azure_native.testbase.ImageOSState.GENERALIZED,
    resource_group_name="contoso-rg1",
    security_type=azure_native.testbase.ImageSecurityType.STANDARD,
    test_base_account_name="contoso-testBaseAccount1")
Copy
resources:
  imageDefinition:
    type: azure-native:testbase:ImageDefinition
    properties:
      architecture: x64
      imageDefinitionName: contoso-image-def
      osState: Generalized
      resourceGroupName: contoso-rg1
      securityType: Standard
      testBaseAccountName: contoso-testBaseAccount1
Copy

Create ImageDefinition Resource

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

Constructor syntax

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

@overload
def ImageDefinition(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    architecture: Optional[Union[str, ImageArchitecture]] = None,
                    os_state: Optional[Union[str, ImageOSState]] = None,
                    resource_group_name: Optional[str] = None,
                    security_type: Optional[Union[str, ImageSecurityType]] = None,
                    test_base_account_name: Optional[str] = None,
                    image_definition_name: Optional[str] = None)
func NewImageDefinition(ctx *Context, name string, args ImageDefinitionArgs, opts ...ResourceOption) (*ImageDefinition, error)
public ImageDefinition(string name, ImageDefinitionArgs args, CustomResourceOptions? opts = null)
public ImageDefinition(String name, ImageDefinitionArgs args)
public ImageDefinition(String name, ImageDefinitionArgs args, CustomResourceOptions options)

type: azure-native:testbase:ImageDefinition
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 This property is required. ImageDefinitionArgs
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 This property is required. ImageDefinitionArgs
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 This property is required. ImageDefinitionArgs
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 This property is required. ImageDefinitionArgs
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. ImageDefinitionArgs
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 imageDefinitionResource = new AzureNative.Testbase.ImageDefinition("imageDefinitionResource", new()
{
    Architecture = "string",
    OsState = "string",
    ResourceGroupName = "string",
    SecurityType = "string",
    TestBaseAccountName = "string",
    ImageDefinitionName = "string",
});
Copy
example, err := testbase.NewImageDefinition(ctx, "imageDefinitionResource", &testbase.ImageDefinitionArgs{
	Architecture:        "string",
	OsState:             "string",
	ResourceGroupName:   "string",
	SecurityType:        "string",
	TestBaseAccountName: "string",
	ImageDefinitionName: "string",
})
Copy
var imageDefinitionResource = new ImageDefinition("imageDefinitionResource", ImageDefinitionArgs.builder()
    .architecture("string")
    .osState("string")
    .resourceGroupName("string")
    .securityType("string")
    .testBaseAccountName("string")
    .imageDefinitionName("string")
    .build());
Copy
image_definition_resource = azure_native.testbase.ImageDefinition("imageDefinitionResource",
    architecture=string,
    os_state=string,
    resource_group_name=string,
    security_type=string,
    test_base_account_name=string,
    image_definition_name=string)
Copy
const imageDefinitionResource = new azure_native.testbase.ImageDefinition("imageDefinitionResource", {
    architecture: "string",
    osState: "string",
    resourceGroupName: "string",
    securityType: "string",
    testBaseAccountName: "string",
    imageDefinitionName: "string",
});
Copy
type: azure-native:testbase:ImageDefinition
properties:
    architecture: string
    imageDefinitionName: string
    osState: string
    resourceGroupName: string
    securityType: string
    testBaseAccountName: string
Copy

ImageDefinition 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 ImageDefinition resource accepts the following input properties:

Architecture This property is required. string | Pulumi.AzureNative.TestBase.ImageArchitecture
Custom image architecture.
OsState This property is required. string | Pulumi.AzureNative.TestBase.ImageOSState
Custom image OS state.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SecurityType This property is required. string | Pulumi.AzureNative.TestBase.ImageSecurityType
Custom image security type.
TestBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
ImageDefinitionName Changes to this property will trigger replacement. string
The resource name of the test base image definition.
Architecture This property is required. string | ImageArchitecture
Custom image architecture.
OsState This property is required. string | ImageOSState
Custom image OS state.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SecurityType This property is required. string | ImageSecurityType
Custom image security type.
TestBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
ImageDefinitionName Changes to this property will trigger replacement. string
The resource name of the test base image definition.
architecture This property is required. String | ImageArchitecture
Custom image architecture.
osState This property is required. String | ImageOSState
Custom image OS state.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
securityType This property is required. String | ImageSecurityType
Custom image security type.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the Test Base Account.
imageDefinitionName Changes to this property will trigger replacement. String
The resource name of the test base image definition.
architecture This property is required. string | ImageArchitecture
Custom image architecture.
osState This property is required. string | ImageOSState
Custom image OS state.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
securityType This property is required. string | ImageSecurityType
Custom image security type.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
imageDefinitionName Changes to this property will trigger replacement. string
The resource name of the test base image definition.
architecture This property is required. str | ImageArchitecture
Custom image architecture.
os_state This property is required. str | ImageOSState
Custom image OS state.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
security_type This property is required. str | ImageSecurityType
Custom image security type.
test_base_account_name
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the Test Base Account.
image_definition_name Changes to this property will trigger replacement. str
The resource name of the test base image definition.
architecture This property is required. String | "x64"
Custom image architecture.
osState This property is required. String | "Generalized" | "Specialized"
Custom image OS state.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
securityType This property is required. String | "Standard" | "TrustedLaunch"
Custom image security type.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the Test Base Account.
imageDefinitionName Changes to this property will trigger replacement. String
The resource name of the test base image definition.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
SystemData Pulumi.AzureNative.TestBase.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ImageArchitecture
, ImageArchitectureArgs

X64
x6464-bit architecture.
ImageArchitectureX64
x6464-bit architecture.
X64
x6464-bit architecture.
X64
x6464-bit architecture.
X64
x6464-bit architecture.
"x64"
x6464-bit architecture.

ImageOSState
, ImageOSStateArgs

Generalized
GeneralizedSysprep generalization processed.
Specialized
SpecializedFully kept with user specified settings.
ImageOSStateGeneralized
GeneralizedSysprep generalization processed.
ImageOSStateSpecialized
SpecializedFully kept with user specified settings.
Generalized
GeneralizedSysprep generalization processed.
Specialized
SpecializedFully kept with user specified settings.
Generalized
GeneralizedSysprep generalization processed.
Specialized
SpecializedFully kept with user specified settings.
GENERALIZED
GeneralizedSysprep generalization processed.
SPECIALIZED
SpecializedFully kept with user specified settings.
"Generalized"
GeneralizedSysprep generalization processed.
"Specialized"
SpecializedFully kept with user specified settings.

ImageSecurityType
, ImageSecurityTypeArgs

Standard
StandardStandard security type.
TrustedLaunch
TrustedLaunchSpecify higher security level compared to Standard.
ImageSecurityTypeStandard
StandardStandard security type.
ImageSecurityTypeTrustedLaunch
TrustedLaunchSpecify higher security level compared to Standard.
Standard
StandardStandard security type.
TrustedLaunch
TrustedLaunchSpecify higher security level compared to Standard.
Standard
StandardStandard security type.
TrustedLaunch
TrustedLaunchSpecify higher security level compared to Standard.
STANDARD
StandardStandard security type.
TRUSTED_LAUNCH
TrustedLaunchSpecify higher security level compared to Standard.
"Standard"
StandardStandard security type.
"TrustedLaunch"
TrustedLaunchSpecify higher security level compared to Standard.

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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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:testbase:ImageDefinition contoso-image-def /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/imageDefinitions/{imageDefinitionName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native