getBackup

avi 31.2.1, Dec 22 25

avi 31.2.1 published on Monday, Dec 22, 2025 by vmware

Schema (JSON)

vmware/terraform-provider-avi

avi 31.2.1 published on Monday, Dec 22, 2025 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:<span pulumi-lang-nodejs=” avi.Backup"" pulumi-lang-dotnet=" avi.Backup"" pulumi-lang-go=" Backup"" pulumi-lang-python=" Backup"" pulumi-lang-yaml=" avi.Backup"" pulumi-lang-java=" avi.Backup""> 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

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

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

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?: InvokeOptions): Output<GetBackupResult>

def get_backup(id: Optional[str] = None,
               tenant_ref: Optional[str] = None,
               uuid: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(id: Optional[pulumi.Input[str]] = None,
               tenant_ref: Optional[pulumi.Input[str]] = None,
               uuid: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = 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 CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getBackup:getBackup
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
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
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
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
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
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
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.
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.
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.
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.
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.
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.
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.

avi 31.2.1 published on Monday, Dec 22, 2025 by vmware

Schema (JSON)

vmware/terraform-provider-avi

avi.getBackup

On this page

On this page

<!–

–>

layout: “avi”

Example Usage

Using getBackup

getBackup Result

Package Details

On this page

On this page