1. Packages
  2. Civo
  3. API Docs
  4. getDiskImage
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

civo.getDiskImage

Explore with Pulumi AI

civo logo
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

    Get information on an disk image for use in other resources (e.g. creating a instance) with the ability to filter the results.

    Using getDiskImage

    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 getDiskImage(args: GetDiskImageArgs, opts?: InvokeOptions): Promise<GetDiskImageResult>
    function getDiskImageOutput(args: GetDiskImageOutputArgs, opts?: InvokeOptions): Output<GetDiskImageResult>
    def get_disk_image(filters: Optional[Sequence[GetDiskImageFilter]] = None,
                       region: Optional[str] = None,
                       sorts: Optional[Sequence[GetDiskImageSort]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDiskImageResult
    def get_disk_image_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDiskImageFilterArgs]]]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetDiskImageSortArgs]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDiskImageResult]
    func GetDiskImage(ctx *Context, args *GetDiskImageArgs, opts ...InvokeOption) (*GetDiskImageResult, error)
    func GetDiskImageOutput(ctx *Context, args *GetDiskImageOutputArgs, opts ...InvokeOption) GetDiskImageResultOutput

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

    public static class GetDiskImage 
    {
        public static Task<GetDiskImageResult> InvokeAsync(GetDiskImageArgs args, InvokeOptions? opts = null)
        public static Output<GetDiskImageResult> Invoke(GetDiskImageInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDiskImageResult> getDiskImage(GetDiskImageArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: civo:index/getDiskImage:getDiskImage
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<GetDiskImageFilter>
    One or more key/value pairs on which to filter results
    Region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    Sorts List<GetDiskImageSort>
    One or more key/direction pairs on which to sort results
    Filters []GetDiskImageFilter
    One or more key/value pairs on which to filter results
    Region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    Sorts []GetDiskImageSort
    One or more key/direction pairs on which to sort results
    filters List<GetDiskImageFilter>
    One or more key/value pairs on which to filter results
    region String
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts List<GetDiskImageSort>
    One or more key/direction pairs on which to sort results
    filters GetDiskImageFilter[]
    One or more key/value pairs on which to filter results
    region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts GetDiskImageSort[]
    One or more key/direction pairs on which to sort results
    filters Sequence[GetDiskImageFilter]
    One or more key/value pairs on which to filter results
    region str
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts Sequence[GetDiskImageSort]
    One or more key/direction pairs on which to sort results
    filters List<Property Map>
    One or more key/value pairs on which to filter results
    region String
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts List<Property Map>
    One or more key/direction pairs on which to sort results

    getDiskImage Result

    The following output properties are available:

    Diskimages List<GetDiskImageDiskimage>
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetDiskImageFilter>
    One or more key/value pairs on which to filter results
    Region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    Sorts List<GetDiskImageSort>
    One or more key/direction pairs on which to sort results
    Diskimages []GetDiskImageDiskimage
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetDiskImageFilter
    One or more key/value pairs on which to filter results
    Region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    Sorts []GetDiskImageSort
    One or more key/direction pairs on which to sort results
    diskimages List<GetDiskImageDiskimage>
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetDiskImageFilter>
    One or more key/value pairs on which to filter results
    region String
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts List<GetDiskImageSort>
    One or more key/direction pairs on which to sort results
    diskimages GetDiskImageDiskimage[]
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetDiskImageFilter[]
    One or more key/value pairs on which to filter results
    region string
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts GetDiskImageSort[]
    One or more key/direction pairs on which to sort results
    diskimages Sequence[GetDiskImageDiskimage]
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetDiskImageFilter]
    One or more key/value pairs on which to filter results
    region str
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts Sequence[GetDiskImageSort]
    One or more key/direction pairs on which to sort results
    diskimages List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>
    One or more key/value pairs on which to filter results
    region String
    If is used, all disk image will be from this region. Required if no region is set in provider.
    sorts List<Property Map>
    One or more key/direction pairs on which to sort results

    Supporting Types

    GetDiskImageDiskimage

    Id string
    Label string
    Name string
    Version string
    Id string
    Label string
    Name string
    Version string
    id String
    label String
    name String
    version String
    id string
    label string
    name string
    version string
    id str
    label str
    name str
    version str
    id String
    label String
    name String
    version String

    GetDiskImageFilter

    Key string
    Filter diskimages by this key. This may be one of id, label, name, version.
    Values List<string>
    Only retrieves diskimages which keys has value that matches one of the values provided here
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    Key string
    Filter diskimages by this key. This may be one of id, label, name, version.
    Values []string
    Only retrieves diskimages which keys has value that matches one of the values provided here
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter diskimages by this key. This may be one of id, label, name, version.
    values List<String>
    Only retrieves diskimages which keys has value that matches one of the values provided here
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter diskimages by this key. This may be one of id, label, name, version.
    values string[]
    Only retrieves diskimages which keys has value that matches one of the values provided here
    all boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key str
    Filter diskimages by this key. This may be one of id, label, name, version.
    values Sequence[str]
    Only retrieves diskimages which keys has value that matches one of the values provided here
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by str
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter diskimages by this key. This may be one of id, label, name, version.
    values List<String>
    Only retrieves diskimages which keys has value that matches one of the values provided here
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

    GetDiskImageSort

    Key string
    Sort diskimages by this key. This may be one of id, label, name, version.
    Direction string
    The sort direction. This may be either asc or desc.
    Key string
    Sort diskimages by this key. This may be one of id, label, name, version.
    Direction string
    The sort direction. This may be either asc or desc.
    key String
    Sort diskimages by this key. This may be one of id, label, name, version.
    direction String
    The sort direction. This may be either asc or desc.
    key string
    Sort diskimages by this key. This may be one of id, label, name, version.
    direction string
    The sort direction. This may be either asc or desc.
    key str
    Sort diskimages by this key. This may be one of id, label, name, version.
    direction str
    The sort direction. This may be either asc or desc.
    key String
    Sort diskimages by this key. This may be one of id, label, name, version.
    direction String
    The sort direction. This may be either asc or desc.

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi