azure-native.compute.getCapacityReservationGroup
The operation that retrieves information about a capacity reservation group.
Uses Azure REST API version 2024-11-01.
Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.
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)
public static Output<GetCapacityReservationGroupResult> getCapacityReservationGroup(GetCapacityReservationGroupArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:compute:getCapacityReservationGroup
arguments:
# arguments dictionaryThe following arguments are supported:
- Capacity
Reservation stringGroup Name - The name of the capacity reservation group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Compute. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- 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.
-
Pulumi.
Azure Native. Compute. Outputs. Resource Sharing Profile Response - Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Dictionary<string, string>
- Resource tags.
- Zones List<string>
- The availability zones.
- Azure
Api stringVersion - The Azure API version of the resource.
- Capacity
Reservations []SubResource Read Only Response - A list of all capacity reservation resource ids that belong to capacity reservation group.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Virtual
Machines []SubAssociated Resource Read Only Response - A list of references to all virtual machines associated to the capacity reservation group.
-
Resource
Sharing Profile Response - Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- map[string]string
- Resource tags.
- Zones []string
- The availability zones.
- azure
Api StringVersion - The Azure API version of the resource.
- capacity
Reservations List<SubResource Read Only Response> - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- virtual
Machines List<SubAssociated Resource Read Only Response> - A list of references to all virtual machines associated to the capacity reservation group.
-
Resource
Sharing Profile Response - Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Map<String,String>
- Resource tags.
- zones List<String>
- The availability zones.
- azure
Api stringVersion - The Azure API version of the resource.
- capacity
Reservations SubResource Read Only Response[] - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- virtual
Machines SubAssociated Resource Read Only Response[] - A list of references to all virtual machines associated to the capacity reservation group.
-
Resource
Sharing Profile Response - Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- {[key: string]: string}
- Resource tags.
- zones string[]
- The availability zones.
- azure_
api_ strversion - The Azure API version of the resource.
- capacity_
reservations Sequence[SubResource Read Only Response] - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- virtual_
machines_ Sequence[Subassociated Resource Read Only Response] - A list of references to all virtual machines associated to the capacity reservation group.
-
Resource
Sharing Profile Response - Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Mapping[str, str]
- Resource tags.
- zones Sequence[str]
- The availability zones.
- azure
Api StringVersion - The Azure API version of the resource.
- capacity
Reservations List<Property Map> - A list of all capacity reservation resource ids that belong to capacity reservation group.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- 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
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- virtual
Machines List<Property Map>Associated - A list of references to all virtual machines associated to the capacity reservation group.
- Property Map
- Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Map<String>
- Resource tags.
- zones List<String>
- The availability 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.
-
List<Pulumi.
Azure Native. Compute. Inputs. Sub Resource Read Only Response> - List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Capacity
Reservations []CapacityReservation Instance View With Name Response - List of instance view of the capacity reservations under the capacity reservation group.
-
[]Sub
Resource Read Only Response - List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- capacity
Reservations List<CapacityReservation Instance View With Name Response> - List of instance view of the capacity reservations under the capacity reservation group.
-
List<Sub
Resource Read Only Response> - List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- capacity
Reservations CapacityReservation Instance View With Name Response[] - List of instance view of the capacity reservations under the capacity reservation group.
-
Sub
Resource Read Only Response[] - List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- capacity_
reservations Sequence[CapacityReservation Instance View With Name Response] - List of instance view of the capacity reservations under the capacity reservation group.
-
Sequence[Sub
Resource Read Only Response] - List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- capacity
Reservations List<Property Map> - List of instance view of the capacity reservations under the capacity reservation group.
- List<Property Map>
- List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
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.
ResourceSharingProfileResponse
- Subscription
Ids List<Pulumi.Azure Native. Compute. Inputs. Sub Resource Response> - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- Subscription
Ids []SubResource Response - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- subscription
Ids List<SubResource Response> - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- subscription
Ids SubResource Response[] - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- subscription_
ids Sequence[SubResource Response] - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
- subscription
Ids List<Property Map> - Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
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
SubResourceResponse
- Id string
- Resource Id
- Id string
- Resource Id
- id String
- Resource Id
- id string
- Resource Id
- id str
- Resource Id
- id String
- Resource Id
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
