1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsReservation
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsReservation

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Using getIsReservation

    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 getIsReservation(args: GetIsReservationArgs, opts?: InvokeOptions): Promise<GetIsReservationResult>
    function getIsReservationOutput(args: GetIsReservationOutputArgs, opts?: InvokeOptions): Output<GetIsReservationResult>
    def get_is_reservation(capacities: Optional[Sequence[GetIsReservationCapacity]] = None,
                           committed_uses: Optional[Sequence[GetIsReservationCommittedUse]] = None,
                           identifier: Optional[str] = None,
                           name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetIsReservationResult
    def get_is_reservation_output(capacities: Optional[pulumi.Input[Sequence[pulumi.Input[GetIsReservationCapacityArgs]]]] = None,
                           committed_uses: Optional[pulumi.Input[Sequence[pulumi.Input[GetIsReservationCommittedUseArgs]]]] = None,
                           identifier: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetIsReservationResult]
    func LookupIsReservation(ctx *Context, args *LookupIsReservationArgs, opts ...InvokeOption) (*LookupIsReservationResult, error)
    func LookupIsReservationOutput(ctx *Context, args *LookupIsReservationOutputArgs, opts ...InvokeOption) LookupIsReservationResultOutput

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

    public static class GetIsReservation 
    {
        public static Task<GetIsReservationResult> InvokeAsync(GetIsReservationArgs args, InvokeOptions? opts = null)
        public static Output<GetIsReservationResult> Invoke(GetIsReservationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsReservationResult> getIsReservation(GetIsReservationArgs args, InvokeOptions options)
    public static Output<GetIsReservationResult> getIsReservation(GetIsReservationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsReservation:getIsReservation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Capacities List<GetIsReservationCapacity>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    CommittedUses List<GetIsReservationCommittedUse>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    Identifier string
    The ID of the reservation,name and identifier are mutually exclusive.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    Capacities []GetIsReservationCapacity
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    CommittedUses []GetIsReservationCommittedUse
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    Identifier string
    The ID of the reservation,name and identifier are mutually exclusive.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    capacities List<GetIsReservationCapacity>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses List<GetIsReservationCommittedUse>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier String
    The ID of the reservation,name and identifier are mutually exclusive.
    name String
    The name of the reservation,name and identifier are mutually exclusive.
    capacities GetIsReservationCapacity[]
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses GetIsReservationCommittedUse[]
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier string
    The ID of the reservation,name and identifier are mutually exclusive.
    name string
    The name of the reservation,name and identifier are mutually exclusive.
    capacities Sequence[GetIsReservationCapacity]
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committed_uses Sequence[GetIsReservationCommittedUse]
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier str
    The ID of the reservation,name and identifier are mutually exclusive.
    name str
    The name of the reservation,name and identifier are mutually exclusive.
    capacities List<Property Map>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses List<Property Map>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier String
    The ID of the reservation,name and identifier are mutually exclusive.
    name String
    The name of the reservation,name and identifier are mutually exclusive.

    getIsReservation Result

    The following output properties are available:

    AffinityPolicy string
    (String) The affinity policy to use for this reservation.
    CreatedAt string
    (Timestamp) The date and time that the reservation was created.
    Crn string
    (String) The CRN for this reservation.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this reservation.
    Name string
    (String) The name for this resource group.
    Profiles List<GetIsReservationProfile>
    (List) The virtual server instance profile this reservation.
    ResourceGroups List<GetIsReservationResourceGroup>
    (List) The resource group for this reservation.
    ResourceType string
    (String) The resource type.
    Status string
    (String) The status of the reservation.
    StatusReasons List<GetIsReservationStatusReason>
    (List) The reasons for the current status (if any).
    Zone string
    (String) The globally unique name for this zone.
    Capacities List<GetIsReservationCapacity>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    CommittedUses List<GetIsReservationCommittedUse>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    Identifier string
    AffinityPolicy string
    (String) The affinity policy to use for this reservation.
    CreatedAt string
    (Timestamp) The date and time that the reservation was created.
    Crn string
    (String) The CRN for this reservation.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this reservation.
    Name string
    (String) The name for this resource group.
    Profiles []GetIsReservationProfile
    (List) The virtual server instance profile this reservation.
    ResourceGroups []GetIsReservationResourceGroup
    (List) The resource group for this reservation.
    ResourceType string
    (String) The resource type.
    Status string
    (String) The status of the reservation.
    StatusReasons []GetIsReservationStatusReason
    (List) The reasons for the current status (if any).
    Zone string
    (String) The globally unique name for this zone.
    Capacities []GetIsReservationCapacity
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    CommittedUses []GetIsReservationCommittedUse
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    Identifier string
    affinityPolicy String
    (String) The affinity policy to use for this reservation.
    createdAt String
    (Timestamp) The date and time that the reservation was created.
    crn String
    (String) The CRN for this reservation.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this reservation.
    name String
    (String) The name for this resource group.
    profiles List<GetIsReservationProfile>
    (List) The virtual server instance profile this reservation.
    resourceGroups List<GetIsReservationResourceGroup>
    (List) The resource group for this reservation.
    resourceType String
    (String) The resource type.
    status String
    (String) The status of the reservation.
    statusReasons List<GetIsReservationStatusReason>
    (List) The reasons for the current status (if any).
    zone String
    (String) The globally unique name for this zone.
    capacities List<GetIsReservationCapacity>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses List<GetIsReservationCommittedUse>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier String
    affinityPolicy string
    (String) The affinity policy to use for this reservation.
    createdAt string
    (Timestamp) The date and time that the reservation was created.
    crn string
    (String) The CRN for this reservation.
    href string
    (String) The URL for this resource group.
    id string
    (String) The unique identifier for this resource group.
    lifecycleState string
    (String) The lifecycle state of this reservation.
    name string
    (String) The name for this resource group.
    profiles GetIsReservationProfile[]
    (List) The virtual server instance profile this reservation.
    resourceGroups GetIsReservationResourceGroup[]
    (List) The resource group for this reservation.
    resourceType string
    (String) The resource type.
    status string
    (String) The status of the reservation.
    statusReasons GetIsReservationStatusReason[]
    (List) The reasons for the current status (if any).
    zone string
    (String) The globally unique name for this zone.
    capacities GetIsReservationCapacity[]
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses GetIsReservationCommittedUse[]
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier string
    affinity_policy str
    (String) The affinity policy to use for this reservation.
    created_at str
    (Timestamp) The date and time that the reservation was created.
    crn str
    (String) The CRN for this reservation.
    href str
    (String) The URL for this resource group.
    id str
    (String) The unique identifier for this resource group.
    lifecycle_state str
    (String) The lifecycle state of this reservation.
    name str
    (String) The name for this resource group.
    profiles Sequence[GetIsReservationProfile]
    (List) The virtual server instance profile this reservation.
    resource_groups Sequence[GetIsReservationResourceGroup]
    (List) The resource group for this reservation.
    resource_type str
    (String) The resource type.
    status str
    (String) The status of the reservation.
    status_reasons Sequence[GetIsReservationStatusReason]
    (List) The reasons for the current status (if any).
    zone str
    (String) The globally unique name for this zone.
    capacities Sequence[GetIsReservationCapacity]
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committed_uses Sequence[GetIsReservationCommittedUse]
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier str
    affinityPolicy String
    (String) The affinity policy to use for this reservation.
    createdAt String
    (Timestamp) The date and time that the reservation was created.
    crn String
    (String) The CRN for this reservation.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this reservation.
    name String
    (String) The name for this resource group.
    profiles List<Property Map>
    (List) The virtual server instance profile this reservation.
    resourceGroups List<Property Map>
    (List) The resource group for this reservation.
    resourceType String
    (String) The resource type.
    status String
    (String) The status of the reservation.
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any).
    zone String
    (String) The globally unique name for this zone.
    capacities List<Property Map>
    (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
    committedUses List<Property Map>
    (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
    identifier String

    Supporting Types

    GetIsReservationCapacity

    Allocated double
    (Integer) The amount allocated to this capacity reservation.
    Available double
    (Integer) The amount of this capacity reservation available for new attachments.
    Status string
    (String) The status of the reservation.
    Total double
    (Integer) The total amount of this capacity reservation.
    Used double
    (Integer) The amount of this capacity reservation used by existing attachments.
    Allocated float64
    (Integer) The amount allocated to this capacity reservation.
    Available float64
    (Integer) The amount of this capacity reservation available for new attachments.
    Status string
    (String) The status of the reservation.
    Total float64
    (Integer) The total amount of this capacity reservation.
    Used float64
    (Integer) The amount of this capacity reservation used by existing attachments.
    allocated Double
    (Integer) The amount allocated to this capacity reservation.
    available Double
    (Integer) The amount of this capacity reservation available for new attachments.
    status String
    (String) The status of the reservation.
    total Double
    (Integer) The total amount of this capacity reservation.
    used Double
    (Integer) The amount of this capacity reservation used by existing attachments.
    allocated number
    (Integer) The amount allocated to this capacity reservation.
    available number
    (Integer) The amount of this capacity reservation available for new attachments.
    status string
    (String) The status of the reservation.
    total number
    (Integer) The total amount of this capacity reservation.
    used number
    (Integer) The amount of this capacity reservation used by existing attachments.
    allocated float
    (Integer) The amount allocated to this capacity reservation.
    available float
    (Integer) The amount of this capacity reservation available for new attachments.
    status str
    (String) The status of the reservation.
    total float
    (Integer) The total amount of this capacity reservation.
    used float
    (Integer) The amount of this capacity reservation used by existing attachments.
    allocated Number
    (Integer) The amount allocated to this capacity reservation.
    available Number
    (Integer) The amount of this capacity reservation available for new attachments.
    status String
    (String) The status of the reservation.
    total Number
    (Integer) The total amount of this capacity reservation.
    used Number
    (Integer) The amount of this capacity reservation used by existing attachments.

    GetIsReservationCommittedUse

    ExpirationAt string
    (Timestamp) The expiration date and time for this committed use reservation.
    ExpirationPolicy string
    (String) The policy to apply when the committed use term expires.
    Term string
    (String) The term for this committed use reservation.
    ExpirationAt string
    (Timestamp) The expiration date and time for this committed use reservation.
    ExpirationPolicy string
    (String) The policy to apply when the committed use term expires.
    Term string
    (String) The term for this committed use reservation.
    expirationAt String
    (Timestamp) The expiration date and time for this committed use reservation.
    expirationPolicy String
    (String) The policy to apply when the committed use term expires.
    term String
    (String) The term for this committed use reservation.
    expirationAt string
    (Timestamp) The expiration date and time for this committed use reservation.
    expirationPolicy string
    (String) The policy to apply when the committed use term expires.
    term string
    (String) The term for this committed use reservation.
    expiration_at str
    (Timestamp) The expiration date and time for this committed use reservation.
    expiration_policy str
    (String) The policy to apply when the committed use term expires.
    term str
    (String) The term for this committed use reservation.
    expirationAt String
    (Timestamp) The expiration date and time for this committed use reservation.
    expirationPolicy String
    (String) The policy to apply when the committed use term expires.
    term String
    (String) The term for this committed use reservation.

    GetIsReservationProfile

    Href string
    (String) The URL for this resource group.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    ResourceType string
    (String) The resource type.
    Href string
    (String) The URL for this resource group.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    ResourceType string
    (String) The resource type.
    href String
    (String) The URL for this resource group.
    name String
    The name of the reservation,name and identifier are mutually exclusive.
    resourceType String
    (String) The resource type.
    href string
    (String) The URL for this resource group.
    name string
    The name of the reservation,name and identifier are mutually exclusive.
    resourceType string
    (String) The resource type.
    href str
    (String) The URL for this resource group.
    name str
    The name of the reservation,name and identifier are mutually exclusive.
    resource_type str
    (String) The resource type.
    href String
    (String) The URL for this resource group.
    name String
    The name of the reservation,name and identifier are mutually exclusive.
    resourceType String
    (String) The resource type.

    GetIsReservationResourceGroup

    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the reservation,name and identifier are mutually exclusive.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the reservation,name and identifier are mutually exclusive.
    href string
    (String) The URL for this resource group.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name of the reservation,name and identifier are mutually exclusive.
    href str
    (String) The URL for this resource group.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name of the reservation,name and identifier are mutually exclusive.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the reservation,name and identifier are mutually exclusive.

    GetIsReservationStatusReason

    Code string
    (String) A snake case string succinctly identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (string) Link to documentation about this status reason
    Code string
    (String) A snake case string succinctly identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (string) Link to documentation about this status reason
    code String
    (String) A snake case string succinctly identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (string) Link to documentation about this status reason
    code string
    (String) A snake case string succinctly identifying the status reason.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (string) Link to documentation about this status reason
    code str
    (String) A snake case string succinctly identifying the status reason.
    message str
    (String) An explanation of the status reason.
    more_info str
    (string) Link to documentation about this status reason
    code String
    (String) A snake case string succinctly identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (string) Link to documentation about this status reason

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud