Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getCustomImage
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.getCustomImage

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get custom image. Azure REST API version: 2018-09-15.

    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>
    def get_custom_image(expand: Optional[str] = None,
                     lab_name: Optional[str] = None,
                     name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCustomImageResult
def get_custom_image_output(expand: Optional[pulumi.Input[str]] = None,
                     lab_name: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCustomImageResult]
    func LookupCustomImage(ctx *Context, args *LookupCustomImageArgs, opts ...InvokeOption) (*LookupCustomImageResult, error)
func LookupCustomImageOutput(ctx *Context, args *LookupCustomImageOutputArgs, opts ...InvokeOption) LookupCustomImageResultOutput

    > 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)
}
    public static CompletableFuture<GetCustomImageResult> getCustomImage(GetCustomImageArgs args, InvokeOptions options)
public static Output<GetCustomImageResult> getCustomImage(GetCustomImageArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:devtestlab:getCustomImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LabName string
    The name of the lab.
    Name string
    The name of the custom image.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=vm)'
    LabName string
    The name of the lab.
    Name string
    The name of the custom image.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=vm)'
    labName String
    The name of the lab.
    name String
    The name of the custom image.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=vm)'
    labName string
    The name of the lab.
    name string
    The name of the custom image.
    resourceGroupName string
    The name of the resource group.
    expand string
    Specify the $expand query. Example: 'properties($select=vm)'
    lab_name str
    The name of the lab.
    name str
    The name of the custom image.
    resource_group_name str
    The name of the resource group.
    expand str
    Specify the $expand query. Example: 'properties($select=vm)'
    labName String
    The name of the lab.
    name String
    The name of the custom image.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=vm)'

    getCustomImage Result

    The following output properties are available:

    CreationDate string
    The creation date of the custom image.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Author string
    The author of the custom image.
    CustomImagePlan Pulumi.AzureNative.DevTestLab.Outputs.CustomImagePropertiesFromPlanResponse
    Storage information about the plan related to this custom image
    DataDiskStorageInfo List<Pulumi.AzureNative.DevTestLab.Outputs.DataDiskStorageTypeInfoResponse>
    Storage information about the data disks present in the custom image
    Description string
    The description of the custom image.
    IsPlanAuthorized bool
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    Location string
    The location of the resource.
    ManagedImageId string
    The Managed Image Id backing the custom image.
    ManagedSnapshotId string
    The Managed Snapshot Id backing the custom image.
    Tags Dictionary<string, string>
    The tags of the resource.
    Vhd Pulumi.AzureNative.DevTestLab.Outputs.CustomImagePropertiesCustomResponse
    The VHD from which the image is to be created.
    Vm Pulumi.AzureNative.DevTestLab.Outputs.CustomImagePropertiesFromVmResponse
    The virtual machine from which the image is to be created.
    CreationDate string
    The creation date of the custom image.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Author string
    The author of the custom image.
    CustomImagePlan CustomImagePropertiesFromPlanResponse
    Storage information about the plan related to this custom image
    DataDiskStorageInfo []DataDiskStorageTypeInfoResponse
    Storage information about the data disks present in the custom image
    Description string
    The description of the custom image.
    IsPlanAuthorized bool
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    Location string
    The location of the resource.
    ManagedImageId string
    The Managed Image Id backing the custom image.
    ManagedSnapshotId string
    The Managed Snapshot Id backing the custom image.
    Tags map[string]string
    The tags of the resource.
    Vhd CustomImagePropertiesCustomResponse
    The VHD from which the image is to be created.
    Vm CustomImagePropertiesFromVmResponse
    The virtual machine from which the image is to be created.
    creationDate String
    The creation date of the custom image.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    author String
    The author of the custom image.
    customImagePlan CustomImagePropertiesFromPlanResponse
    Storage information about the plan related to this custom image
    dataDiskStorageInfo List<DataDiskStorageTypeInfoResponse>
    Storage information about the data disks present in the custom image
    description String
    The description of the custom image.
    isPlanAuthorized Boolean
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    location String
    The location of the resource.
    managedImageId String
    The Managed Image Id backing the custom image.
    managedSnapshotId String
    The Managed Snapshot Id backing the custom image.
    tags Map<String,String>
    The tags of the resource.
    vhd CustomImagePropertiesCustomResponse
    The VHD from which the image is to be created.
    vm CustomImagePropertiesFromVmResponse
    The virtual machine from which the image is to be created.
    creationDate string
    The creation date of the custom image.
    id string
    The identifier of the resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning status of the resource.
    type string
    The type of the resource.
    uniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    author string
    The author of the custom image.
    customImagePlan CustomImagePropertiesFromPlanResponse
    Storage information about the plan related to this custom image
    dataDiskStorageInfo DataDiskStorageTypeInfoResponse[]
    Storage information about the data disks present in the custom image
    description string
    The description of the custom image.
    isPlanAuthorized boolean
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    location string
    The location of the resource.
    managedImageId string
    The Managed Image Id backing the custom image.
    managedSnapshotId string
    The Managed Snapshot Id backing the custom image.
    tags {[key: string]: string}
    The tags of the resource.
    vhd CustomImagePropertiesCustomResponse
    The VHD from which the image is to be created.
    vm CustomImagePropertiesFromVmResponse
    The virtual machine from which the image is to be created.
    creation_date str
    The creation date of the custom image.
    id str
    The identifier of the resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning status of the resource.
    type str
    The type of the resource.
    unique_identifier str
    The unique immutable identifier of a resource (Guid).
    author str
    The author of the custom image.
    custom_image_plan CustomImagePropertiesFromPlanResponse
    Storage information about the plan related to this custom image
    data_disk_storage_info Sequence[DataDiskStorageTypeInfoResponse]
    Storage information about the data disks present in the custom image
    description str
    The description of the custom image.
    is_plan_authorized bool
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    location str
    The location of the resource.
    managed_image_id str
    The Managed Image Id backing the custom image.
    managed_snapshot_id str
    The Managed Snapshot Id backing the custom image.
    tags Mapping[str, str]
    The tags of the resource.
    vhd CustomImagePropertiesCustomResponse
    The VHD from which the image is to be created.
    vm CustomImagePropertiesFromVmResponse
    The virtual machine from which the image is to be created.
    creationDate String
    The creation date of the custom image.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    author String
    The author of the custom image.
    customImagePlan Property Map
    Storage information about the plan related to this custom image
    dataDiskStorageInfo List<Property Map>
    Storage information about the data disks present in the custom image
    description String
    The description of the custom image.
    isPlanAuthorized Boolean
    Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
    location String
    The location of the resource.
    managedImageId String
    The Managed Image Id backing the custom image.
    managedSnapshotId String
    The Managed Snapshot Id backing the custom image.
    tags Map<String>
    The tags of the resource.
    vhd Property Map
    The VHD from which the image is to be created.
    vm Property Map
    The virtual machine from which the image is to be created.

    Supporting Types

    CustomImagePropertiesCustomResponse

    OsType string
    The OS type of the custom image (i.e. Windows, Linux)
    ImageName string
    The image name.
    SysPrep bool
    Indicates whether sysprep has been run on the VHD.
    OsType string
    The OS type of the custom image (i.e. Windows, Linux)
    ImageName string
    The image name.
    SysPrep bool
    Indicates whether sysprep has been run on the VHD.
    osType String
    The OS type of the custom image (i.e. Windows, Linux)
    imageName String
    The image name.
    sysPrep Boolean
    Indicates whether sysprep has been run on the VHD.
    osType string
    The OS type of the custom image (i.e. Windows, Linux)
    imageName string
    The image name.
    sysPrep boolean
    Indicates whether sysprep has been run on the VHD.
    os_type str
    The OS type of the custom image (i.e. Windows, Linux)
    image_name str
    The image name.
    sys_prep bool
    Indicates whether sysprep has been run on the VHD.
    osType String
    The OS type of the custom image (i.e. Windows, Linux)
    imageName String
    The image name.
    sysPrep Boolean
    Indicates whether sysprep has been run on the VHD.

    CustomImagePropertiesFromPlanResponse

    Id string
    The id of the plan, equivalent to name of the plan
    Offer string
    The offer for the plan from the marketplace image the custom image is derived from
    Publisher string
    The publisher for the plan from the marketplace image the custom image is derived from
    Id string
    The id of the plan, equivalent to name of the plan
    Offer string
    The offer for the plan from the marketplace image the custom image is derived from
    Publisher string
    The publisher for the plan from the marketplace image the custom image is derived from
    id String
    The id of the plan, equivalent to name of the plan
    offer String
    The offer for the plan from the marketplace image the custom image is derived from
    publisher String
    The publisher for the plan from the marketplace image the custom image is derived from
    id string
    The id of the plan, equivalent to name of the plan
    offer string
    The offer for the plan from the marketplace image the custom image is derived from
    publisher string
    The publisher for the plan from the marketplace image the custom image is derived from
    id str
    The id of the plan, equivalent to name of the plan
    offer str
    The offer for the plan from the marketplace image the custom image is derived from
    publisher str
    The publisher for the plan from the marketplace image the custom image is derived from
    id String
    The id of the plan, equivalent to name of the plan
    offer String
    The offer for the plan from the marketplace image the custom image is derived from
    publisher String
    The publisher for the plan from the marketplace image the custom image is derived from

    CustomImagePropertiesFromVmResponse

    LinuxOsInfo Pulumi.AzureNative.DevTestLab.Inputs.LinuxOsInfoResponse
    The Linux OS information of the VM.
    SourceVmId string
    The source vm identifier.
    WindowsOsInfo Pulumi.AzureNative.DevTestLab.Inputs.WindowsOsInfoResponse
    The Windows OS information of the VM.
    LinuxOsInfo LinuxOsInfoResponse
    The Linux OS information of the VM.
    SourceVmId string
    The source vm identifier.
    WindowsOsInfo WindowsOsInfoResponse
    The Windows OS information of the VM.
    linuxOsInfo LinuxOsInfoResponse
    The Linux OS information of the VM.
    sourceVmId String
    The source vm identifier.
    windowsOsInfo WindowsOsInfoResponse
    The Windows OS information of the VM.
    linuxOsInfo LinuxOsInfoResponse
    The Linux OS information of the VM.
    sourceVmId string
    The source vm identifier.
    windowsOsInfo WindowsOsInfoResponse
    The Windows OS information of the VM.
    linux_os_info LinuxOsInfoResponse
    The Linux OS information of the VM.
    source_vm_id str
    The source vm identifier.
    windows_os_info WindowsOsInfoResponse
    The Windows OS information of the VM.
    linuxOsInfo Property Map
    The Linux OS information of the VM.
    sourceVmId String
    The source vm identifier.
    windowsOsInfo Property Map
    The Windows OS information of the VM.

    DataDiskStorageTypeInfoResponse

    Lun string
    Disk Lun
    StorageType string
    Disk Storage Type
    Lun string
    Disk Lun
    StorageType string
    Disk Storage Type
    lun String
    Disk Lun
    storageType String
    Disk Storage Type
    lun string
    Disk Lun
    storageType string
    Disk Storage Type
    lun str
    Disk Lun
    storage_type str
    Disk Storage Type
    lun String
    Disk Lun
    storageType String
    Disk Storage Type

    LinuxOsInfoResponse

    LinuxOsState string
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
    LinuxOsState string
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
    linuxOsState String
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
    linuxOsState string
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
    linux_os_state str
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
    linuxOsState String
    The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).

    WindowsOsInfoResponse

    WindowsOsState string
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).
    WindowsOsState string
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).
    windowsOsState String
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).
    windowsOsState string
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).
    windows_os_state str
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).
    windowsOsState String
    The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).

    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native