Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. testbase
  5. getImageDefinition
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.testbase.getImageDefinition

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Get image properties under the image definition name created by test base custom image which derived from ‘VHD’ source.

Uses Azure REST API version 2023-11-01-preview.

Using getImageDefinition

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 getImageDefinition(args: GetImageDefinitionArgs, opts?: InvokeOptions): Promise<GetImageDefinitionResult>
function getImageDefinitionOutput(args: GetImageDefinitionOutputArgs, opts?: InvokeOptions): Output<GetImageDefinitionResult>
Copy
def get_image_definition(image_definition_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         test_base_account_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetImageDefinitionResult
def get_image_definition_output(image_definition_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         test_base_account_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetImageDefinitionResult]
Copy
func LookupImageDefinition(ctx *Context, args *LookupImageDefinitionArgs, opts ...InvokeOption) (*LookupImageDefinitionResult, error)
func LookupImageDefinitionOutput(ctx *Context, args *LookupImageDefinitionOutputArgs, opts ...InvokeOption) LookupImageDefinitionResultOutput
Copy

> Note: This function is named LookupImageDefinition in the Go SDK.

public static class GetImageDefinition 
{
    public static Task<GetImageDefinitionResult> InvokeAsync(GetImageDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetImageDefinitionResult> Invoke(GetImageDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImageDefinitionResult> getImageDefinition(GetImageDefinitionArgs args, InvokeOptions options)
public static Output<GetImageDefinitionResult> getImageDefinition(GetImageDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:testbase:getImageDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ImageDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base image definition.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TestBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
ImageDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base image definition.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TestBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
imageDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the test base image definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the Test Base Account.
imageDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base image definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the Test Base Account.
image_definition_name
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the test base image definition.
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.
test_base_account_name
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the Test Base Account.
imageDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the test base image definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
testBaseAccountName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the Test Base Account.

getImageDefinition Result

The following output properties are available:

Architecture string
Custom image architecture.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
OsState string
Custom image OS state.
ProvisioningState string
SecurityType string
Custom image security type.
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"
Architecture string
Custom image architecture.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
OsState string
Custom image OS state.
ProvisioningState string
SecurityType string
Custom image security type.
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"
architecture String
Custom image architecture.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
osState String
Custom image OS state.
provisioningState String
securityType String
Custom image security type.
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"
architecture string
Custom image architecture.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
osState string
Custom image OS state.
provisioningState string
securityType string
Custom image security type.
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"
architecture str
Custom image architecture.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
os_state str
Custom image OS state.
provisioning_state str
security_type str
Custom image security type.
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"
architecture String
Custom image architecture.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
osState String
Custom image OS state.
provisioningState String
securityType String
Custom image security type.
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

SystemDataResponse

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.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native