Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getVolumeGroupReplicas
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Core.getVolumeGroupReplicas

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Volume Group Replicas in Oracle Cloud Infrastructure Core service.

    Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testVolumeGroupReplicas = oci.Core.getVolumeGroupReplicas({
    availabilityDomain: volumeGroupReplicaAvailabilityDomain,
    compartmentId: compartmentId,
    displayName: volumeGroupReplicaDisplayName,
    state: volumeGroupReplicaState,
});

    import pulumi
import pulumi_oci as oci

test_volume_group_replicas = oci.Core.get_volume_group_replicas(availability_domain=volume_group_replica_availability_domain,
    compartment_id=compartment_id,
    display_name=volume_group_replica_display_name,
    state=volume_group_replica_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.GetVolumeGroupReplicas(ctx, &core.GetVolumeGroupReplicasArgs{
			AvailabilityDomain: volumeGroupReplicaAvailabilityDomain,
			CompartmentId:      compartmentId,
			DisplayName:        pulumi.StringRef(volumeGroupReplicaDisplayName),
			State:              pulumi.StringRef(volumeGroupReplicaState),
		}, 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 testVolumeGroupReplicas = Oci.Core.GetVolumeGroupReplicas.Invoke(new()
    {
        AvailabilityDomain = volumeGroupReplicaAvailabilityDomain,
        CompartmentId = compartmentId,
        DisplayName = volumeGroupReplicaDisplayName,
        State = volumeGroupReplicaState,
    });

});

    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.GetVolumeGroupReplicasArgs;
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 testVolumeGroupReplicas = CoreFunctions.getVolumeGroupReplicas(GetVolumeGroupReplicasArgs.builder()
            .availabilityDomain(volumeGroupReplicaAvailabilityDomain)
            .compartmentId(compartmentId)
            .displayName(volumeGroupReplicaDisplayName)
            .state(volumeGroupReplicaState)
            .build());

    }
}

    variables:
  testVolumeGroupReplicas:
    fn::invoke:
      function: oci:Core:getVolumeGroupReplicas
      arguments:
        availabilityDomain: ${volumeGroupReplicaAvailabilityDomain}
        compartmentId: ${compartmentId}
        displayName: ${volumeGroupReplicaDisplayName}
        state: ${volumeGroupReplicaState}

    Using getVolumeGroupReplicas

    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 getVolumeGroupReplicas(args: GetVolumeGroupReplicasArgs, opts?: InvokeOptions): Promise<GetVolumeGroupReplicasResult>
function getVolumeGroupReplicasOutput(args: GetVolumeGroupReplicasOutputArgs, opts?: InvokeOptions): Output<GetVolumeGroupReplicasResult>
    def get_volume_group_replicas(availability_domain: Optional[str] = None,
                              compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              filters: Optional[Sequence[GetVolumeGroupReplicasFilter]] = None,
                              state: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetVolumeGroupReplicasResult
def get_volume_group_replicas_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[GetVolumeGroupReplicasFilterArgs]]]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetVolumeGroupReplicasResult]
    func GetVolumeGroupReplicas(ctx *Context, args *GetVolumeGroupReplicasArgs, opts ...InvokeOption) (*GetVolumeGroupReplicasResult, error)
func GetVolumeGroupReplicasOutput(ctx *Context, args *GetVolumeGroupReplicasOutputArgs, opts ...InvokeOption) GetVolumeGroupReplicasResultOutput

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

    public static class GetVolumeGroupReplicas 
{
    public static Task<GetVolumeGroupReplicasResult> InvokeAsync(GetVolumeGroupReplicasArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeGroupReplicasResult> Invoke(GetVolumeGroupReplicasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeGroupReplicasResult> getVolumeGroupReplicas(GetVolumeGroupReplicasArgs args, InvokeOptions options)
public static Output<GetVolumeGroupReplicasResult> getVolumeGroupReplicas(GetVolumeGroupReplicasArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Core/getVolumeGroupReplicas:getVolumeGroupReplicas
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetVolumeGroupReplicasFilter>
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetVolumeGroupReplicasFilter
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetVolumeGroupReplicasFilter>
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetVolumeGroupReplicasFilter[]
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartment_id str
    The OCID of the compartment.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetVolumeGroupReplicasFilter]
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    displayName 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.

    getVolumeGroupReplicas Result

    The following output properties are available:

    AvailabilityDomain string
    The availability domain of the volume group replica.
    CompartmentId string
    The OCID of the compartment that contains the volume group replica.
    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeGroupReplicas List<GetVolumeGroupReplicasVolumeGroupReplica>
    The list of volume_group_replicas.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetVolumeGroupReplicasFilter>
    State string
    The current state of a volume group.
    AvailabilityDomain string
    The availability domain of the volume group replica.
    CompartmentId string
    The OCID of the compartment that contains the volume group replica.
    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeGroupReplicas []GetVolumeGroupReplicasVolumeGroupReplica
    The list of volume_group_replicas.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetVolumeGroupReplicasFilter
    State string
    The current state of a volume group.
    availabilityDomain String
    The availability domain of the volume group replica.
    compartmentId String
    The OCID of the compartment that contains the volume group replica.
    id String
    The provider-assigned unique ID for this managed resource.
    volumeGroupReplicas List<GetVolumeGroupReplicasVolumeGroupReplica>
    The list of volume_group_replicas.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetVolumeGroupReplicasFilter>
    state String
    The current state of a volume group.
    availabilityDomain string
    The availability domain of the volume group replica.
    compartmentId string
    The OCID of the compartment that contains the volume group replica.
    id string
    The provider-assigned unique ID for this managed resource.
    volumeGroupReplicas GetVolumeGroupReplicasVolumeGroupReplica[]
    The list of volume_group_replicas.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetVolumeGroupReplicasFilter[]
    state string
    The current state of a volume group.
    availability_domain str
    The availability domain of the volume group replica.
    compartment_id str
    The OCID of the compartment that contains the volume group replica.
    id str
    The provider-assigned unique ID for this managed resource.
    volume_group_replicas Sequence[GetVolumeGroupReplicasVolumeGroupReplica]
    The list of volume_group_replicas.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters Sequence[GetVolumeGroupReplicasFilter]
    state str
    The current state of a volume group.
    availabilityDomain String
    The availability domain of the volume group replica.
    compartmentId String
    The OCID of the compartment that contains the volume group replica.
    id String
    The provider-assigned unique ID for this managed resource.
    volumeGroupReplicas List<Property Map>
    The list of volume_group_replicas.
    displayName 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

    GetVolumeGroupReplicasFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetVolumeGroupReplicasVolumeGroupReplica

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DefinedTags 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"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags 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 replica.
    MemberReplicas List<GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica>
    Volume replicas within this volume group replica.
    SizeInGbs string
    The aggregate size of the volume group replica in GBs.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    TimeCreated string
    The date and time the volume group replica was created. Format defined by RFC3339.
    TimeLastSynced string
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    VolumeGroupId string
    The OCID of the source volume group.
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DefinedTags 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"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags 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 replica.
    MemberReplicas []GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica
    Volume replicas within this volume group replica.
    SizeInGbs string
    The aggregate size of the volume group replica in GBs.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    TimeCreated string
    The date and time the volume group replica was created. Format defined by RFC3339.
    TimeLastSynced string
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    VolumeGroupId string
    The OCID of the source volume group.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    definedTags 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"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags 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 replica.
    memberReplicas List<GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica>
    Volume replicas within this volume group replica.
    sizeInGbs String
    The aggregate size of the volume group replica in GBs.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated String
    The date and time the volume group replica was created. Format defined by RFC3339.
    timeLastSynced String
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    volumeGroupId String
    The OCID of the source volume group.
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId string
    The OCID of the compartment.
    definedTags {[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"}
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[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 replica.
    memberReplicas GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica[]
    Volume replicas within this volume group replica.
    sizeInGbs string
    The aggregate size of the volume group replica in GBs.
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated string
    The date and time the volume group replica was created. Format defined by RFC3339.
    timeLastSynced string
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    volumeGroupId string
    The OCID of the source volume group.
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartment_id str
    The OCID of the compartment.
    defined_tags 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.
    freeform_tags 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 replica.
    member_replicas Sequence[GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica]
    Volume replicas within this volume group replica.
    size_in_gbs str
    The aggregate size of the volume group replica in GBs.
    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 replica was created. Format defined by RFC3339.
    time_last_synced str
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    volume_group_id str
    The OCID of the source volume group.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    definedTags 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"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags 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 replica.
    memberReplicas List<Property Map>
    Volume replicas within this volume group replica.
    sizeInGbs String
    The aggregate size of the volume group replica in GBs.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated String
    The date and time the volume group replica was created. Format defined by RFC3339.
    timeLastSynced String
    The date and time the volume group replica was last synced from the source volume group. Format defined by RFC3339.
    volumeGroupId String
    The OCID of the source volume group.

    GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica

    MembershipState string
    Membership state of the volume replica in relation to the volume group replica.
    VolumeReplicaId string
    The volume replica ID.
    MembershipState string
    Membership state of the volume replica in relation to the volume group replica.
    VolumeReplicaId string
    The volume replica ID.
    membershipState String
    Membership state of the volume replica in relation to the volume group replica.
    volumeReplicaId String
    The volume replica ID.
    membershipState string
    Membership state of the volume replica in relation to the volume group replica.
    volumeReplicaId string
    The volume replica ID.
    membership_state str
    Membership state of the volume replica in relation to the volume group replica.
    volume_replica_id str
    The volume replica ID.
    membershipState String
    Membership state of the volume replica in relation to the volume group replica.
    volumeReplicaId String
    The volume replica ID.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci