oci.Core.getVolumeGroupBackups

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testVolumeGroupBackups = oci.Core.getVolumeGroupBackups({
    compartmentId: compartmentId,
    displayName: volumeGroupBackupDisplayName,
    volumeGroupId: testVolumeGroup.id,
});

import pulumi
import pulumi_oci as oci

test_volume_group_backups = oci.Core.get_volume_group_backups(compartment_id=compartment_id,
    display_name=volume_group_backup_display_name,
    volume_group_id=test_volume_group["id"])

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.GetVolumeGroupBackups(ctx, &core.GetVolumeGroupBackupsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(volumeGroupBackupDisplayName),
			VolumeGroupId: pulumi.StringRef(testVolumeGroup.Id),
		}, 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 testVolumeGroupBackups = Oci.Core.GetVolumeGroupBackups.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = volumeGroupBackupDisplayName,
        VolumeGroupId = testVolumeGroup.Id,
    });

});

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.GetVolumeGroupBackupsArgs;
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 testVolumeGroupBackups = CoreFunctions.getVolumeGroupBackups(GetVolumeGroupBackupsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(volumeGroupBackupDisplayName)
            .volumeGroupId(testVolumeGroup.id())
            .build());

    }
}

variables:
  testVolumeGroupBackups:
    fn::invoke:
      function: oci:Core:getVolumeGroupBackups
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${volumeGroupBackupDisplayName}
        volumeGroupId: ${testVolumeGroup.id}

Using getVolumeGroupBackups

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 getVolumeGroupBackups(args: GetVolumeGroupBackupsArgs, opts?: InvokeOptions): Promise<GetVolumeGroupBackupsResult>
function getVolumeGroupBackupsOutput(args: GetVolumeGroupBackupsOutputArgs, opts?: InvokeOptions): Output<GetVolumeGroupBackupsResult>

def get_volume_group_backups(compartment_id: Optional[str] = None,
                             display_name: Optional[str] = None,
                             filters: Optional[Sequence[GetVolumeGroupBackupsFilter]] = None,
                             volume_group_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVolumeGroupBackupsResult
def get_volume_group_backups_output(compartment_id: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVolumeGroupBackupsFilterArgs]]]] = None,
                             volume_group_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVolumeGroupBackupsResult]

func GetVolumeGroupBackups(ctx *Context, args *GetVolumeGroupBackupsArgs, opts ...InvokeOption) (*GetVolumeGroupBackupsResult, error)
func GetVolumeGroupBackupsOutput(ctx *Context, args *GetVolumeGroupBackupsOutputArgs, opts ...InvokeOption) GetVolumeGroupBackupsResultOutput

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

public static class GetVolumeGroupBackups 
{
    public static Task<GetVolumeGroupBackupsResult> InvokeAsync(GetVolumeGroupBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeGroupBackupsResult> Invoke(GetVolumeGroupBackupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeGroupBackupsResult> getVolumeGroupBackups(GetVolumeGroupBackupsArgs args, InvokeOptions options)
public static Output<GetVolumeGroupBackupsResult> getVolumeGroupBackups(GetVolumeGroupBackupsArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetVolumeGroupBackupsFilter>
VolumeGroupId string: The OCID of the volume group.

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetVolumeGroupBackupsFilter
VolumeGroupId string: The OCID of the volume group.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetVolumeGroupBackupsFilter>
volumeGroupId String: The OCID of the volume group.

compartmentId string: The OCID of the compartment.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetVolumeGroupBackupsFilter[]
volumeGroupId string: The OCID of the volume group.

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[GetVolumeGroupBackupsFilter]
volume_group_id str: The OCID of the volume group.

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>
volumeGroupId String: The OCID of the volume group.

getVolumeGroupBackups Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the volume group backup.
Id string: The provider-assigned unique ID for this managed resource.
VolumeGroupBackups List<GetVolumeGroupBackupsVolumeGroupBackup>: The list of volume_group_backups.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetVolumeGroupBackupsFilter>
VolumeGroupId string: The OCID of the source volume group.

CompartmentId string: The OCID of the compartment that contains the volume group backup.
Id string: The provider-assigned unique ID for this managed resource.
VolumeGroupBackups []GetVolumeGroupBackupsVolumeGroupBackup: The list of volume_group_backups.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetVolumeGroupBackupsFilter
VolumeGroupId string: The OCID of the source volume group.

compartmentId String: The OCID of the compartment that contains the volume group backup.
id String: The provider-assigned unique ID for this managed resource.
volumeGroupBackups List<GetVolumeGroupBackupsVolumeGroupBackup>: The list of volume_group_backups.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetVolumeGroupBackupsFilter>
volumeGroupId String: The OCID of the source volume group.

compartmentId string: The OCID of the compartment that contains the volume group backup.
id string: The provider-assigned unique ID for this managed resource.
volumeGroupBackups GetVolumeGroupBackupsVolumeGroupBackup[]: The list of volume_group_backups.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetVolumeGroupBackupsFilter[]
volumeGroupId string: The OCID of the source volume group.

compartment_id str: The OCID of the compartment that contains the volume group backup.
id str: The provider-assigned unique ID for this managed resource.
volume_group_backups Sequence[GetVolumeGroupBackupsVolumeGroupBackup]: The list of volume_group_backups.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[GetVolumeGroupBackupsFilter]
volume_group_id str: The OCID of the source volume group.

compartmentId String: The OCID of the compartment that contains the volume group backup.
id String: The provider-assigned unique ID for this managed resource.
volumeGroupBackups List<Property Map>: The list of volume_group_backups.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
volumeGroupId String: The OCID of the source volume group.

Supporting Types

GetVolumeGroupBackupsFilter

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

GetVolumeGroupBackupsVolumeGroupBackup

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.
ExpirationTime string: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
SizeInGbs string: The aggregate size of the volume group backup, in GBs.
SizeInMbs string: The aggregate size of the volume group backup, in MBs.
SourceDetails List<GetVolumeGroupBackupsVolumeGroupBackupSourceDetail>
SourceType string: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string: The OCID of the source volume group backup.
State string: The current state of a volume group backup.
TimeCreated string: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
Type string: The type of backup.
UniqueSizeInGbs string: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds List<string>: OCIDs for the volume backups in this volume group backup.
VolumeGroupId string: The OCID of the volume group.

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.
ExpirationTime string: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
SizeInGbs string: The aggregate size of the volume group backup, in GBs.
SizeInMbs string: The aggregate size of the volume group backup, in MBs.
SourceDetails []GetVolumeGroupBackupsVolumeGroupBackupSourceDetail
SourceType string: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string: The OCID of the source volume group backup.
State string: The current state of a volume group backup.
TimeCreated string: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
Type string: The type of backup.
UniqueSizeInGbs string: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds []string: OCIDs for the volume backups in this volume group backup.
VolumeGroupId string: The OCID of the volume group.

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.
expirationTime String: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
sizeInGbs String: The aggregate size of the volume group backup, in GBs.
sizeInMbs String: The aggregate size of the volume group backup, in MBs.
sourceDetails List<GetVolumeGroupBackupsVolumeGroupBackupSourceDetail>
sourceType String: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String: The OCID of the source volume group backup.
state String: The current state of a volume group backup.
timeCreated String: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type String: The type of backup.
uniqueSizeInGbs String: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>: OCIDs for the volume backups in this volume group backup.
volumeGroupId String: The OCID of the volume group.

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.
expirationTime string: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
sizeInGbs string: The aggregate size of the volume group backup, in GBs.
sizeInMbs string: The aggregate size of the volume group backup, in MBs.
sourceDetails GetVolumeGroupBackupsVolumeGroupBackupSourceDetail[]
sourceType string: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId string: The OCID of the source volume group backup.
state string: The current state of a volume group backup.
timeCreated string: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived string: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type string: The type of backup.
uniqueSizeInGbs string: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs string: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds string[]: OCIDs for the volume backups in this volume group backup.
volumeGroupId string: The OCID of the volume group.

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.
expiration_time str: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
size_in_gbs str: The aggregate size of the volume group backup, in GBs.
size_in_mbs str: The aggregate size of the volume group backup, in MBs.
source_details Sequence[GetVolumeGroupBackupsVolumeGroupBackupSourceDetail]
source_type str: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
source_volume_group_backup_id str: The OCID of the source volume group backup.
state str: The current state of a volume group backup.
time_created str: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
time_request_received str: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type str: The type of backup.
unique_size_in_gbs str: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
unique_size_in_mbs str: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volume_backup_ids Sequence[str]: OCIDs for the volume backups in this volume group backup.
volume_group_id str: The OCID of the volume group.

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.
expirationTime String: The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume group backup.
sizeInGbs String: The aggregate size of the volume group backup, in GBs.
sizeInMbs String: The aggregate size of the volume group backup, in MBs.
sourceDetails List<Property Map>
sourceType String: Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String: The OCID of the source volume group backup.
state String: The current state of a volume group backup.
timeCreated String: The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String: The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type String: The type of backup.
uniqueSizeInGbs String: The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String: The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>: OCIDs for the volume backups in this volume group backup.
volumeGroupId String: The OCID of the volume group.