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

azure-native.azuresphere.Image

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

An image resource belonging to a catalog resource.

Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.

Other available API versions: 2022-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azuresphere [ApiVersion]. See the version guide for details.

Example Usage

Image_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var image = new AzureNative.AzureSphere.Image("image", new()
    {
        CatalogName = "MyCatalog1",
        Image = "bXliYXNlNjRzdHJpbmc=",
        ImageName = "00000000-0000-0000-0000-000000000000",
        ResourceGroupName = "MyResourceGroup1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuresphere.NewImage(ctx, "image", &azuresphere.ImageArgs{
			CatalogName:       pulumi.String("MyCatalog1"),
			Image:             pulumi.String("bXliYXNlNjRzdHJpbmc="),
			ImageName:         pulumi.String("00000000-0000-0000-0000-000000000000"),
			ResourceGroupName: pulumi.String("MyResourceGroup1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azuresphere.Image;
import com.pulumi.azurenative.azuresphere.ImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var image = new Image("image", ImageArgs.builder()
            .catalogName("MyCatalog1")
            .image("bXliYXNlNjRzdHJpbmc=")
            .imageName("00000000-0000-0000-0000-000000000000")
            .resourceGroupName("MyResourceGroup1")
            .build());

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

const image = new azure_native.azuresphere.Image("image", {
    catalogName: "MyCatalog1",
    image: "bXliYXNlNjRzdHJpbmc=",
    imageName: "00000000-0000-0000-0000-000000000000",
    resourceGroupName: "MyResourceGroup1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

image = azure_native.azuresphere.Image("image",
    catalog_name="MyCatalog1",
    image="bXliYXNlNjRzdHJpbmc=",
    image_name="00000000-0000-0000-0000-000000000000",
    resource_group_name="MyResourceGroup1")
Copy
resources:
  image:
    type: azure-native:azuresphere:Image
    properties:
      catalogName: MyCatalog1
      image: bXliYXNlNjRzdHJpbmc=
      imageName: 00000000-0000-0000-0000-000000000000
      resourceGroupName: MyResourceGroup1
Copy

Create Image Resource

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

Constructor syntax

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

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          catalog_name: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          image: Optional[str] = None,
          image_id: Optional[str] = None,
          image_name: Optional[str] = None,
          regional_data_boundary: Optional[Union[str, RegionalDataBoundary]] = None)
func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

type: azure-native:azuresphere:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ImageInitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ImageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var imageResource = new AzureNative.AzureSphere.Image("imageResource", new()
{
    CatalogName = "string",
    ResourceGroupName = "string",
    Image = "string",
    ImageId = "string",
    ImageName = "string",
    RegionalDataBoundary = "string",
});
Copy
example, err := azuresphere.NewImage(ctx, "imageResource", &azuresphere.ImageArgs{
	CatalogName:          pulumi.String("string"),
	ResourceGroupName:    pulumi.String("string"),
	Image:                pulumi.String("string"),
	ImageId:              pulumi.String("string"),
	ImageName:            pulumi.String("string"),
	RegionalDataBoundary: pulumi.String("string"),
})
Copy
var imageResource = new Image("imageResource", ImageArgs.builder()
    .catalogName("string")
    .resourceGroupName("string")
    .image("string")
    .imageId("string")
    .imageName("string")
    .regionalDataBoundary("string")
    .build());
Copy
image_resource = azure_native.azuresphere.Image("imageResource",
    catalog_name="string",
    resource_group_name="string",
    image="string",
    image_id="string",
    image_name="string",
    regional_data_boundary="string")
Copy
const imageResource = new azure_native.azuresphere.Image("imageResource", {
    catalogName: "string",
    resourceGroupName: "string",
    image: "string",
    imageId: "string",
    imageName: "string",
    regionalDataBoundary: "string",
});
Copy
type: azure-native:azuresphere:Image
properties:
    catalogName: string
    image: string
    imageId: string
    imageName: string
    regionalDataBoundary: string
    resourceGroupName: string
Copy

Image Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Image resource accepts the following input properties:

CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Image Changes to this property will trigger replacement. string
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
ImageId Changes to this property will trigger replacement. string
Image ID
ImageName Changes to this property will trigger replacement. string
Image name. Use an image GUID for GA versions of the API.
RegionalDataBoundary Changes to this property will trigger replacement. string | Pulumi.AzureNative.AzureSphere.RegionalDataBoundary
Regional data boundary for an image
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Image Changes to this property will trigger replacement. string
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
ImageId Changes to this property will trigger replacement. string
Image ID
ImageName Changes to this property will trigger replacement. string
Image name. Use an image GUID for GA versions of the API.
RegionalDataBoundary Changes to this property will trigger replacement. string | RegionalDataBoundary
Regional data boundary for an image
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
image Changes to this property will trigger replacement. String
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
imageId Changes to this property will trigger replacement. String
Image ID
imageName Changes to this property will trigger replacement. String
Image name. Use an image GUID for GA versions of the API.
regionalDataBoundary Changes to this property will trigger replacement. String | RegionalDataBoundary
Regional data boundary for an image
catalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
image Changes to this property will trigger replacement. string
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
imageId Changes to this property will trigger replacement. string
Image ID
imageName Changes to this property will trigger replacement. string
Image name. Use an image GUID for GA versions of the API.
regionalDataBoundary Changes to this property will trigger replacement. string | RegionalDataBoundary
Regional data boundary for an image
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
Name of catalog
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.
image Changes to this property will trigger replacement. str
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
image_id Changes to this property will trigger replacement. str
Image ID
image_name Changes to this property will trigger replacement. str
Image name. Use an image GUID for GA versions of the API.
regional_data_boundary Changes to this property will trigger replacement. str | RegionalDataBoundary
Regional data boundary for an image
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
image Changes to this property will trigger replacement. String
Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
imageId Changes to this property will trigger replacement. String
Image ID
imageName Changes to this property will trigger replacement. String
Image name. Use an image GUID for GA versions of the API.
regionalDataBoundary Changes to this property will trigger replacement. String | "None" | "EU"
Regional data boundary for an image

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
ComponentId string
The image component id.
Description string
The image description.
Id string
The provider-assigned unique ID for this managed resource.
ImageType string
The image type.
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
SystemData Pulumi.AzureNative.AzureSphere.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"
Uri string
Location the image
AzureApiVersion string
The Azure API version of the resource.
ComponentId string
The image component id.
Description string
The image description.
Id string
The provider-assigned unique ID for this managed resource.
ImageType string
The image type.
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
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"
Uri string
Location the image
azureApiVersion String
The Azure API version of the resource.
componentId String
The image component id.
description String
The image description.
id String
The provider-assigned unique ID for this managed resource.
imageType String
The image type.
name String
The name of the resource
provisioningState String
The status of the last operation.
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"
uri String
Location the image
azureApiVersion string
The Azure API version of the resource.
componentId string
The image component id.
description string
The image description.
id string
The provider-assigned unique ID for this managed resource.
imageType string
The image type.
name string
The name of the resource
provisioningState string
The status of the last operation.
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"
uri string
Location the image
azure_api_version str
The Azure API version of the resource.
component_id str
The image component id.
description str
The image description.
id str
The provider-assigned unique ID for this managed resource.
image_type str
The image type.
name str
The name of the resource
provisioning_state str
The status of the last operation.
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"
uri str
Location the image
azureApiVersion String
The Azure API version of the resource.
componentId String
The image component id.
description String
The image description.
id String
The provider-assigned unique ID for this managed resource.
imageType String
The image type.
name String
The name of the resource
provisioningState String
The status of the last operation.
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"
uri String
Location the image

Supporting Types

RegionalDataBoundary
, RegionalDataBoundaryArgs

None
NoneNo data boundary
EU
EUEU data boundary
RegionalDataBoundaryNone
NoneNo data boundary
RegionalDataBoundaryEU
EUEU data boundary
None
NoneNo data boundary
EU
EUEU data boundary
None
NoneNo data boundary
EU
EUEU data boundary
NONE
NoneNo data boundary
EU
EUEU data boundary
"None"
NoneNo data boundary
"EU"
EUEU data boundary

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The 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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:azuresphere:Image MyProduct1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
Copy

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

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