1. Packages
  2. OVH
  3. API Docs
  4. VMware
  5. getCloudDirectorBackup
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

ovh.VMware.getCloudDirectorBackup

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

Get information about a VMware Cloud Director Backup service

Example Usage

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

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

backup = ovh.VMware.get_cloud_director_backup(backup_id="<VCD backup ID>")
Copy
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
	})
}
Copy
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>",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func GetCloudDirectorBackup(ctx *Context, args *GetCloudDirectorBackupArgs, opts ...InvokeOption) (*GetCloudDirectorBackupResult, error)
func GetCloudDirectorBackupOutput(ctx *Context, args *GetCloudDirectorBackupOutputArgs, opts ...InvokeOption) GetCloudDirectorBackupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetCloudDirectorBackupResult> getCloudDirectorBackup(GetCloudDirectorBackupArgs args, InvokeOptions options)
public static Output<GetCloudDirectorBackupResult> getCloudDirectorBackup(GetCloudDirectorBackupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ovh:VMware/getCloudDirectorBackup:getCloudDirectorBackup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupId This property is required. string
Backup ID
BackupId This property is required. string
Backup ID
backupId This property is required. String
Backup ID
backupId This property is required. string
Backup ID
backup_id This property is required. str
Backup ID
backupId This property is required. 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 vmware.GetCloudDirectorBackupCurrentState
VMware Cloud Director Backup service current state
current_tasks Sequence[vmware.GetCloudDirectorBackupCurrentTask]
Asynchronous operations ongoing on the VMware Cloud Director organization backup service
iam vmware.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 vmware.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 This property is required. string
Availability zone of VMware Cloud Director organization backup
Offers This property is required. List<GetCloudDirectorBackupCurrentStateOffer>
List of your VMware Cloud Director organization backup offers
AzName This property is required. string
Availability zone of VMware Cloud Director organization backup
Offers This property is required. []GetCloudDirectorBackupCurrentStateOffer
List of your VMware Cloud Director organization backup offers
azName This property is required. String
Availability zone of VMware Cloud Director organization backup
offers This property is required. List<GetCloudDirectorBackupCurrentStateOffer>
List of your VMware Cloud Director organization backup offers
azName This property is required. string
Availability zone of VMware Cloud Director organization backup
offers This property is required. GetCloudDirectorBackupCurrentStateOffer[]
List of your VMware Cloud Director organization backup offers
az_name This property is required. str
Availability zone of VMware Cloud Director organization backup
offers This property is required. Sequence[vmware.GetCloudDirectorBackupCurrentStateOffer]
List of your VMware Cloud Director organization backup offers
azName This property is required. String
Availability zone of VMware Cloud Director organization backup
offers This property is required. List<Property Map>
List of your VMware Cloud Director organization backup offers

GetCloudDirectorBackupCurrentStateOffer

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

GetCloudDirectorBackupCurrentTask

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

GetCloudDirectorBackupIam

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

GetCloudDirectorBackupTargetSpec

Offers This property is required. List<GetCloudDirectorBackupTargetSpecOffer>
List of your VMware Cloud Director backup offers
Offers This property is required. []GetCloudDirectorBackupTargetSpecOffer
List of your VMware Cloud Director backup offers
offers This property is required. List<GetCloudDirectorBackupTargetSpecOffer>
List of your VMware Cloud Director backup offers
offers This property is required. GetCloudDirectorBackupTargetSpecOffer[]
List of your VMware Cloud Director backup offers
offers This property is required. Sequence[vmware.GetCloudDirectorBackupTargetSpecOffer]
List of your VMware Cloud Director backup offers
offers This property is required. List<Property Map>
List of your VMware Cloud Director backup offers

GetCloudDirectorBackupTargetSpecOffer

Name This property is required. string
Backup service offer type (BRONZE|SILVER|GOLD)
QuotaInTb This property is required. double
Backup repository quota in TB
Name This property is required. string
Backup service offer type (BRONZE|SILVER|GOLD)
QuotaInTb This property is required. float64
Backup repository quota in TB
name This property is required. String
Backup service offer type (BRONZE|SILVER|GOLD)
quotaInTb This property is required. Double
Backup repository quota in TB
name This property is required. string
Backup service offer type (BRONZE|SILVER|GOLD)
quotaInTb This property is required. number
Backup repository quota in TB
name This property is required. str
Backup service offer type (BRONZE|SILVER|GOLD)
quota_in_tb This property is required. float
Backup repository quota in TB
name This property is required. String
Backup service offer type (BRONZE|SILVER|GOLD)
quotaInTb This property is required. 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.
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud