1. Packages
  2. OVH
  3. API Docs
  4. VMware
  5. getCloudDirectorBackup
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.VMware.getCloudDirectorBackup

ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Get information about a VMware Cloud Director Backup service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const backup = ovh.VMware.getCloudDirectorBackup({
    backupId: "<VCD backup ID>",
});

    import pulumi
import pulumi_ovh as ovh

backup = ovh.VMware.get_cloud_director_backup(backup_id="<VCD backup ID>")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/vmware"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vmware.GetCloudDirectorBackup(ctx, &vmware.GetCloudDirectorBackupArgs{
			BackupId: "<VCD backup ID>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var backup = Ovh.VMware.GetCloudDirectorBackup.Invoke(new()
    {
        BackupId = "<VCD backup ID>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.VMware.VMwareFunctions;
import com.pulumi.ovh.VMware.inputs.GetCloudDirectorBackupArgs;
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 backup = VMwareFunctions.getCloudDirectorBackup(GetCloudDirectorBackupArgs.builder()
            .backupId("<VCD backup ID>")
            .build());

    }
}

    variables:
  backup:
    fn::invoke:
      function: ovh:VMware:getCloudDirectorBackup
      arguments:
        backupId: <VCD backup ID>

    Using getCloudDirectorBackup

    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 getCloudDirectorBackup(args: GetCloudDirectorBackupArgs, opts?: InvokeOptions): Promise<GetCloudDirectorBackupResult>
function getCloudDirectorBackupOutput(args: GetCloudDirectorBackupOutputArgs, opts?: InvokeOptions): Output<GetCloudDirectorBackupResult>
    def get_cloud_director_backup(backup_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCloudDirectorBackupResult
def get_cloud_director_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudDirectorBackupResult]
    func GetCloudDirectorBackup(ctx *Context, args *GetCloudDirectorBackupArgs, opts ...InvokeOption) (*GetCloudDirectorBackupResult, error)
func GetCloudDirectorBackupOutput(ctx *Context, args *GetCloudDirectorBackupOutputArgs, opts ...InvokeOption) GetCloudDirectorBackupResultOutput

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

    public static class GetCloudDirectorBackup 
{
    public static Task<GetCloudDirectorBackupResult> InvokeAsync(GetCloudDirectorBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudDirectorBackupResult> Invoke(GetCloudDirectorBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudDirectorBackupResult> getCloudDirectorBackup(GetCloudDirectorBackupArgs args, InvokeOptions options)
public static Output<GetCloudDirectorBackupResult> getCloudDirectorBackup(GetCloudDirectorBackupArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:VMware/getCloudDirectorBackup:getCloudDirectorBackup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BackupId string
    Backup ID
    BackupId string
    Backup ID
    backupId String
    Backup ID
    backupId string
    Backup ID
    backup_id str
    Backup ID
    backupId String
    Backup ID

    getCloudDirectorBackup Result

    The following output properties are available:

    BackupId string
    Backup ID
    CreatedAt string
    Datetime when backup was enabled
    CurrentState GetCloudDirectorBackupCurrentState
    VMware Cloud Director Backup service current state
    CurrentTasks List<GetCloudDirectorBackupCurrentTask>
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    Iam GetCloudDirectorBackupIam
    IAM resource metadata
    Id string
    Unique identifier of the VMware Cloud Director backup
    ResourceStatus string
    Reflects the readiness of the VMware Cloud Director organization backup service
    TargetSpec GetCloudDirectorBackupTargetSpec
    VMware Cloud Director Backup target spec
    UpdatedAt string
    Datetime when backup is modified
    BackupId string
    Backup ID
    CreatedAt string
    Datetime when backup was enabled
    CurrentState GetCloudDirectorBackupCurrentState
    VMware Cloud Director Backup service current state
    CurrentTasks []GetCloudDirectorBackupCurrentTask
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    Iam GetCloudDirectorBackupIam
    IAM resource metadata
    Id string
    Unique identifier of the VMware Cloud Director backup
    ResourceStatus string
    Reflects the readiness of the VMware Cloud Director organization backup service
    TargetSpec GetCloudDirectorBackupTargetSpec
    VMware Cloud Director Backup target spec
    UpdatedAt string
    Datetime when backup is modified
    backupId String
    Backup ID
    createdAt String
    Datetime when backup was enabled
    currentState GetCloudDirectorBackupCurrentState
    VMware Cloud Director Backup service current state
    currentTasks List<GetCloudDirectorBackupCurrentTask>
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    iam GetCloudDirectorBackupIam
    IAM resource metadata
    id String
    Unique identifier of the VMware Cloud Director backup
    resourceStatus String
    Reflects the readiness of the VMware Cloud Director organization backup service
    targetSpec GetCloudDirectorBackupTargetSpec
    VMware Cloud Director Backup target spec
    updatedAt String
    Datetime when backup is modified
    backupId string
    Backup ID
    createdAt string
    Datetime when backup was enabled
    currentState GetCloudDirectorBackupCurrentState
    VMware Cloud Director Backup service current state
    currentTasks GetCloudDirectorBackupCurrentTask[]
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    iam GetCloudDirectorBackupIam
    IAM resource metadata
    id string
    Unique identifier of the VMware Cloud Director backup
    resourceStatus string
    Reflects the readiness of the VMware Cloud Director organization backup service
    targetSpec GetCloudDirectorBackupTargetSpec
    VMware Cloud Director Backup target spec
    updatedAt string
    Datetime when backup is modified
    backup_id str
    Backup ID
    created_at str
    Datetime when backup was enabled
    current_state GetCloudDirectorBackupCurrentState
    VMware Cloud Director Backup service current state
    current_tasks Sequence[GetCloudDirectorBackupCurrentTask]
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    iam GetCloudDirectorBackupIam
    IAM resource metadata
    id str
    Unique identifier of the VMware Cloud Director backup
    resource_status str
    Reflects the readiness of the VMware Cloud Director organization backup service
    target_spec GetCloudDirectorBackupTargetSpec
    VMware Cloud Director Backup target spec
    updated_at str
    Datetime when backup is modified
    backupId String
    Backup ID
    createdAt String
    Datetime when backup was enabled
    currentState Property Map
    VMware Cloud Director Backup service current state
    currentTasks List<Property Map>
    Asynchronous operations ongoing on the VMware Cloud Director organization backup service
    iam Property Map
    IAM resource metadata
    id String
    Unique identifier of the VMware Cloud Director backup
    resourceStatus String
    Reflects the readiness of the VMware Cloud Director organization backup service
    targetSpec Property Map
    VMware Cloud Director Backup target spec
    updatedAt String
    Datetime when backup is modified

    Supporting Types

    GetCloudDirectorBackupCurrentState

    AzName string
    Availability zone of VMware Cloud Director organization backup
    Offers List<GetCloudDirectorBackupCurrentStateOffer>
    List of your VMware Cloud Director organization backup offers
    AzName string
    Availability zone of VMware Cloud Director organization backup
    Offers []GetCloudDirectorBackupCurrentStateOffer
    List of your VMware Cloud Director organization backup offers
    azName String
    Availability zone of VMware Cloud Director organization backup
    offers List<GetCloudDirectorBackupCurrentStateOffer>
    List of your VMware Cloud Director organization backup offers
    azName string
    Availability zone of VMware Cloud Director organization backup
    offers GetCloudDirectorBackupCurrentStateOffer[]
    List of your VMware Cloud Director organization backup offers
    az_name str
    Availability zone of VMware Cloud Director organization backup
    offers Sequence[GetCloudDirectorBackupCurrentStateOffer]
    List of your VMware Cloud Director organization backup offers
    azName String
    Availability zone of VMware Cloud Director organization backup
    offers List<Property Map>
    List of your VMware Cloud Director organization backup offers

    GetCloudDirectorBackupCurrentStateOffer

    Name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    ProtectionPrimaryRegion string
    Backup repository primary region
    ProtectionReplicatedRegion string
    Backup repository replicated region
    QuotaInTb double
    Backup repository quota in TB
    Status string
    Backup offer status
    UsedSpaceInGb double
    Backup repository used space in GB
    Name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    ProtectionPrimaryRegion string
    Backup repository primary region
    ProtectionReplicatedRegion string
    Backup repository replicated region
    QuotaInTb float64
    Backup repository quota in TB
    Status string
    Backup offer status
    UsedSpaceInGb float64
    Backup repository used space in GB
    name String
    Backup service offer type (BRONZE|SILVER|GOLD)
    protectionPrimaryRegion String
    Backup repository primary region
    protectionReplicatedRegion String
    Backup repository replicated region
    quotaInTb Double
    Backup repository quota in TB
    status String
    Backup offer status
    usedSpaceInGb Double
    Backup repository used space in GB
    name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    protectionPrimaryRegion string
    Backup repository primary region
    protectionReplicatedRegion string
    Backup repository replicated region
    quotaInTb number
    Backup repository quota in TB
    status string
    Backup offer status
    usedSpaceInGb number
    Backup repository used space in GB
    name str
    Backup service offer type (BRONZE|SILVER|GOLD)
    protection_primary_region str
    Backup repository primary region
    protection_replicated_region str
    Backup repository replicated region
    quota_in_tb float
    Backup repository quota in TB
    status str
    Backup offer status
    used_space_in_gb float
    Backup repository used space in GB
    name String
    Backup service offer type (BRONZE|SILVER|GOLD)
    protectionPrimaryRegion String
    Backup repository primary region
    protectionReplicatedRegion String
    Backup repository replicated region
    quotaInTb Number
    Backup repository quota in TB
    status String
    Backup offer status
    usedSpaceInGb Number
    Backup repository used space in GB

    GetCloudDirectorBackupCurrentTask

    Id string
    Identifier of the current task
    Link string
    Link to the task details
    Status string
    Current global status of the current task
    Type string
    Type of the current task
    Id string
    Identifier of the current task
    Link string
    Link to the task details
    Status string
    Current global status of the current task
    Type string
    Type of the current task
    id String
    Identifier of the current task
    link String
    Link to the task details
    status String
    Current global status of the current task
    type String
    Type of the current task
    id string
    Identifier of the current task
    link string
    Link to the task details
    status string
    Current global status of the current task
    type string
    Type of the current task
    id str
    Identifier of the current task
    link str
    Link to the task details
    status str
    Current global status of the current task
    type str
    Type of the current task
    id String
    Identifier of the current task
    link String
    Link to the task details
    status String
    Current global status of the current task
    type String
    Type of the current task

    GetCloudDirectorBackupIam

    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags Dictionary<string, string>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags map[string]string
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String,String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies
    displayName string
    Resource display name
    id string
    Unique identifier of the resource
    tags {[key: string]: string}
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn string
    Unique resource name used in policies
    display_name str
    Resource display name
    id str
    Unique identifier of the resource
    tags Mapping[str, str]
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn str
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies

    GetCloudDirectorBackupTargetSpec

    Offers List<GetCloudDirectorBackupTargetSpecOffer>
    List of your VMware Cloud Director backup offers
    Offers []GetCloudDirectorBackupTargetSpecOffer
    List of your VMware Cloud Director backup offers
    offers List<GetCloudDirectorBackupTargetSpecOffer>
    List of your VMware Cloud Director backup offers
    offers GetCloudDirectorBackupTargetSpecOffer[]
    List of your VMware Cloud Director backup offers
    offers Sequence[GetCloudDirectorBackupTargetSpecOffer]
    List of your VMware Cloud Director backup offers
    offers List<Property Map>
    List of your VMware Cloud Director backup offers

    GetCloudDirectorBackupTargetSpecOffer

    Name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    QuotaInTb double
    Backup repository quota in TB
    Name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    QuotaInTb float64
    Backup repository quota in TB
    name String
    Backup service offer type (BRONZE|SILVER|GOLD)
    quotaInTb Double
    Backup repository quota in TB
    name string
    Backup service offer type (BRONZE|SILVER|GOLD)
    quotaInTb number
    Backup repository quota in TB
    name str
    Backup service offer type (BRONZE|SILVER|GOLD)
    quota_in_tb float
    Backup repository quota in TB
    name String
    Backup service offer type (BRONZE|SILVER|GOLD)
    quotaInTb Number
    Backup repository quota in TB

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh
      Try Pulumi Cloud free. Your team will thank you.