Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.Core.getVolumeGroups
Explore with Pulumi AI
This data source provides the list of Volume Groups in Oracle Cloud Infrastructure Core service.
Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testVolumeGroups = oci.Core.getVolumeGroups({
compartmentId: compartmentId,
availabilityDomain: volumeGroupAvailabilityDomain,
displayName: volumeGroupDisplayName,
state: volumeGroupState,
});
import pulumi
import pulumi_oci as oci
test_volume_groups = oci.Core.get_volume_groups(compartment_id=compartment_id,
availability_domain=volume_group_availability_domain,
display_name=volume_group_display_name,
state=volume_group_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Core.GetVolumeGroups(ctx, &core.GetVolumeGroupsArgs{
CompartmentId: compartmentId,
AvailabilityDomain: pulumi.StringRef(volumeGroupAvailabilityDomain),
DisplayName: pulumi.StringRef(volumeGroupDisplayName),
State: pulumi.StringRef(volumeGroupState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testVolumeGroups = Oci.Core.GetVolumeGroups.Invoke(new()
{
CompartmentId = compartmentId,
AvailabilityDomain = volumeGroupAvailabilityDomain,
DisplayName = volumeGroupDisplayName,
State = volumeGroupState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetVolumeGroupsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testVolumeGroups = CoreFunctions.getVolumeGroups(GetVolumeGroupsArgs.builder()
.compartmentId(compartmentId)
.availabilityDomain(volumeGroupAvailabilityDomain)
.displayName(volumeGroupDisplayName)
.state(volumeGroupState)
.build());
}
}
variables:
testVolumeGroups:
fn::invoke:
Function: oci:Core:getVolumeGroups
Arguments:
compartmentId: ${compartmentId}
availabilityDomain: ${volumeGroupAvailabilityDomain}
displayName: ${volumeGroupDisplayName}
state: ${volumeGroupState}
Using getVolumeGroups
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 getVolumeGroups(args: GetVolumeGroupsArgs, opts?: InvokeOptions): Promise<GetVolumeGroupsResult>
function getVolumeGroupsOutput(args: GetVolumeGroupsOutputArgs, opts?: InvokeOptions): Output<GetVolumeGroupsResult>
def get_volume_groups(availability_domain: Optional[str] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_core.GetVolumeGroupsFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVolumeGroupsResult
def get_volume_groups_output(availability_domain: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetVolumeGroupsFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVolumeGroupsResult]
func GetVolumeGroups(ctx *Context, args *GetVolumeGroupsArgs, opts ...InvokeOption) (*GetVolumeGroupsResult, error)
func GetVolumeGroupsOutput(ctx *Context, args *GetVolumeGroupsOutputArgs, opts ...InvokeOption) GetVolumeGroupsResultOutput
> Note: This function is named GetVolumeGroups
in the Go SDK.
public static class GetVolumeGroups
{
public static Task<GetVolumeGroupsResult> InvokeAsync(GetVolumeGroupsArgs args, InvokeOptions? opts = null)
public static Output<GetVolumeGroupsResult> Invoke(GetVolumeGroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVolumeGroupsResult> getVolumeGroups(GetVolumeGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Core/getVolumeGroups:getVolumeGroups
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The OCID of the compartment.
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Volume Groups Filter> - State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Compartment
Id string - The OCID of the compartment.
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Volume Groups Filter - State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment.
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Volume Groups Filter> - state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id string - The OCID of the compartment.
- availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Volume Groups Filter[] - state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment_
id str - The OCID of the compartment.
- availability_
domain str - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display_
name str - A filter to return only resources that match the given display name exactly.
- filters
Sequence[core.
Get Volume Groups Filter] - state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment.
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
getVolumeGroups Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment that contains the volume group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Volume
Groups List<GetVolume Groups Volume Group> - The list of volume_groups.
- Availability
Domain string - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Volume Groups Filter> - State string
- The current state of a volume group.
- Compartment
Id string - The OCID of the compartment that contains the volume group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Volume
Groups []GetVolume Groups Volume Group - The list of volume_groups.
- Availability
Domain string - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Volume Groups Filter - State string
- The current state of a volume group.
- compartment
Id String - The OCID of the compartment that contains the volume group.
- id String
- The provider-assigned unique ID for this managed resource.
- volume
Groups List<GetVolume Groups Volume Group> - The list of volume_groups.
- availability
Domain String - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Volume Groups Filter> - state String
- The current state of a volume group.
- compartment
Id string - The OCID of the compartment that contains the volume group.
- id string
- The provider-assigned unique ID for this managed resource.
- volume
Groups GetVolume Groups Volume Group[] - The list of volume_groups.
- availability
Domain string - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Volume Groups Filter[] - state string
- The current state of a volume group.
- compartment_
id str - The OCID of the compartment that contains the volume group.
- id str
- The provider-assigned unique ID for this managed resource.
- volume_
groups Sequence[core.Get Volume Groups Volume Group] - The list of volume_groups.
- availability_
domain str - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[core.
Get Volume Groups Filter] - state str
- The current state of a volume group.
- compartment
Id String - The OCID of the compartment that contains the volume group.
- id String
- The provider-assigned unique ID for this managed resource.
- volume
Groups List<Property Map> - The list of volume_groups.
- availability
Domain String - The availability domain of the boot volume replica replica. Example:
Uocm:PHX-AD-1
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- state String
- The current state of a volume group.
Supporting Types
GetVolumeGroupsFilter
GetVolumeGroupsVolumeGroup
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Backup
Policy stringId - Cluster
Placement stringGroup Id - Compartment
Id string - The OCID of the compartment.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID for the volume group.
- Is
Hydrated bool - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- Preserve
Volume boolReplica - Size
In stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- Source
Details List<GetVolume Groups Volume Group Source Detail> - Specifies the source for a volume group.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- Volume
Group List<GetReplicas Volume Groups Volume Group Volume Group Replica> - The list of volume group replicas of this volume group.
- Volume
Group boolReplicas Deletion - Volume
Ids List<string> - OCIDs for the volumes in this volume group.
- Xrc
Kms stringKey Id
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Backup
Policy stringId - Cluster
Placement stringGroup Id - Compartment
Id string - The OCID of the compartment.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A filter to return only resources that match the given display name exactly.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID for the volume group.
- Is
Hydrated bool - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- Preserve
Volume boolReplica - Size
In stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- Source
Details []GetVolume Groups Volume Group Source Detail - Specifies the source for a volume group.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- Volume
Group []GetReplicas Volume Groups Volume Group Volume Group Replica - The list of volume group replicas of this volume group.
- Volume
Group boolReplicas Deletion - Volume
Ids []string - OCIDs for the volumes in this volume group.
- Xrc
Kms stringKey Id
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- backup
Policy StringId - cluster
Placement StringGroup Id - compartment
Id String - The OCID of the compartment.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID for the volume group.
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume BooleanReplica - size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- source
Details List<GetVolume Groups Volume Group Source Detail> - Specifies the source for a volume group.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created String - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group List<GetReplicas Volume Groups Volume Group Volume Group Replica> - The list of volume group replicas of this volume group.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> - OCIDs for the volumes in this volume group.
- xrc
Kms StringKey Id
- availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- backup
Policy stringId - cluster
Placement stringGroup Id - compartment
Id string - The OCID of the compartment.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
- The OCID for the volume group.
- is
Hydrated boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume booleanReplica - size
In stringGbs - The aggregate size of the volume group in GBs.
- size
In stringMbs - The aggregate size of the volume group in MBs.
- source
Details GetVolume Groups Volume Group Source Detail[] - Specifies the source for a volume group.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group GetReplicas Volume Groups Volume Group Volume Group Replica[] - The list of volume group replicas of this volume group.
- volume
Group booleanReplicas Deletion - volume
Ids string[] - OCIDs for the volumes in this volume group.
- xrc
Kms stringKey Id
- availability_
domain str - The name of the availability domain. Example:
Uocm:PHX-AD-1
- backup_
policy_ strid - cluster_
placement_ strgroup_ id - compartment_
id str - The OCID of the compartment.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name str - A filter to return only resources that match the given display name exactly.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id str
- The OCID for the volume group.
- is_
hydrated bool - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve_
volume_ boolreplica - size_
in_ strgbs - The aggregate size of the volume group in GBs.
- size_
in_ strmbs - The aggregate size of the volume group in MBs.
- source_
details Sequence[core.Get Volume Groups Volume Group Source Detail] - Specifies the source for a volume group.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time_
created str - The date and time the volume group was created. Format defined by RFC3339.
- volume_
group_ Sequence[core.replicas Get Volume Groups Volume Group Volume Group Replica] - The list of volume group replicas of this volume group.
- volume_
group_ boolreplicas_ deletion - volume_
ids Sequence[str] - OCIDs for the volumes in this volume group.
- xrc_
kms_ strkey_ id
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- backup
Policy StringId - cluster
Placement StringGroup Id - compartment
Id String - The OCID of the compartment.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID for the volume group.
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume BooleanReplica - size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- source
Details List<Property Map> - Specifies the source for a volume group.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created String - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group List<Property Map>Replicas - The list of volume group replicas of this volume group.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> - OCIDs for the volumes in this volume group.
- xrc
Kms StringKey Id
GetVolumeGroupsVolumeGroupSourceDetail
- Type string
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- Volume
Group stringBackup Id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- Volume
Group stringId - The OCID of the volume group to clone from, if the type is
volumeGroup
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- Volume
Ids List<string> - OCIDs for the volumes in this volume group.
- Type string
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- Volume
Group stringBackup Id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- Volume
Group stringId - The OCID of the volume group to clone from, if the type is
volumeGroup
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- Volume
Ids []string - OCIDs for the volumes in this volume group.
- type String
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- volume
Group StringBackup Id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- volume
Group StringId - The OCID of the volume group to clone from, if the type is
volumeGroup
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
- volume
Ids List<String> - OCIDs for the volumes in this volume group.
- type string
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- volume
Group stringBackup Id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- volume
Group stringId - The OCID of the volume group to clone from, if the type is
volumeGroup
- volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- volume
Ids string[] - OCIDs for the volumes in this volume group.
- type str
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- volume_
group_ strbackup_ id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- volume_
group_ strid - The OCID of the volume group to clone from, if the type is
volumeGroup
- volume_
group_ strreplica_ id - The volume group replica's Oracle ID (OCID).
- volume_
ids Sequence[str] - OCIDs for the volumes in this volume group.
- type String
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeIds
- volume
Group StringBackup Id - The OCID of the volume group backup to restore from, if the type is
volumeGroupBackup
- volume
Group StringId - The OCID of the volume group to clone from, if the type is
volumeGroup
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
- volume
Ids List<String> - OCIDs for the volumes in this volume group.
GetVolumeGroupsVolumeGroupVolumeGroupReplica
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- Xrr
Kms stringKey Id
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- Xrr
Kms stringKey Id
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name String - A filter to return only resources that match the given display name exactly.
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
- xrr
Kms StringKey Id
- availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name string - A filter to return only resources that match the given display name exactly.
- volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- xrr
Kms stringKey Id
- availability_
domain str - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display_
name str - A filter to return only resources that match the given display name exactly.
- volume_
group_ strreplica_ id - The volume group replica's Oracle ID (OCID).
- xrr_
kms_ strkey_ id
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- display
Name String - A filter to return only resources that match the given display name exactly.
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
- xrr
Kms StringKey Id
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.