Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. virtualmachineimages
  5. getVirtualMachineImageTemplate
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.virtualmachineimages.getVirtualMachineImageTemplate

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get information about a virtual machine image template API Version: 2020-02-14.

    Using getVirtualMachineImageTemplate

    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 getVirtualMachineImageTemplate(args: GetVirtualMachineImageTemplateArgs, opts?: InvokeOptions): Promise<GetVirtualMachineImageTemplateResult>
function getVirtualMachineImageTemplateOutput(args: GetVirtualMachineImageTemplateOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineImageTemplateResult>
    def get_virtual_machine_image_template(image_template_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetVirtualMachineImageTemplateResult
def get_virtual_machine_image_template_output(image_template_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineImageTemplateResult]
    func LookupVirtualMachineImageTemplate(ctx *Context, args *LookupVirtualMachineImageTemplateArgs, opts ...InvokeOption) (*LookupVirtualMachineImageTemplateResult, error)
func LookupVirtualMachineImageTemplateOutput(ctx *Context, args *LookupVirtualMachineImageTemplateOutputArgs, opts ...InvokeOption) LookupVirtualMachineImageTemplateResultOutput

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

    public static class GetVirtualMachineImageTemplate 
{
    public static Task<GetVirtualMachineImageTemplateResult> InvokeAsync(GetVirtualMachineImageTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineImageTemplateResult> Invoke(GetVirtualMachineImageTemplateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualMachineImageTemplateResult> getVirtualMachineImageTemplate(GetVirtualMachineImageTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:virtualmachineimages:getVirtualMachineImageTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ImageTemplateName string
    The name of the image Template
    ResourceGroupName string
    The name of the resource group.
    ImageTemplateName string
    The name of the image Template
    ResourceGroupName string
    The name of the resource group.
    imageTemplateName String
    The name of the image Template
    resourceGroupName String
    The name of the resource group.
    imageTemplateName string
    The name of the image Template
    resourceGroupName string
    The name of the resource group.
    image_template_name str
    The name of the image Template
    resource_group_name str
    The name of the resource group.
    imageTemplateName String
    The name of the image Template
    resourceGroupName String
    The name of the resource group.

    getVirtualMachineImageTemplate Result

    The following output properties are available:

    Distribute List<object>
    The distribution targets where the image output needs to go to.
    Id string
    Resource Id
    Identity Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplateIdentityResponse
    The identity of the image template, if configured.
    LastRunStatus Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplateLastRunStatusResponse
    State of 'run' that is currently executing or was last executed.
    Location string
    Resource location
    Name string
    Resource name
    ProvisioningError Pulumi.AzureNative.VirtualMachineImages.Outputs.ProvisioningErrorResponse
    Provisioning error, if any
    ProvisioningState string
    Provisioning state of the resource
    Source Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplateManagedImageSourceResponse | Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplatePlatformImageSourceResponse | Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplateSharedImageVersionSourceResponse
    Specifies the properties used to describe the source image.
    Type string
    Resource type
    BuildTimeoutInMinutes int
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    Customize List<object>
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    Tags Dictionary<string, string>
    Resource tags
    VmProfile Pulumi.AzureNative.VirtualMachineImages.Outputs.ImageTemplateVmProfileResponse
    Describes how virtual machine is set up to build images
    Distribute []interface{}
    The distribution targets where the image output needs to go to.
    Id string
    Resource Id
    Identity ImageTemplateIdentityResponse
    The identity of the image template, if configured.
    LastRunStatus ImageTemplateLastRunStatusResponse
    State of 'run' that is currently executing or was last executed.
    Location string
    Resource location
    Name string
    Resource name
    ProvisioningError ProvisioningErrorResponse
    Provisioning error, if any
    ProvisioningState string
    Provisioning state of the resource
    Source ImageTemplateManagedImageSourceResponse | ImageTemplatePlatformImageSourceResponse | ImageTemplateSharedImageVersionSourceResponse
    Specifies the properties used to describe the source image.
    Type string
    Resource type
    BuildTimeoutInMinutes int
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    Customize []interface{}
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    Tags map[string]string
    Resource tags
    VmProfile ImageTemplateVmProfileResponse
    Describes how virtual machine is set up to build images
    distribute List<Object>
    The distribution targets where the image output needs to go to.
    id String
    Resource Id
    identity ImageTemplateIdentityResponse
    The identity of the image template, if configured.
    lastRunStatus ImageTemplateLastRunStatusResponse
    State of 'run' that is currently executing or was last executed.
    location String
    Resource location
    name String
    Resource name
    provisioningError ProvisioningErrorResponse
    Provisioning error, if any
    provisioningState String
    Provisioning state of the resource
    source ImageTemplateManagedImageSourceResponse | ImageTemplatePlatformImageSourceResponse | ImageTemplateSharedImageVersionSourceResponse
    Specifies the properties used to describe the source image.
    type String
    Resource type
    buildTimeoutInMinutes Integer
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    customize List<Object>
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    tags Map<String,String>
    Resource tags
    vmProfile ImageTemplateVmProfileResponse
    Describes how virtual machine is set up to build images
    distribute (ImageTemplateManagedImageDistributorResponse | ImageTemplateSharedImageDistributorResponse | ImageTemplateVhdDistributorResponse)[]
    The distribution targets where the image output needs to go to.
    id string
    Resource Id
    identity ImageTemplateIdentityResponse
    The identity of the image template, if configured.
    lastRunStatus ImageTemplateLastRunStatusResponse
    State of 'run' that is currently executing or was last executed.
    location string
    Resource location
    name string
    Resource name
    provisioningError ProvisioningErrorResponse
    Provisioning error, if any
    provisioningState string
    Provisioning state of the resource
    source ImageTemplateManagedImageSourceResponse | ImageTemplatePlatformImageSourceResponse | ImageTemplateSharedImageVersionSourceResponse
    Specifies the properties used to describe the source image.
    type string
    Resource type
    buildTimeoutInMinutes number
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    customize (ImageTemplateFileCustomizerResponse | ImageTemplatePowerShellCustomizerResponse | ImageTemplateRestartCustomizerResponse | ImageTemplateShellCustomizerResponse | ImageTemplateWindowsUpdateCustomizerResponse)[]
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    tags {[key: string]: string}
    Resource tags
    vmProfile ImageTemplateVmProfileResponse
    Describes how virtual machine is set up to build images
    distribute Sequence[Any]
    The distribution targets where the image output needs to go to.
    id str
    Resource Id
    identity ImageTemplateIdentityResponse
    The identity of the image template, if configured.
    last_run_status ImageTemplateLastRunStatusResponse
    State of 'run' that is currently executing or was last executed.
    location str
    Resource location
    name str
    Resource name
    provisioning_error ProvisioningErrorResponse
    Provisioning error, if any
    provisioning_state str
    Provisioning state of the resource
    source ImageTemplateManagedImageSourceResponse | ImageTemplatePlatformImageSourceResponse | ImageTemplateSharedImageVersionSourceResponse
    Specifies the properties used to describe the source image.
    type str
    Resource type
    build_timeout_in_minutes int
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    customize Sequence[Any]
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    tags Mapping[str, str]
    Resource tags
    vm_profile ImageTemplateVmProfileResponse
    Describes how virtual machine is set up to build images
    distribute List<Property Map | Property Map | Property Map>
    The distribution targets where the image output needs to go to.
    id String
    Resource Id
    identity Property Map
    The identity of the image template, if configured.
    lastRunStatus Property Map
    State of 'run' that is currently executing or was last executed.
    location String
    Resource location
    name String
    Resource name
    provisioningError Property Map
    Provisioning error, if any
    provisioningState String
    Provisioning state of the resource
    source Property Map | Property Map | Property Map
    Specifies the properties used to describe the source image.
    type String
    Resource type
    buildTimeoutInMinutes Number
    Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).
    customize List<Property Map | Property Map | Property Map | Property Map | Property Map>
    Specifies the properties used to describe the customization steps of the image, like Image source etc
    tags Map<String>
    Resource tags
    vmProfile Property Map
    Describes how virtual machine is set up to build images

    Supporting Types

    ImageTemplateFileCustomizerResponse

    Destination string
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    Name string
    Friendly Name to provide context on what this customization step does
    Sha256Checksum string
    SHA256 checksum of the file provided in the sourceUri field above
    SourceUri string
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc
    Destination string
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    Name string
    Friendly Name to provide context on what this customization step does
    Sha256Checksum string
    SHA256 checksum of the file provided in the sourceUri field above
    SourceUri string
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc
    destination String
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    name String
    Friendly Name to provide context on what this customization step does
    sha256Checksum String
    SHA256 checksum of the file provided in the sourceUri field above
    sourceUri String
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc
    destination string
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    name string
    Friendly Name to provide context on what this customization step does
    sha256Checksum string
    SHA256 checksum of the file provided in the sourceUri field above
    sourceUri string
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc
    destination str
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    name str
    Friendly Name to provide context on what this customization step does
    sha256_checksum str
    SHA256 checksum of the file provided in the sourceUri field above
    source_uri str
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc
    destination String
    The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM
    name String
    Friendly Name to provide context on what this customization step does
    sha256Checksum String
    SHA256 checksum of the file provided in the sourceUri field above
    sourceUri String
    The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc

    ImageTemplateIdentityResponse

    Type string
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.VirtualMachineImages.Inputs.ImageTemplateIdentityResponseUserAssignedIdentities>
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    Type string
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    UserAssignedIdentities map[string]ImageTemplateIdentityResponseUserAssignedIdentities
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    type String
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    userAssignedIdentities Map<String,ImageTemplateIdentityResponseUserAssignedIdentities>
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    type string
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    userAssignedIdentities {[key: string]: ImageTemplateIdentityResponseUserAssignedIdentities}
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    type str
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    user_assigned_identities Mapping[str, ImageTemplateIdentityResponseUserAssignedIdentities]
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    type String
    The type of identity used for the image template. The type 'None' will remove any identities from the image template.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    ImageTemplateIdentityResponseUserAssignedIdentities

    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.
    clientId string
    The client id of user assigned identity.
    principalId string
    The principal id of user assigned identity.
    client_id str
    The client id of user assigned identity.
    principal_id str
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.

    ImageTemplateLastRunStatusResponse

    EndTime string
    End time of the last run (UTC)
    Message string
    Verbose information about the last run state
    RunState string
    State of the last run
    RunSubState string
    Sub-state of the last run
    StartTime string
    Start time of the last run (UTC)
    EndTime string
    End time of the last run (UTC)
    Message string
    Verbose information about the last run state
    RunState string
    State of the last run
    RunSubState string
    Sub-state of the last run
    StartTime string
    Start time of the last run (UTC)
    endTime String
    End time of the last run (UTC)
    message String
    Verbose information about the last run state
    runState String
    State of the last run
    runSubState String
    Sub-state of the last run
    startTime String
    Start time of the last run (UTC)
    endTime string
    End time of the last run (UTC)
    message string
    Verbose information about the last run state
    runState string
    State of the last run
    runSubState string
    Sub-state of the last run
    startTime string
    Start time of the last run (UTC)
    end_time str
    End time of the last run (UTC)
    message str
    Verbose information about the last run state
    run_state str
    State of the last run
    run_sub_state str
    Sub-state of the last run
    start_time str
    Start time of the last run (UTC)
    endTime String
    End time of the last run (UTC)
    message String
    Verbose information about the last run state
    runState String
    State of the last run
    runSubState String
    Sub-state of the last run
    startTime String
    Start time of the last run (UTC)

    ImageTemplateManagedImageDistributorResponse

    ImageId string
    Resource Id of the Managed Disk Image
    Location string
    Azure location for the image, should match if image already exists
    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags Dictionary<string, string>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    ImageId string
    Resource Id of the Managed Disk Image
    Location string
    Azure location for the image, should match if image already exists
    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags map[string]string
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    imageId String
    Resource Id of the Managed Disk Image
    location String
    Azure location for the image, should match if image already exists
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String,String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    imageId string
    Resource Id of the Managed Disk Image
    location string
    Azure location for the image, should match if image already exists
    runOutputName string
    The name to be used for the associated RunOutput.
    artifactTags {[key: string]: string}
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    image_id str
    Resource Id of the Managed Disk Image
    location str
    Azure location for the image, should match if image already exists
    run_output_name str
    The name to be used for the associated RunOutput.
    artifact_tags Mapping[str, str]
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    imageId String
    Resource Id of the Managed Disk Image
    location String
    Azure location for the image, should match if image already exists
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.

    ImageTemplateManagedImageSourceResponse

    ImageId string
    ARM resource id of the managed image in customer subscription
    ImageId string
    ARM resource id of the managed image in customer subscription
    imageId String
    ARM resource id of the managed image in customer subscription
    imageId string
    ARM resource id of the managed image in customer subscription
    image_id str
    ARM resource id of the managed image in customer subscription
    imageId String
    ARM resource id of the managed image in customer subscription

    ImageTemplatePlatformImageSourceResponse

    Offer string
    Image offer from the Azure Gallery Images.
    PlanInfo Pulumi.AzureNative.VirtualMachineImages.Inputs.PlatformImagePurchasePlanResponse
    Optional configuration of purchase plan for platform image.
    Publisher string
    Image Publisher in Azure Gallery Images.
    Sku string
    Image sku from the Azure Gallery Images.
    Version string
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.
    Offer string
    Image offer from the Azure Gallery Images.
    PlanInfo PlatformImagePurchasePlanResponse
    Optional configuration of purchase plan for platform image.
    Publisher string
    Image Publisher in Azure Gallery Images.
    Sku string
    Image sku from the Azure Gallery Images.
    Version string
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.
    offer String
    Image offer from the Azure Gallery Images.
    planInfo PlatformImagePurchasePlanResponse
    Optional configuration of purchase plan for platform image.
    publisher String
    Image Publisher in Azure Gallery Images.
    sku String
    Image sku from the Azure Gallery Images.
    version String
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.
    offer string
    Image offer from the Azure Gallery Images.
    planInfo PlatformImagePurchasePlanResponse
    Optional configuration of purchase plan for platform image.
    publisher string
    Image Publisher in Azure Gallery Images.
    sku string
    Image sku from the Azure Gallery Images.
    version string
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.
    offer str
    Image offer from the Azure Gallery Images.
    plan_info PlatformImagePurchasePlanResponse
    Optional configuration of purchase plan for platform image.
    publisher str
    Image Publisher in Azure Gallery Images.
    sku str
    Image sku from the Azure Gallery Images.
    version str
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.
    offer String
    Image offer from the Azure Gallery Images.
    planInfo Property Map
    Optional configuration of purchase plan for platform image.
    publisher String
    Image Publisher in Azure Gallery Images.
    sku String
    Image sku from the Azure Gallery Images.
    version String
    Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. Specifying 'latest' could cause ROUNDTRIP_INCONSISTENT_PROPERTY issue which will be fixed.

    ImageTemplatePowerShellCustomizerResponse

    Inline List<string>
    Array of PowerShell commands to execute
    Name string
    Friendly Name to provide context on what this customization step does
    RunAsSystem bool
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    RunElevated bool
    If specified, the PowerShell script will be run with elevated privileges
    ScriptUri string
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    Sha256Checksum string
    SHA256 checksum of the power shell script provided in the scriptUri field above
    ValidExitCodes List<int>
    Valid exit codes for the PowerShell script. [Default: 0]
    Inline []string
    Array of PowerShell commands to execute
    Name string
    Friendly Name to provide context on what this customization step does
    RunAsSystem bool
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    RunElevated bool
    If specified, the PowerShell script will be run with elevated privileges
    ScriptUri string
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    Sha256Checksum string
    SHA256 checksum of the power shell script provided in the scriptUri field above
    ValidExitCodes []int
    Valid exit codes for the PowerShell script. [Default: 0]
    inline List<String>
    Array of PowerShell commands to execute
    name String
    Friendly Name to provide context on what this customization step does
    runAsSystem Boolean
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    runElevated Boolean
    If specified, the PowerShell script will be run with elevated privileges
    scriptUri String
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum String
    SHA256 checksum of the power shell script provided in the scriptUri field above
    validExitCodes List<Integer>
    Valid exit codes for the PowerShell script. [Default: 0]
    inline string[]
    Array of PowerShell commands to execute
    name string
    Friendly Name to provide context on what this customization step does
    runAsSystem boolean
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    runElevated boolean
    If specified, the PowerShell script will be run with elevated privileges
    scriptUri string
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum string
    SHA256 checksum of the power shell script provided in the scriptUri field above
    validExitCodes number[]
    Valid exit codes for the PowerShell script. [Default: 0]
    inline Sequence[str]
    Array of PowerShell commands to execute
    name str
    Friendly Name to provide context on what this customization step does
    run_as_system bool
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    run_elevated bool
    If specified, the PowerShell script will be run with elevated privileges
    script_uri str
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256_checksum str
    SHA256 checksum of the power shell script provided in the scriptUri field above
    valid_exit_codes Sequence[int]
    Valid exit codes for the PowerShell script. [Default: 0]
    inline List<String>
    Array of PowerShell commands to execute
    name String
    Friendly Name to provide context on what this customization step does
    runAsSystem Boolean
    If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true.
    runElevated Boolean
    If specified, the PowerShell script will be run with elevated privileges
    scriptUri String
    URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum String
    SHA256 checksum of the power shell script provided in the scriptUri field above
    validExitCodes List<Number>
    Valid exit codes for the PowerShell script. [Default: 0]

    ImageTemplateRestartCustomizerResponse

    Name string
    Friendly Name to provide context on what this customization step does
    RestartCheckCommand string
    Command to check if restart succeeded [Default: '']
    RestartCommand string
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    RestartTimeout string
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']
    Name string
    Friendly Name to provide context on what this customization step does
    RestartCheckCommand string
    Command to check if restart succeeded [Default: '']
    RestartCommand string
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    RestartTimeout string
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']
    name String
    Friendly Name to provide context on what this customization step does
    restartCheckCommand String
    Command to check if restart succeeded [Default: '']
    restartCommand String
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    restartTimeout String
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']
    name string
    Friendly Name to provide context on what this customization step does
    restartCheckCommand string
    Command to check if restart succeeded [Default: '']
    restartCommand string
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    restartTimeout string
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']
    name str
    Friendly Name to provide context on what this customization step does
    restart_check_command str
    Command to check if restart succeeded [Default: '']
    restart_command str
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    restart_timeout str
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']
    name String
    Friendly Name to provide context on what this customization step does
    restartCheckCommand String
    Command to check if restart succeeded [Default: '']
    restartCommand String
    Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
    restartTimeout String
    Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']

    ImageTemplateSharedImageDistributorResponse

    GalleryImageId string
    Resource Id of the Shared Image Gallery image
    ReplicationRegions List<string>
    A list of regions that the image will be replicated to
    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags Dictionary<string, string>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    ExcludeFromLatest bool
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    StorageAccountType string
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).
    GalleryImageId string
    Resource Id of the Shared Image Gallery image
    ReplicationRegions []string
    A list of regions that the image will be replicated to
    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags map[string]string
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    ExcludeFromLatest bool
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    StorageAccountType string
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).
    galleryImageId String
    Resource Id of the Shared Image Gallery image
    replicationRegions List<String>
    A list of regions that the image will be replicated to
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String,String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    excludeFromLatest Boolean
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    storageAccountType String
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).
    galleryImageId string
    Resource Id of the Shared Image Gallery image
    replicationRegions string[]
    A list of regions that the image will be replicated to
    runOutputName string
    The name to be used for the associated RunOutput.
    artifactTags {[key: string]: string}
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    excludeFromLatest boolean
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    storageAccountType string
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).
    gallery_image_id str
    Resource Id of the Shared Image Gallery image
    replication_regions Sequence[str]
    A list of regions that the image will be replicated to
    run_output_name str
    The name to be used for the associated RunOutput.
    artifact_tags Mapping[str, str]
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    exclude_from_latest bool
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    storage_account_type str
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).
    galleryImageId String
    Resource Id of the Shared Image Gallery image
    replicationRegions List<String>
    A list of regions that the image will be replicated to
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    excludeFromLatest Boolean
    Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
    storageAccountType String
    Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS).

    ImageTemplateSharedImageVersionSourceResponse

    ImageVersionId string
    ARM resource id of the image version in the shared image gallery
    ImageVersionId string
    ARM resource id of the image version in the shared image gallery
    imageVersionId String
    ARM resource id of the image version in the shared image gallery
    imageVersionId string
    ARM resource id of the image version in the shared image gallery
    image_version_id str
    ARM resource id of the image version in the shared image gallery
    imageVersionId String
    ARM resource id of the image version in the shared image gallery

    ImageTemplateShellCustomizerResponse

    Inline List<string>
    Array of shell commands to execute
    Name string
    Friendly Name to provide context on what this customization step does
    ScriptUri string
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    Sha256Checksum string
    SHA256 checksum of the shell script provided in the scriptUri field
    Inline []string
    Array of shell commands to execute
    Name string
    Friendly Name to provide context on what this customization step does
    ScriptUri string
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    Sha256Checksum string
    SHA256 checksum of the shell script provided in the scriptUri field
    inline List<String>
    Array of shell commands to execute
    name String
    Friendly Name to provide context on what this customization step does
    scriptUri String
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum String
    SHA256 checksum of the shell script provided in the scriptUri field
    inline string[]
    Array of shell commands to execute
    name string
    Friendly Name to provide context on what this customization step does
    scriptUri string
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum string
    SHA256 checksum of the shell script provided in the scriptUri field
    inline Sequence[str]
    Array of shell commands to execute
    name str
    Friendly Name to provide context on what this customization step does
    script_uri str
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256_checksum str
    SHA256 checksum of the shell script provided in the scriptUri field
    inline List<String>
    Array of shell commands to execute
    name String
    Friendly Name to provide context on what this customization step does
    scriptUri String
    URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc
    sha256Checksum String
    SHA256 checksum of the shell script provided in the scriptUri field

    ImageTemplateVhdDistributorResponse

    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags Dictionary<string, string>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    RunOutputName string
    The name to be used for the associated RunOutput.
    ArtifactTags map[string]string
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String,String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    runOutputName string
    The name to be used for the associated RunOutput.
    artifactTags {[key: string]: string}
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    run_output_name str
    The name to be used for the associated RunOutput.
    artifact_tags Mapping[str, str]
    Tags that will be applied to the artifact once it has been created/updated by the distributor.
    runOutputName String
    The name to be used for the associated RunOutput.
    artifactTags Map<String>
    Tags that will be applied to the artifact once it has been created/updated by the distributor.

    ImageTemplateVmProfileResponse

    OsDiskSizeGB int
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    VmSize string
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    VnetConfig Pulumi.AzureNative.VirtualMachineImages.Inputs.VirtualNetworkConfigResponse
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.
    OsDiskSizeGB int
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    VmSize string
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    VnetConfig VirtualNetworkConfigResponse
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.
    osDiskSizeGB Integer
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    vmSize String
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    vnetConfig VirtualNetworkConfigResponse
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.
    osDiskSizeGB number
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    vmSize string
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    vnetConfig VirtualNetworkConfigResponse
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.
    os_disk_size_gb int
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    vm_size str
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    vnet_config VirtualNetworkConfigResponse
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.
    osDiskSizeGB Number
    Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
    vmSize String
    Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
    vnetConfig Property Map
    Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used.

    ImageTemplateWindowsUpdateCustomizerResponse

    Filters List<string>
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    Name string
    Friendly Name to provide context on what this customization step does
    SearchCriteria string
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    UpdateLimit int
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)
    Filters []string
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    Name string
    Friendly Name to provide context on what this customization step does
    SearchCriteria string
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    UpdateLimit int
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)
    filters List<String>
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    name String
    Friendly Name to provide context on what this customization step does
    searchCriteria String
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    updateLimit Integer
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)
    filters string[]
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    name string
    Friendly Name to provide context on what this customization step does
    searchCriteria string
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    updateLimit number
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)
    filters Sequence[str]
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    name str
    Friendly Name to provide context on what this customization step does
    search_criteria str
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    update_limit int
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)
    filters List<String>
    Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.
    name String
    Friendly Name to provide context on what this customization step does
    searchCriteria String
    Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field.
    updateLimit Number
    Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)

    PlatformImagePurchasePlanResponse

    PlanName string
    Name of the purchase plan.
    PlanProduct string
    Product of the purchase plan.
    PlanPublisher string
    Publisher of the purchase plan.
    PlanName string
    Name of the purchase plan.
    PlanProduct string
    Product of the purchase plan.
    PlanPublisher string
    Publisher of the purchase plan.
    planName String
    Name of the purchase plan.
    planProduct String
    Product of the purchase plan.
    planPublisher String
    Publisher of the purchase plan.
    planName string
    Name of the purchase plan.
    planProduct string
    Product of the purchase plan.
    planPublisher string
    Publisher of the purchase plan.
    plan_name str
    Name of the purchase plan.
    plan_product str
    Product of the purchase plan.
    plan_publisher str
    Publisher of the purchase plan.
    planName String
    Name of the purchase plan.
    planProduct String
    Product of the purchase plan.
    planPublisher String
    Publisher of the purchase plan.

    ProvisioningErrorResponse

    Message string
    Verbose error message about the provisioning failure
    ProvisioningErrorCode string
    Error code of the provisioning failure
    Message string
    Verbose error message about the provisioning failure
    ProvisioningErrorCode string
    Error code of the provisioning failure
    message String
    Verbose error message about the provisioning failure
    provisioningErrorCode String
    Error code of the provisioning failure
    message string
    Verbose error message about the provisioning failure
    provisioningErrorCode string
    Error code of the provisioning failure
    message str
    Verbose error message about the provisioning failure
    provisioning_error_code str
    Error code of the provisioning failure
    message String
    Verbose error message about the provisioning failure
    provisioningErrorCode String
    Error code of the provisioning failure

    VirtualNetworkConfigResponse

    SubnetId string
    Resource id of a pre-existing subnet.
    SubnetId string
    Resource id of a pre-existing subnet.
    subnetId String
    Resource id of a pre-existing subnet.
    subnetId string
    Resource id of a pre-existing subnet.
    subnet_id str
    Resource id of a pre-existing subnet.
    subnetId String
    Resource id of a pre-existing subnet.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native