@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Image extends pulumi.CustomResource {
/**
* Get an existing Image resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Image;
/**
* Returns true if the given object is an instance of Image. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Image;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The image component id.
*/
readonly componentId: pulumi.Output<string>;
/**
* The image description.
*/
readonly description: pulumi.Output<string>;
/**
* Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
*/
readonly image: pulumi.Output<string | undefined>;
/**
* Image ID
*/
readonly imageId: pulumi.Output<string | undefined>;
/**
* Image name
*/
readonly imageName: pulumi.Output<string>;
/**
* The image type.
*/
readonly imageType: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The status of the last operation.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Regional data boundary for an image
*/
readonly regionalDataBoundary: pulumi.Output<string | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.azuresphere.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Location the image
*/
readonly uri: pulumi.Output<string>;
/**
* Create a Image resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ImageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Image resource.
*/
export interface ImageArgs {
/**
* Name of catalog
*/
catalogName: pulumi.Input<string>;
/**
* Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
*/
image?: pulumi.Input<string>;
/**
* Image ID
*/
imageId?: pulumi.Input<string>;
/**
* Image name. Use an image GUID for GA versions of the API.
*/
imageName?: pulumi.Input<string>;
/**
* Regional data boundary for an image
*/
regionalDataBoundary?: pulumi.Input<string | enums.azuresphere.RegionalDataBoundary>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}