1. Packages
  2. Packages
  3. Gcorelabs Provider
  4. API Docs
  5. getImage
Viewing docs for gcorelabs 0.3.63
published on Monday, Apr 14, 2025 by g-core
Viewing docs for gcorelabs 0.3.63
published on Monday, Apr 14, 2025 by g-core

    Represent image data

    Using getImage

    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 getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
    function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
    def get_image(id: Optional[str] = None,
                  is_baremetal: Optional[bool] = None,
                  metadata_k: Optional[str] = None,
                  metadata_kv: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  project_id: Optional[float] = None,
                  project_name: Optional[str] = None,
                  region_id: Optional[float] = None,
                  region_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetImageResult
    def get_image_output(id: pulumi.Input[Optional[str]] = None,
                  is_baremetal: pulumi.Input[Optional[bool]] = None,
                  metadata_k: pulumi.Input[Optional[str]] = None,
                  metadata_kv: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  project_id: pulumi.Input[Optional[float]] = None,
                  project_name: pulumi.Input[Optional[str]] = None,
                  region_id: pulumi.Input[Optional[float]] = None,
                  region_name: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
    func GetImage(ctx *Context, args *GetImageArgs, opts ...InvokeOption) (*GetImageResult, error)
    func GetImageOutput(ctx *Context, args *GetImageOutputArgs, opts ...InvokeOption) GetImageResultOutput

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

    public static class GetImage 
    {
        public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
        public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
    public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcorelabs:index/getImage:getImage
      arguments:
        # arguments dictionary
    data "gcorelabs_getimage" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    use 'os-version', for example 'ubuntu-20.04'
    Id string
    The ID of this resource.
    IsBaremetal bool
    set to true if need to get baremetal image
    MetadataK string
    MetadataKv Dictionary<string, string>
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Name string
    use 'os-version', for example 'ubuntu-20.04'
    Id string
    The ID of this resource.
    IsBaremetal bool
    set to true if need to get baremetal image
    MetadataK string
    MetadataKv map[string]string
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    name string
    use 'os-version', for example 'ubuntu-20.04'
    id string
    The ID of this resource.
    is_baremetal bool
    set to true if need to get baremetal image
    metadata_k string
    metadata_kv map(string)
    project_id number
    project_name string
    region_id number
    region_name string
    name String
    use 'os-version', for example 'ubuntu-20.04'
    id String
    The ID of this resource.
    isBaremetal Boolean
    set to true if need to get baremetal image
    metadataK String
    metadataKv Map<String,String>
    projectId Double
    projectName String
    regionId Double
    regionName String
    name string
    use 'os-version', for example 'ubuntu-20.04'
    id string
    The ID of this resource.
    isBaremetal boolean
    set to true if need to get baremetal image
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    name str
    use 'os-version', for example 'ubuntu-20.04'
    id str
    The ID of this resource.
    is_baremetal bool
    set to true if need to get baremetal image
    metadata_k str
    metadata_kv Mapping[str, str]
    project_id float
    project_name str
    region_id float
    region_name str
    name String
    use 'os-version', for example 'ubuntu-20.04'
    id String
    The ID of this resource.
    isBaremetal Boolean
    set to true if need to get baremetal image
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    getImage Result

    The following output properties are available:

    Description string
    Id string
    The ID of this resource.
    MetadataReadOnlies List<GetImageMetadataReadOnly>
    MinDisk double
    MinRam double
    Name string
    use 'os-version', for example 'ubuntu-20.04'
    OsDistro string
    OsVersion string
    IsBaremetal bool
    set to true if need to get baremetal image
    MetadataK string
    MetadataKv Dictionary<string, string>
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Description string
    Id string
    The ID of this resource.
    MetadataReadOnlies []GetImageMetadataReadOnly
    MinDisk float64
    MinRam float64
    Name string
    use 'os-version', for example 'ubuntu-20.04'
    OsDistro string
    OsVersion string
    IsBaremetal bool
    set to true if need to get baremetal image
    MetadataK string
    MetadataKv map[string]string
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    description string
    id string
    The ID of this resource.
    metadata_read_onlies list(object)
    min_disk number
    min_ram number
    name string
    use 'os-version', for example 'ubuntu-20.04'
    os_distro string
    os_version string
    is_baremetal bool
    set to true if need to get baremetal image
    metadata_k string
    metadata_kv map(string)
    project_id number
    project_name string
    region_id number
    region_name string
    description String
    id String
    The ID of this resource.
    metadataReadOnlies List<GetImageMetadataReadOnly>
    minDisk Double
    minRam Double
    name String
    use 'os-version', for example 'ubuntu-20.04'
    osDistro String
    osVersion String
    isBaremetal Boolean
    set to true if need to get baremetal image
    metadataK String
    metadataKv Map<String,String>
    projectId Double
    projectName String
    regionId Double
    regionName String
    description string
    id string
    The ID of this resource.
    metadataReadOnlies GetImageMetadataReadOnly[]
    minDisk number
    minRam number
    name string
    use 'os-version', for example 'ubuntu-20.04'
    osDistro string
    osVersion string
    isBaremetal boolean
    set to true if need to get baremetal image
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    description str
    id str
    The ID of this resource.
    metadata_read_onlies Sequence[GetImageMetadataReadOnly]
    min_disk float
    min_ram float
    name str
    use 'os-version', for example 'ubuntu-20.04'
    os_distro str
    os_version str
    is_baremetal bool
    set to true if need to get baremetal image
    metadata_k str
    metadata_kv Mapping[str, str]
    project_id float
    project_name str
    region_id float
    region_name str
    description String
    id String
    The ID of this resource.
    metadataReadOnlies List<Property Map>
    minDisk Number
    minRam Number
    name String
    use 'os-version', for example 'ubuntu-20.04'
    osDistro String
    osVersion String
    isBaremetal Boolean
    set to true if need to get baremetal image
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    Supporting Types

    GetImageMetadataReadOnly

    Key string
    ReadOnly bool
    Value string
    Key string
    ReadOnly bool
    Value string
    key string
    read_only bool
    value string
    key String
    readOnly Boolean
    value String
    key string
    readOnly boolean
    value string
    key str
    read_only bool
    value str
    key String
    readOnly Boolean
    value String

    Package Details

    Repository
    gcorelabs g-core/terraform-provider-gcorelabs
    License
    Notes
    This Pulumi package is based on the gcorelabs Terraform Provider.
    Viewing docs for gcorelabs 0.3.63
    published on Monday, Apr 14, 2025 by g-core
      Try Pulumi Cloud free. Your team will thank you.