ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm.getIsReservation
Start a Neo task
Explain and create an ibm.getIsReservation resource
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 dictionaryThe following arguments are supported:
- Capacities
List<Get
Is Reservation Capacity> - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- Committed
Uses List<GetIs Reservation Committed Use> - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- Identifier string
- The ID of the reservation,
nameandidentifierare mutually exclusive. - Name string
- The name of the reservation,
nameandidentifierare mutually exclusive.
- Capacities
[]Get
Is Reservation Capacity - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- Committed
Uses []GetIs Reservation Committed Use - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- Identifier string
- The ID of the reservation,
nameandidentifierare mutually exclusive. - Name string
- The name of the reservation,
nameandidentifierare mutually exclusive.
- capacities
List<Get
Is Reservation Capacity> - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed
Uses List<GetIs Reservation Committed Use> - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- identifier String
- The ID of the reservation,
nameandidentifierare mutually exclusive. - name String
- The name of the reservation,
nameandidentifierare mutually exclusive.
- capacities
Get
Is Reservation Capacity[] - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed
Uses GetIs Reservation Committed Use[] - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- identifier string
- The ID of the reservation,
nameandidentifierare mutually exclusive. - name string
- The name of the reservation,
nameandidentifierare mutually exclusive.
- capacities
Sequence[Get
Is Reservation Capacity] - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed_
uses Sequence[GetIs Reservation Committed Use] - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- identifier str
- The ID of the reservation,
nameandidentifierare mutually exclusive. - name str
- The name of the reservation,
nameandidentifierare mutually exclusive.
- capacities List<Property Map>
- (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed
Uses 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,
nameandidentifierare mutually exclusive. - name String
- The name of the reservation,
nameandidentifierare mutually exclusive.
getIsReservation Result
The following output properties are available:
- Affinity
Policy string - (String) The affinity policy to use for this reservation.
- Created
At 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.
- Lifecycle
State string - (String) The lifecycle state of this reservation.
- Name string
- (String) The name for this resource group.
- Profiles
List<Get
Is Reservation Profile> - (List) The virtual server instance profile this reservation.
- Resource
Groups List<GetIs Reservation Resource Group> - (List) The resource group for this reservation.
- Resource
Type string - (String) The resource type.
- Status string
- (String) The status of the reservation.
- Status
Reasons List<GetIs Reservation Status Reason> - (List) The reasons for the current status (if any).
- Zone string
- (String) The globally unique name for this zone.
- Capacities
List<Get
Is Reservation Capacity> - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- Committed
Uses List<GetIs Reservation Committed Use> - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- Identifier string
- Affinity
Policy string - (String) The affinity policy to use for this reservation.
- Created
At 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.
- Lifecycle
State string - (String) The lifecycle state of this reservation.
- Name string
- (String) The name for this resource group.
- Profiles
[]Get
Is Reservation Profile - (List) The virtual server instance profile this reservation.
- Resource
Groups []GetIs Reservation Resource Group - (List) The resource group for this reservation.
- Resource
Type string - (String) The resource type.
- Status string
- (String) The status of the reservation.
- Status
Reasons []GetIs Reservation Status Reason - (List) The reasons for the current status (if any).
- Zone string
- (String) The globally unique name for this zone.
- Capacities
[]Get
Is Reservation Capacity - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- Committed
Uses []GetIs Reservation Committed Use - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- Identifier string
- affinity
Policy String - (String) The affinity policy to use for this reservation.
- created
At 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.
- lifecycle
State String - (String) The lifecycle state of this reservation.
- name String
- (String) The name for this resource group.
- profiles
List<Get
Is Reservation Profile> - (List) The virtual server instance profile this reservation.
- resource
Groups List<GetIs Reservation Resource Group> - (List) The resource group for this reservation.
- resource
Type String - (String) The resource type.
- status String
- (String) The status of the reservation.
- status
Reasons List<GetIs Reservation Status Reason> - (List) The reasons for the current status (if any).
- zone String
- (String) The globally unique name for this zone.
- capacities
List<Get
Is Reservation Capacity> - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed
Uses List<GetIs Reservation Committed Use> - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- identifier String
- affinity
Policy string - (String) The affinity policy to use for this reservation.
- created
At 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.
- lifecycle
State string - (String) The lifecycle state of this reservation.
- name string
- (String) The name for this resource group.
- profiles
Get
Is Reservation Profile[] - (List) The virtual server instance profile this reservation.
- resource
Groups GetIs Reservation Resource Group[] - (List) The resource group for this reservation.
- resource
Type string - (String) The resource type.
- status string
- (String) The status of the reservation.
- status
Reasons GetIs Reservation Status Reason[] - (List) The reasons for the current status (if any).
- zone string
- (String) The globally unique name for this zone.
- capacities
Get
Is Reservation Capacity[] - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed
Uses GetIs Reservation Committed Use[] - (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[Get
Is Reservation Profile] - (List) The virtual server instance profile this reservation.
- resource_
groups Sequence[GetIs Reservation Resource Group] - (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[GetIs Reservation Status Reason] - (List) The reasons for the current status (if any).
- zone str
- (String) The globally unique name for this zone.
- capacities
Sequence[Get
Is Reservation Capacity] - (List) The capacity configuration for this reservation. If absent, this reservation has no assigned capacity.
- committed_
uses Sequence[GetIs Reservation Committed Use] - (List) The committed use configuration for this reservation. If absent, this reservation has no commitment for use.
- identifier str
- affinity
Policy String - (String) The affinity policy to use for this reservation.
- created
At 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.
- lifecycle
State 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.
- resource
Groups List<Property Map> - (List) The resource group for this reservation.
- resource
Type String - (String) The resource type.
- status String
- (String) The status of the reservation.
- status
Reasons 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.
- committed
Uses 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
- Expiration
At string - (Timestamp) The expiration date and time for this committed use reservation.
- Expiration
Policy string - (String) The policy to apply when the committed use term expires.
- Term string
- (String) The term for this committed use reservation.
- Expiration
At string - (Timestamp) The expiration date and time for this committed use reservation.
- Expiration
Policy string - (String) The policy to apply when the committed use term expires.
- Term string
- (String) The term for this committed use reservation.
- expiration
At String - (Timestamp) The expiration date and time for this committed use reservation.
- expiration
Policy String - (String) The policy to apply when the committed use term expires.
- term String
- (String) The term for this committed use reservation.
- expiration
At string - (Timestamp) The expiration date and time for this committed use reservation.
- expiration
Policy 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.
- expiration
At String - (Timestamp) The expiration date and time for this committed use reservation.
- expiration
Policy 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,
nameandidentifierare mutually exclusive. - Resource
Type string - (String) The resource type.
- Href string
- (String) The URL for this resource group.
- Name string
- The name of the reservation,
nameandidentifierare mutually exclusive. - Resource
Type string - (String) The resource type.
- href String
- (String) The URL for this resource group.
- name String
- The name of the reservation,
nameandidentifierare mutually exclusive. - resource
Type String - (String) The resource type.
- href string
- (String) The URL for this resource group.
- name string
- The name of the reservation,
nameandidentifierare mutually exclusive. - resource
Type string - (String) The resource type.
- href str
- (String) The URL for this resource group.
- name str
- The name of the reservation,
nameandidentifierare 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,
nameandidentifierare mutually exclusive. - resource
Type String - (String) The resource type.
GetIsReservationResourceGroup
GetIsReservationStatusReason
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.
