Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Avi Provider
  4. API Docs
  5. getBackup
Viewing docs for avi 32.1.3
published on Wednesday, Sep 9, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-avi

avi.getBackup

Viewing docs for avi 32.1.3
published on Wednesday, Sep 9, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “AVI: avi.Backup” sidebar_current: “docs-avi-datasource-backup” description: |- Get information of Avi Backup.

    avi.Backup

    This data source is used to to get avi.Backup objects.

    Example Usage

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

const fooBackup = avi.getBackup({
    uuid: "backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name: "foo",
});

    import pulumi
import pulumi_avi as avi

foo_backup = avi.get_backup(uuid="backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name="foo")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v32/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupBackup(ctx, &avi.LookupBackupArgs{
			Uuid: pulumi.StringRef("backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
			Name: pulumi.StringRef("foo"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooBackup = Avi.GetBackup.Invoke(new()
    {
        Uuid = "backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        Name = "foo",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetBackupArgs;
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 fooBackup = AviFunctions.getBackup(GetBackupArgs.builder()
            .uuid("backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .name("foo")
            .build());

    }
}

    variables:
  fooBackup:
    fn::invoke:
      function: avi:getBackup
      arguments:
        uuid: backup-f9cf6b3e-a411-436f-95e2-2982ba2b217b
        name: foo

    Example coming soon!

    Using getBackup

    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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupResult>
    def get_backup(id: Optional[str] = None,
               name: Optional[str] = None,
               tenant_ref: Optional[str] = None,
               uuid: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(id: pulumi.Input[Optional[str]] = None,
               name: pulumi.Input[Optional[str]] = None,
               tenant_ref: pulumi.Input[Optional[str]] = None,
               uuid: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

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

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: avi:index/getBackup:getBackup
  arguments:
    # arguments dictionary
    data "avi_get_backup" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Name string
    Search Backup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search Backup by uuid.
    Id string
    Name string
    Search Backup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search Backup by uuid.
    id string
    name string
    Search Backup by name.
    tenant_ref string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search Backup by uuid.
    id String
    name String
    Search Backup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search Backup by uuid.
    id string
    name string
    Search Backup by name.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search Backup by uuid.
    id str
    name str
    Search Backup by name.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search Backup by uuid.
    id String
    name String
    Search Backup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search Backup by uuid.

    getBackup Result

    The following output properties are available:

    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    file_name string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    local_file_url string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remote_file_url string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_ref string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    localFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref str
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    file_name str
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id str
    local_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remote_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_ref str
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp str
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the backup. Field introduced in 32.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    Viewing docs for avi 32.1.3
    published on Wednesday, Sep 9, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-avi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial