1. Packages
  2. Azure Native v2
  3. API Docs
  4. testbase
  5. getCustomImage
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

azure-native-v2.testbase.getCustomImage

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

Gets a test base custom image. Azure REST API version: 2023-11-01-preview.

Using getCustomImage

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 getCustomImage(args: GetCustomImageArgs, opts?: InvokeOptions): Promise<GetCustomImageResult>
function getCustomImageOutput(args: GetCustomImageOutputArgs, opts?: InvokeOptions): Output<GetCustomImageResult>
Copy
def get_custom_image(custom_image_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     test_base_account_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCustomImageResult
def get_custom_image_output(custom_image_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[GetCustomImageResult]
Copy
func LookupCustomImage(ctx *Context, args *LookupCustomImageArgs, opts ...InvokeOption) (*LookupCustomImageResult, error)
func LookupCustomImageOutput(ctx *Context, args *LookupCustomImageOutputArgs, opts ...InvokeOption) LookupCustomImageResultOutput
Copy

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

public static class GetCustomImage 
{
    public static Task<GetCustomImageResult> InvokeAsync(GetCustomImageArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomImageResult> Invoke(GetCustomImageInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomImageResult> getCustomImage(GetCustomImageArgs args, InvokeOptions options)
public static Output<GetCustomImageResult> getCustomImage(GetCustomImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:testbase:getCustomImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CustomImageName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base custom image.
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.
CustomImageName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base custom image.
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.
customImageName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the test base custom image.
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.
customImageName
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the test base custom image.
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.
custom_image_name
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the test base custom image.
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.
customImageName
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the test base custom image.
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.

getCustomImage Result

The following output properties are available:

CreationTime string
The UTC timestamp when the custom image was published.
DefinitionName string
Image definition name.
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
OsDiskImageSizeInGB double
This property indicates the size of the VHD to be created.
Product string
Product of the custom image.
ProvisioningState string
The provisioning state of the resource.
Release string
Release of the custom image OS.
ReleaseVersionDate string
The release version date of the release of the custom image OS.
Source string
Custom image source type.
Status string
Status of the custom image.
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"
ValidationResults Pulumi.AzureNative.TestBase.Outputs.ImageValidationResultsResponse
The validation result of the custom image.
VersionName string
Image version name.
VhdFileName string
The file name of the associated VHD resource.
VhdId string
The Id of the associated VHD resource.
CreationTime string
The UTC timestamp when the custom image was published.
DefinitionName string
Image definition name.
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
OsDiskImageSizeInGB float64
This property indicates the size of the VHD to be created.
Product string
Product of the custom image.
ProvisioningState string
The provisioning state of the resource.
Release string
Release of the custom image OS.
ReleaseVersionDate string
The release version date of the release of the custom image OS.
Source string
Custom image source type.
Status string
Status of the custom image.
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"
ValidationResults ImageValidationResultsResponse
The validation result of the custom image.
VersionName string
Image version name.
VhdFileName string
The file name of the associated VHD resource.
VhdId string
The Id of the associated VHD resource.
creationTime String
The UTC timestamp when the custom image was published.
definitionName String
Image definition name.
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
osDiskImageSizeInGB Double
This property indicates the size of the VHD to be created.
product String
Product of the custom image.
provisioningState String
The provisioning state of the resource.
release String
Release of the custom image OS.
releaseVersionDate String
The release version date of the release of the custom image OS.
source String
Custom image source type.
status String
Status of the custom image.
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"
validationResults ImageValidationResultsResponse
The validation result of the custom image.
versionName String
Image version name.
vhdFileName String
The file name of the associated VHD resource.
vhdId String
The Id of the associated VHD resource.
creationTime string
The UTC timestamp when the custom image was published.
definitionName string
Image definition name.
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
osDiskImageSizeInGB number
This property indicates the size of the VHD to be created.
product string
Product of the custom image.
provisioningState string
The provisioning state of the resource.
release string
Release of the custom image OS.
releaseVersionDate string
The release version date of the release of the custom image OS.
source string
Custom image source type.
status string
Status of the custom image.
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"
validationResults ImageValidationResultsResponse
The validation result of the custom image.
versionName string
Image version name.
vhdFileName string
The file name of the associated VHD resource.
vhdId string
The Id of the associated VHD resource.
creation_time str
The UTC timestamp when the custom image was published.
definition_name str
Image definition name.
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_disk_image_size_in_gb float
This property indicates the size of the VHD to be created.
product str
Product of the custom image.
provisioning_state str
The provisioning state of the resource.
release str
Release of the custom image OS.
release_version_date str
The release version date of the release of the custom image OS.
source str
Custom image source type.
status str
Status of the custom image.
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"
validation_results ImageValidationResultsResponse
The validation result of the custom image.
version_name str
Image version name.
vhd_file_name str
The file name of the associated VHD resource.
vhd_id str
The Id of the associated VHD resource.
creationTime String
The UTC timestamp when the custom image was published.
definitionName String
Image definition name.
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
osDiskImageSizeInGB Number
This property indicates the size of the VHD to be created.
product String
Product of the custom image.
provisioningState String
The provisioning state of the resource.
release String
Release of the custom image OS.
releaseVersionDate String
The release version date of the release of the custom image OS.
source String
Custom image source type.
status String
Status of the custom image.
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"
validationResults Property Map
The validation result of the custom image.
versionName String
Image version name.
vhdFileName String
The file name of the associated VHD resource.
vhdId String
The Id of the associated VHD resource.

Supporting Types

ImageValidationResultsResponse

Results []VerificationResultResponse
The validation results of the image.
results List<VerificationResultResponse>
The validation results of the image.
results VerificationResultResponse[]
The validation results of the image.
results Sequence[VerificationResultResponse]
The validation results of the image.
results List<Property Map>
The validation results of the image.

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

VerificationResultResponse

Result This property is required. string
Indicates if the validation or rule checking is passed.
Message string
Message for clarification.
VerificationName string
The name of the verification rule.
Result This property is required. string
Indicates if the validation or rule checking is passed.
Message string
Message for clarification.
VerificationName string
The name of the verification rule.
result This property is required. String
Indicates if the validation or rule checking is passed.
message String
Message for clarification.
verificationName String
The name of the verification rule.
result This property is required. string
Indicates if the validation or rule checking is passed.
message string
Message for clarification.
verificationName string
The name of the verification rule.
result This property is required. str
Indicates if the validation or rule checking is passed.
message str
Message for clarification.
verification_name str
The name of the verification rule.
result This property is required. String
Indicates if the validation or rule checking is passed.
message String
Message for clarification.
verificationName String
The name of the verification rule.

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