ibm.getIsImage
Explore with Pulumi AI
Retrieve information of an existing IBM Cloud Infrastructure image as a read-only data source. For more information, about VPC custom images, see IBM Cloud Importing and managing custom images.
Note:
VPC infrastructure services are a regional specific based endpoint, by default targets to us-south
. Please make sure to target right region in the provider block as shown in the provider.tf
file, if VPC service is created in region other than us-south
.
provider.tf
import * as pulumi from "@pulumi/pulumi";
import pulumi
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
}
}
{}
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const example = ibm.getIsImage({
name: "ibm-centos-7-9-minimal-amd64-12",
});
import pulumi
import pulumi_ibm as ibm
example = ibm.get_is_image(name="ibm-centos-7-9-minimal-amd64-12")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupIsImage(ctx, &ibm.LookupIsImageArgs{
Name: pulumi.StringRef("ibm-centos-7-9-minimal-amd64-12"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var example = Ibm.GetIsImage.Invoke(new()
{
Name = "ibm-centos-7-9-minimal-amd64-12",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsImageArgs;
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) {
final var example = IbmFunctions.getIsImage(GetIsImageArgs.builder()
.name("ibm-centos-7-9-minimal-amd64-12")
.build());
}
}
variables:
example:
fn::invoke:
function: ibm:getIsImage
arguments:
name: ibm-centos-7-9-minimal-amd64-12
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const example = ibm.getIsImage({
identifier: ibm_is_image.example.id,
});
import pulumi
import pulumi_ibm as ibm
example = ibm.get_is_image(identifier=ibm_is_image["example"]["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupIsImage(ctx, &ibm.LookupIsImageArgs{
Identifier: pulumi.StringRef(ibm_is_image.Example.Id),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var example = Ibm.GetIsImage.Invoke(new()
{
Identifier = ibm_is_image.Example.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsImageArgs;
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) {
final var example = IbmFunctions.getIsImage(GetIsImageArgs.builder()
.identifier(ibm_is_image.example().id())
.build());
}
}
variables:
example:
fn::invoke:
function: ibm:getIsImage
arguments:
identifier: ${ibm_is_image.example.id}
Using getIsImage
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 getIsImage(args: GetIsImageArgs, opts?: InvokeOptions): Promise<GetIsImageResult>
function getIsImageOutput(args: GetIsImageOutputArgs, opts?: InvokeOptions): Output<GetIsImageResult>
def get_is_image(id: Optional[str] = None,
identifier: Optional[str] = None,
name: Optional[str] = None,
visibility: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIsImageResult
def get_is_image_output(id: Optional[pulumi.Input[str]] = None,
identifier: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
visibility: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIsImageResult]
func LookupIsImage(ctx *Context, args *LookupIsImageArgs, opts ...InvokeOption) (*LookupIsImageResult, error)
func LookupIsImageOutput(ctx *Context, args *LookupIsImageOutputArgs, opts ...InvokeOption) LookupIsImageResultOutput
> Note: This function is named LookupIsImage
in the Go SDK.
public static class GetIsImage
{
public static Task<GetIsImageResult> InvokeAsync(GetIsImageArgs args, InvokeOptions? opts = null)
public static Output<GetIsImageResult> Invoke(GetIsImageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIsImageResult> getIsImage(GetIsImageArgs args, InvokeOptions options)
public static Output<GetIsImageResult> getIsImage(GetIsImageArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getIsImage:getIsImage
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- (String) The unique identifier for this resource group.
- Identifier string
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- Name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- Visibility string
- The visibility of the image. Accepted values are
public
orprivate
.
- Id string
- (String) The unique identifier for this resource group.
- Identifier string
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- Name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- Visibility string
- The visibility of the image. Accepted values are
public
orprivate
.
- id String
- (String) The unique identifier for this resource group.
- identifier String
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- name String
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- visibility String
- The visibility of the image. Accepted values are
public
orprivate
.
- id string
- (String) The unique identifier for this resource group.
- identifier string
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- visibility string
- The visibility of the image. Accepted values are
public
orprivate
.
- id str
- (String) The unique identifier for this resource group.
- identifier str
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- name str
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- visibility str
- The visibility of the image. Accepted values are
public
orprivate
.
- id String
- (String) The unique identifier for this resource group.
- identifier String
The id of the image.
Note:
name
andidentifier
are mutually exclusive.- name String
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- visibility String
- The visibility of the image. Accepted values are
public
orprivate
.
getIsImage Result
The following output properties are available:
- List<string>
- (List) Access management tags associated for image.
- Architecture string
- (String) The operating system architecture.
- Catalog
Offerings List<GetIs Image Catalog Offering> - (List) The catalog offering for this image.
- Checksum string
- (String) The
SHA256
checksum of the image. - Created
At string - (String) The date and time that the image was created
- Crn string
- (String) The CRN for this image.
- Deprecation
At string - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- Encryption string
- (String) The type of encryption used of the image.
- Encryption
Key string - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- Id string
- (String) The unique identifier for this resource group.
- Obsolescence
At string - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- Operating
Systems List<GetIs Image Operating System> - (List) The operating system details.
- Os string
- (String) The name of the operating system.
- Resource
Groups List<GetIs Image Resource Group> - (List) The resource group object, for this image.
- Source
Volume string - The source volume id of the image.
- Status string
- (String) The status of this image.
- Status
Reasons List<GetIs Image Status Reason> - (List) The reasons for the current status (if any).
- User
Data stringFormat - (String) The user data format for this image.
- Identifier string
- Name string
- (String) The user-defined name for this resource group.
- Visibility string
- []string
- (List) Access management tags associated for image.
- Architecture string
- (String) The operating system architecture.
- Catalog
Offerings []GetIs Image Catalog Offering - (List) The catalog offering for this image.
- Checksum string
- (String) The
SHA256
checksum of the image. - Created
At string - (String) The date and time that the image was created
- Crn string
- (String) The CRN for this image.
- Deprecation
At string - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- Encryption string
- (String) The type of encryption used of the image.
- Encryption
Key string - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- Id string
- (String) The unique identifier for this resource group.
- Obsolescence
At string - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- Operating
Systems []GetIs Image Operating System - (List) The operating system details.
- Os string
- (String) The name of the operating system.
- Resource
Groups []GetIs Image Resource Group - (List) The resource group object, for this image.
- Source
Volume string - The source volume id of the image.
- Status string
- (String) The status of this image.
- Status
Reasons []GetIs Image Status Reason - (List) The reasons for the current status (if any).
- User
Data stringFormat - (String) The user data format for this image.
- Identifier string
- Name string
- (String) The user-defined name for this resource group.
- Visibility string
- List<String>
- (List) Access management tags associated for image.
- architecture String
- (String) The operating system architecture.
- catalog
Offerings List<GetIs Image Catalog Offering> - (List) The catalog offering for this image.
- checksum String
- (String) The
SHA256
checksum of the image. - created
At String - (String) The date and time that the image was created
- crn String
- (String) The CRN for this image.
- deprecation
At String - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- encryption String
- (String) The type of encryption used of the image.
- encryption
Key String - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- id String
- (String) The unique identifier for this resource group.
- obsolescence
At String - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- operating
Systems List<GetIs Image Operating System> - (List) The operating system details.
- os String
- (String) The name of the operating system.
- resource
Groups List<GetIs Image Resource Group> - (List) The resource group object, for this image.
- source
Volume String - The source volume id of the image.
- status String
- (String) The status of this image.
- status
Reasons List<GetIs Image Status Reason> - (List) The reasons for the current status (if any).
- user
Data StringFormat - (String) The user data format for this image.
- identifier String
- name String
- (String) The user-defined name for this resource group.
- visibility String
- string[]
- (List) Access management tags associated for image.
- architecture string
- (String) The operating system architecture.
- catalog
Offerings GetIs Image Catalog Offering[] - (List) The catalog offering for this image.
- checksum string
- (String) The
SHA256
checksum of the image. - created
At string - (String) The date and time that the image was created
- crn string
- (String) The CRN for this image.
- deprecation
At string - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- encryption string
- (String) The type of encryption used of the image.
- encryption
Key string - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- id string
- (String) The unique identifier for this resource group.
- obsolescence
At string - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- operating
Systems GetIs Image Operating System[] - (List) The operating system details.
- os string
- (String) The name of the operating system.
- resource
Groups GetIs Image Resource Group[] - (List) The resource group object, for this image.
- source
Volume string - The source volume id of the image.
- status string
- (String) The status of this image.
- status
Reasons GetIs Image Status Reason[] - (List) The reasons for the current status (if any).
- user
Data stringFormat - (String) The user data format for this image.
- identifier string
- name string
- (String) The user-defined name for this resource group.
- visibility string
- Sequence[str]
- (List) Access management tags associated for image.
- architecture str
- (String) The operating system architecture.
- catalog_
offerings Sequence[GetIs Image Catalog Offering] - (List) The catalog offering for this image.
- checksum str
- (String) The
SHA256
checksum of the image. - created_
at str - (String) The date and time that the image was created
- crn str
- (String) The CRN for this image.
- deprecation_
at str - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- encryption str
- (String) The type of encryption used of the image.
- encryption_
key str - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- id str
- (String) The unique identifier for this resource group.
- obsolescence_
at str - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- operating_
systems Sequence[GetIs Image Operating System] - (List) The operating system details.
- os str
- (String) The name of the operating system.
- resource_
groups Sequence[GetIs Image Resource Group] - (List) The resource group object, for this image.
- source_
volume str - The source volume id of the image.
- status str
- (String) The status of this image.
- status_
reasons Sequence[GetIs Image Status Reason] - (List) The reasons for the current status (if any).
- user_
data_ strformat - (String) The user data format for this image.
- identifier str
- name str
- (String) The user-defined name for this resource group.
- visibility str
- List<String>
- (List) Access management tags associated for image.
- architecture String
- (String) The operating system architecture.
- catalog
Offerings List<Property Map> - (List) The catalog offering for this image.
- checksum String
- (String) The
SHA256
checksum of the image. - created
At String - (String) The date and time that the image was created
- crn String
- (String) The CRN for this image.
- deprecation
At String - (String) The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
- encryption String
- (String) The type of encryption used of the image.
- encryption
Key String - (String) The CRN of the Key Protect or Hyper Protect Crypto Service root key for this resource.
- id String
- (String) The unique identifier for this resource group.
- obsolescence
At String - (String) The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
- operating
Systems List<Property Map> - (List) The operating system details.
- os String
- (String) The name of the operating system.
- resource
Groups List<Property Map> - (List) The resource group object, for this image.
- source
Volume String - The source volume id of the image.
- status String
- (String) The status of this image.
- status
Reasons List<Property Map> - (List) The reasons for the current status (if any).
- user
Data StringFormat - (String) The user data format for this image.
- identifier String
- name String
- (String) The user-defined name for this resource group.
- visibility String
Supporting Types
GetIsImageCatalogOffering
- Managed bool
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- Versions
List<Get
Is Image Catalog Offering Version> - (String) The major release version of this operating system.
- Managed bool
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- Versions
[]Get
Is Image Catalog Offering Version - (String) The major release version of this operating system.
- managed Boolean
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- versions
List<Get
Is Image Catalog Offering Version> - (String) The major release version of this operating system.
- managed boolean
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- versions
Get
Is Image Catalog Offering Version[] - (String) The major release version of this operating system.
- managed bool
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- versions
Sequence[Get
Is Image Catalog Offering Version] - (String) The major release version of this operating system.
- managed Boolean
- (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
- versions List<Property Map>
- (String) The major release version of this operating system.
GetIsImageCatalogOfferingVersion
- Crn string
- (String) The CRN for this image.
- Crn string
- (String) The CRN for this image.
- crn String
- (String) The CRN for this image.
- crn string
- (String) The CRN for this image.
- crn str
- (String) The CRN for this image.
- crn String
- (String) The CRN for this image.
GetIsImageOperatingSystem
- Allow
User boolImage Creation - (String) Users may create new images with this operating system.
- Architecture string
- (String) The operating system architecture.
- Dedicated
Host boolOnly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- Display
Name string - (String) A unique, display-friendly name for the operating system.
- Family string
- (String) The software family for this operating system.
- Href string
- (String) The URL for this resource group.
- Name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- User
Data stringFormat - (String) The user data format for this image.
- Vendor string
- (String) The vendor of the operating system.
- Version string
- (String) The major release version of this operating system.
- Allow
User boolImage Creation - (String) Users may create new images with this operating system.
- Architecture string
- (String) The operating system architecture.
- Dedicated
Host boolOnly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- Display
Name string - (String) A unique, display-friendly name for the operating system.
- Family string
- (String) The software family for this operating system.
- Href string
- (String) The URL for this resource group.
- Name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- User
Data stringFormat - (String) The user data format for this image.
- Vendor string
- (String) The vendor of the operating system.
- Version string
- (String) The major release version of this operating system.
- allow
User BooleanImage Creation - (String) Users may create new images with this operating system.
- architecture String
- (String) The operating system architecture.
- dedicated
Host BooleanOnly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- display
Name String - (String) A unique, display-friendly name for the operating system.
- family String
- (String) The software family for this operating system.
- href String
- (String) The URL for this resource group.
- name String
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- user
Data StringFormat - (String) The user data format for this image.
- vendor String
- (String) The vendor of the operating system.
- version String
- (String) The major release version of this operating system.
- allow
User booleanImage Creation - (String) Users may create new images with this operating system.
- architecture string
- (String) The operating system architecture.
- dedicated
Host booleanOnly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- display
Name string - (String) A unique, display-friendly name for the operating system.
- family string
- (String) The software family for this operating system.
- href string
- (String) The URL for this resource group.
- name string
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- user
Data stringFormat - (String) The user data format for this image.
- vendor string
- (String) The vendor of the operating system.
- version string
- (String) The major release version of this operating system.
- allow_
user_ boolimage_ creation - (String) Users may create new images with this operating system.
- architecture str
- (String) The operating system architecture.
- dedicated_
host_ boolonly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- display_
name str - (String) A unique, display-friendly name for the operating system.
- family str
- (String) The software family for this operating system.
- href str
- (String) The URL for this resource group.
- name str
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- user_
data_ strformat - (String) The user data format for this image.
- vendor str
- (String) The vendor of the operating system.
- version str
- (String) The major release version of this operating system.
- allow
User BooleanImage Creation - (String) Users may create new images with this operating system.
- architecture String
- (String) The operating system architecture.
- dedicated
Host BooleanOnly - (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
- display
Name String - (String) A unique, display-friendly name for the operating system.
- family String
- (String) The software family for this operating system.
- href String
- (String) The URL for this resource group.
- name String
The name of the image.
Note:
name
andidentifier
are mutually exclusive.- user
Data StringFormat - (String) The user data format for this image.
- vendor String
- (String) The vendor of the operating system.
- version String
- (String) The major release version of this operating system.
GetIsImageResourceGroup
GetIsImageStatusReason
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.