This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.compute.getCapacityReservationGroup
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
The operation that retrieves information about a capacity reservation group. Azure REST API version: 2023-03-01.
Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.
Using getCapacityReservationGroup
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 getCapacityReservationGroup(args: GetCapacityReservationGroupArgs, opts?: InvokeOptions): Promise<GetCapacityReservationGroupResult>
function getCapacityReservationGroupOutput(args: GetCapacityReservationGroupOutputArgs, opts?: InvokeOptions): Output<GetCapacityReservationGroupResult>
def get_capacity_reservation_group(capacity_reservation_group_name: Optional[str] = None,
expand: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCapacityReservationGroupResult
def get_capacity_reservation_group_output(capacity_reservation_group_name: Optional[pulumi.Input[str]] = None,
expand: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCapacityReservationGroupResult]
func LookupCapacityReservationGroup(ctx *Context, args *LookupCapacityReservationGroupArgs, opts ...InvokeOption) (*LookupCapacityReservationGroupResult, error)
func LookupCapacityReservationGroupOutput(ctx *Context, args *LookupCapacityReservationGroupOutputArgs, opts ...InvokeOption) LookupCapacityReservationGroupResultOutput
> Note: This function is named LookupCapacityReservationGroup
in the Go SDK.
public static class GetCapacityReservationGroup
{
public static Task<GetCapacityReservationGroupResult> InvokeAsync(GetCapacityReservationGroupArgs args, InvokeOptions? opts = null)
public static Output<GetCapacityReservationGroupResult> Invoke(GetCapacityReservationGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCapacityReservationGroupResult> getCapacityReservationGroup(GetCapacityReservationGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:compute:getCapacityReservationGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Capacity
Reservation stringGroup Name - The name of the capacity reservation group.
- Resource
Group stringName - The name of the resource group.
- Expand string
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
- Capacity
Reservation stringGroup Name - The name of the capacity reservation group.
- Resource
Group stringName - The name of the resource group.
- Expand string
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
- capacity
Reservation StringGroup Name - The name of the capacity reservation group.
- resource
Group StringName - The name of the resource group.
- expand String
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
- capacity
Reservation stringGroup Name - The name of the capacity reservation group.
- resource
Group stringName - The name of the resource group.
- expand string
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
- capacity_
reservation_ strgroup_ name - The name of the capacity reservation group.
- resource_
group_ strname - The name of the resource group.
- expand str
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
- capacity
Reservation StringGroup Name - The name of the capacity reservation group.
- resource
Group StringName - The name of the resource group.
- expand String
- The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
getCapacityReservationGroup Result
The following output properties are available:
- Capacity
Reservations List<Pulumi.Azure Native. Compute. Outputs. Sub Resource Read Only Response> - A list of all capacity reservation resource ids that belong to capacity reservation group.
- Id string
- Resource Id
- Instance
View Pulumi.Azure Native. Compute. Outputs. Capacity Reservation Group Instance View Response - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- Location string
- Resource location
- Name string
- Resource name
- Type string
- Resource type
- Virtual
Machines List<Pulumi.Associated Azure Native. Compute. Outputs. Sub Resource Read Only Response> - A list of references to all virtual machines associated to the capacity reservation group.
- Dictionary<string, string>
- Resource tags
- Zones List<string>
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
- Capacity
Reservations []SubResource Read Only Response - A list of all capacity reservation resource ids that belong to capacity reservation group.
- Id string
- Resource Id
- Instance
View CapacityReservation Group Instance View Response - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- Location string
- Resource location
- Name string
- Resource name
- Type string
- Resource type
- Virtual
Machines []SubAssociated Resource Read Only Response - A list of references to all virtual machines associated to the capacity reservation group.
- map[string]string
- Resource tags
- Zones []string
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
- capacity
Reservations List<SubResource Read Only Response> - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id String
- Resource Id
- instance
View CapacityReservation Group Instance View Response - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- location String
- Resource location
- name String
- Resource name
- type String
- Resource type
- virtual
Machines List<SubAssociated Resource Read Only Response> - A list of references to all virtual machines associated to the capacity reservation group.
- Map<String,String>
- Resource tags
- zones List<String>
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
- capacity
Reservations SubResource Read Only Response[] - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id string
- Resource Id
- instance
View CapacityReservation Group Instance View Response - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- location string
- Resource location
- name string
- Resource name
- type string
- Resource type
- virtual
Machines SubAssociated Resource Read Only Response[] - A list of references to all virtual machines associated to the capacity reservation group.
- {[key: string]: string}
- Resource tags
- zones string[]
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
- capacity_
reservations Sequence[SubResource Read Only Response] - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id str
- Resource Id
- instance_
view CapacityReservation Group Instance View Response - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- location str
- Resource location
- name str
- Resource name
- type str
- Resource type
- virtual_
machines_ Sequence[Subassociated Resource Read Only Response] - A list of references to all virtual machines associated to the capacity reservation group.
- Mapping[str, str]
- Resource tags
- zones Sequence[str]
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
- capacity
Reservations List<Property Map> - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id String
- Resource Id
- instance
View Property Map - The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
- location String
- Resource location
- name String
- Resource name
- type String
- Resource type
- virtual
Machines List<Property Map>Associated - A list of references to all virtual machines associated to the capacity reservation group.
- Map<String>
- Resource tags
- zones List<String>
- Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
Supporting Types
CapacityReservationGroupInstanceViewResponse
- Capacity
Reservations List<Pulumi.Azure Native. Compute. Inputs. Capacity Reservation Instance View With Name Response> - List of instance view of the capacity reservations under the capacity reservation group.
- Capacity
Reservations []CapacityReservation Instance View With Name Response - List of instance view of the capacity reservations under the capacity reservation group.
- capacity
Reservations List<CapacityReservation Instance View With Name Response> - List of instance view of the capacity reservations under the capacity reservation group.
- capacity
Reservations CapacityReservation Instance View With Name Response[] - List of instance view of the capacity reservations under the capacity reservation group.
- capacity_
reservations Sequence[CapacityReservation Instance View With Name Response] - List of instance view of the capacity reservations under the capacity reservation group.
- capacity
Reservations List<Property Map> - List of instance view of the capacity reservations under the capacity reservation group.
CapacityReservationInstanceViewWithNameResponse
- Name string
- The name of the capacity reservation.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- Utilization
Info Pulumi.Azure Native. Compute. Inputs. Capacity Reservation Utilization Response - Unutilized capacity of the capacity reservation.
- Name string
- The name of the capacity reservation.
- Statuses
[]Instance
View Status Response - The resource status information.
- Utilization
Info CapacityReservation Utilization Response - Unutilized capacity of the capacity reservation.
- name String
- The name of the capacity reservation.
- statuses
List<Instance
View Status Response> - The resource status information.
- utilization
Info CapacityReservation Utilization Response - Unutilized capacity of the capacity reservation.
- name string
- The name of the capacity reservation.
- statuses
Instance
View Status Response[] - The resource status information.
- utilization
Info CapacityReservation Utilization Response - Unutilized capacity of the capacity reservation.
- name str
- The name of the capacity reservation.
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- utilization_
info CapacityReservation Utilization Response - Unutilized capacity of the capacity reservation.
- name String
- The name of the capacity reservation.
- statuses List<Property Map>
- The resource status information.
- utilization
Info Property Map - Unutilized capacity of the capacity reservation.
CapacityReservationUtilizationResponse
- Current
Capacity int - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- Virtual
Machines List<Pulumi.Allocated Azure Native. Compute. Inputs. Sub Resource Read Only Response> - A list of all virtual machines resource ids allocated against the capacity reservation.
- Current
Capacity int - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- Virtual
Machines []SubAllocated Resource Read Only Response - A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity Integer - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- virtual
Machines List<SubAllocated Resource Read Only Response> - A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity number - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- virtual
Machines SubAllocated Resource Read Only Response[] - A list of all virtual machines resource ids allocated against the capacity reservation.
- current_
capacity int - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- virtual_
machines_ Sequence[Suballocated Resource Read Only Response] - A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity Number - The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
- virtual
Machines List<Property Map>Allocated - A list of all virtual machines resource ids allocated against the capacity reservation.
InstanceViewStatusResponse
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
- code string
- The status code.
- display
Status string - The short localizable label for the status.
- level string
- The level code.
- message string
- The detailed status message, including for alerts and error messages.
- time string
- The time of the status.
- code str
- The status code.
- display_
status str - The short localizable label for the status.
- level str
- The level code.
- message str
- The detailed status message, including for alerts and error messages.
- time str
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
SubResourceReadOnlyResponse
- Id string
- Resource Id
- Id string
- Resource Id
- id String
- Resource Id
- id string
- Resource Id
- id str
- Resource Id
- id String
- Resource Id
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi