Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getVmRecoveryPointInfoV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getVmRecoveryPointInfoV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Get a single recovery point corresponding to the extId.

    Example Usage

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

const example = nutanix.getVmRecoveryPointInfoV2({
    extId: "<vm_recovery_point_uuid>",
    recoveryPointExtId: "<recovery_point_uuid>",
});

    import pulumi
import pulumi_nutanix as nutanix

example = nutanix.get_vm_recovery_point_info_v2(ext_id="<vm_recovery_point_uuid>",
    recovery_point_ext_id="<recovery_point_uuid>")

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.GetVmRecoveryPointInfoV2(ctx, &nutanix.GetVmRecoveryPointInfoV2Args{
			ExtId:              "<vm_recovery_point_uuid>",
			RecoveryPointExtId: "<recovery_point_uuid>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Nutanix.GetVmRecoveryPointInfoV2.Invoke(new()
    {
        ExtId = "<vm_recovery_point_uuid>",
        RecoveryPointExtId = "<recovery_point_uuid>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetVmRecoveryPointInfoV2Args;
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 example = NutanixFunctions.getVmRecoveryPointInfoV2(GetVmRecoveryPointInfoV2Args.builder()
            .extId("<vm_recovery_point_uuid>")
            .recoveryPointExtId("<recovery_point_uuid>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: nutanix:getVmRecoveryPointInfoV2
      arguments:
        extId: <vm_recovery_point_uuid>
        recoveryPointExtId: <recovery_point_uuid>

    Using getVmRecoveryPointInfoV2

    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 getVmRecoveryPointInfoV2(args: GetVmRecoveryPointInfoV2Args, opts?: InvokeOptions): Promise<GetVmRecoveryPointInfoV2Result>
function getVmRecoveryPointInfoV2Output(args: GetVmRecoveryPointInfoV2OutputArgs, opts?: InvokeOptions): Output<GetVmRecoveryPointInfoV2Result>
    def get_vm_recovery_point_info_v2(disk_recovery_points: Optional[Sequence[GetVmRecoveryPointInfoV2DiskRecoveryPoint]] = None,
                                  ext_id: Optional[str] = None,
                                  recovery_point_ext_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetVmRecoveryPointInfoV2Result
def get_vm_recovery_point_info_v2_output(disk_recovery_points: Optional[pulumi.Input[Sequence[pulumi.Input[GetVmRecoveryPointInfoV2DiskRecoveryPointArgs]]]] = None,
                                  ext_id: Optional[pulumi.Input[str]] = None,
                                  recovery_point_ext_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetVmRecoveryPointInfoV2Result]
    func GetVmRecoveryPointInfoV2(ctx *Context, args *GetVmRecoveryPointInfoV2Args, opts ...InvokeOption) (*GetVmRecoveryPointInfoV2Result, error)
func GetVmRecoveryPointInfoV2Output(ctx *Context, args *GetVmRecoveryPointInfoV2OutputArgs, opts ...InvokeOption) GetVmRecoveryPointInfoV2ResultOutput

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

    public static class GetVmRecoveryPointInfoV2 
{
    public static Task<GetVmRecoveryPointInfoV2Result> InvokeAsync(GetVmRecoveryPointInfoV2Args args, InvokeOptions? opts = null)
    public static Output<GetVmRecoveryPointInfoV2Result> Invoke(GetVmRecoveryPointInfoV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVmRecoveryPointInfoV2Result> getVmRecoveryPointInfoV2(GetVmRecoveryPointInfoV2Args args, InvokeOptions options)
public static Output<GetVmRecoveryPointInfoV2Result> getVmRecoveryPointInfoV2(GetVmRecoveryPointInfoV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getVmRecoveryPointInfoV2:getVmRecoveryPointInfoV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ExtId string
    The external identifier that can be used to identify a VM recovery point.
    RecoveryPointExtId string
    DiskRecoveryPoints List<PiersKarsenbarg.Nutanix.Inputs.GetVmRecoveryPointInfoV2DiskRecoveryPoint>
    array of disk recovery points.
    ExtId string
    The external identifier that can be used to identify a VM recovery point.
    RecoveryPointExtId string
    DiskRecoveryPoints []GetVmRecoveryPointInfoV2DiskRecoveryPoint
    array of disk recovery points.
    extId String
    The external identifier that can be used to identify a VM recovery point.
    recoveryPointExtId String
    diskRecoveryPoints List<GetVmRecoveryPointInfoV2DiskRecoveryPoint>
    array of disk recovery points.
    extId string
    The external identifier that can be used to identify a VM recovery point.
    recoveryPointExtId string
    diskRecoveryPoints GetVmRecoveryPointInfoV2DiskRecoveryPoint[]
    array of disk recovery points.
    ext_id str
    The external identifier that can be used to identify a VM recovery point.
    recovery_point_ext_id str
    disk_recovery_points Sequence[GetVmRecoveryPointInfoV2DiskRecoveryPoint]
    array of disk recovery points.
    extId String
    The external identifier that can be used to identify a VM recovery point.
    recoveryPointExtId String
    diskRecoveryPoints List<Property Map>
    array of disk recovery points.

    getVmRecoveryPointInfoV2 Result

    The following output properties are available:

    ApplicationConsistentProperties List<PiersKarsenbarg.Nutanix.Outputs.GetVmRecoveryPointInfoV2ApplicationConsistentProperty>
    User-defined application-consistent properties for the recovery point. *
    ConsistencyGroupExtId string
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    DiskRecoveryPoints List<PiersKarsenbarg.Nutanix.Outputs.GetVmRecoveryPointInfoV2DiskRecoveryPoint>
    array of disk recovery points.
    ExtId string
    recovery point UUID
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetVmRecoveryPointInfoV2Link>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    LocationAgnosticId string
    Location agnostic identifier of the Recovery point.
    RecoveryPointExtId string
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity
    VmCategories List<string>
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    VmExtId string
    VM external identifier which is captured as a part of this recovery point.
    ApplicationConsistentProperties []GetVmRecoveryPointInfoV2ApplicationConsistentProperty
    User-defined application-consistent properties for the recovery point. *
    ConsistencyGroupExtId string
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    DiskRecoveryPoints []GetVmRecoveryPointInfoV2DiskRecoveryPoint
    array of disk recovery points.
    ExtId string
    recovery point UUID
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []GetVmRecoveryPointInfoV2Link
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    LocationAgnosticId string
    Location agnostic identifier of the Recovery point.
    RecoveryPointExtId string
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity
    VmCategories []string
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    VmExtId string
    VM external identifier which is captured as a part of this recovery point.
    applicationConsistentProperties List<GetVmRecoveryPointInfoV2ApplicationConsistentProperty>
    User-defined application-consistent properties for the recovery point. *
    consistencyGroupExtId String
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    diskRecoveryPoints List<GetVmRecoveryPointInfoV2DiskRecoveryPoint>
    array of disk recovery points.
    extId String
    recovery point UUID
    id String
    The provider-assigned unique ID for this managed resource.
    links List<GetVmRecoveryPointInfoV2Link>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locationAgnosticId String
    Location agnostic identifier of the Recovery point.
    recoveryPointExtId String
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity
    vmCategories List<String>
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    vmExtId String
    VM external identifier which is captured as a part of this recovery point.
    applicationConsistentProperties GetVmRecoveryPointInfoV2ApplicationConsistentProperty[]
    User-defined application-consistent properties for the recovery point. *
    consistencyGroupExtId string
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    diskRecoveryPoints GetVmRecoveryPointInfoV2DiskRecoveryPoint[]
    array of disk recovery points.
    extId string
    recovery point UUID
    id string
    The provider-assigned unique ID for this managed resource.
    links GetVmRecoveryPointInfoV2Link[]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locationAgnosticId string
    Location agnostic identifier of the Recovery point.
    recoveryPointExtId string
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity
    vmCategories string[]
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    vmExtId string
    VM external identifier which is captured as a part of this recovery point.
    application_consistent_properties Sequence[GetVmRecoveryPointInfoV2ApplicationConsistentProperty]
    User-defined application-consistent properties for the recovery point. *
    consistency_group_ext_id str
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    disk_recovery_points Sequence[GetVmRecoveryPointInfoV2DiskRecoveryPoint]
    array of disk recovery points.
    ext_id str
    recovery point UUID
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[GetVmRecoveryPointInfoV2Link]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    location_agnostic_id str
    Location agnostic identifier of the Recovery point.
    recovery_point_ext_id str
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity
    vm_categories Sequence[str]
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    vm_ext_id str
    VM external identifier which is captured as a part of this recovery point.
    applicationConsistentProperties List<Property Map>
    User-defined application-consistent properties for the recovery point. *
    consistencyGroupExtId String
    External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
    diskRecoveryPoints List<Property Map>
    array of disk recovery points.
    extId String
    recovery point UUID
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locationAgnosticId String
    Location agnostic identifier of the Recovery point.
    recoveryPointExtId String
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity
    vmCategories List<String>
    Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
    vmExtId String
    VM external identifier which is captured as a part of this recovery point.

    Supporting Types

    GetVmRecoveryPointInfoV2ApplicationConsistentProperty

    BackupType string
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    ObjectType string
    value: dataprotection.v4.common.VssProperties
    ShouldIncludeWriters bool
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    ShouldStoreVssMetadata bool
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    Writers List<string>
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
    BackupType string
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    ObjectType string
    value: dataprotection.v4.common.VssProperties
    ShouldIncludeWriters bool
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    ShouldStoreVssMetadata bool
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    Writers []string
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
    backupType String
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    objectType String
    value: dataprotection.v4.common.VssProperties
    shouldIncludeWriters Boolean
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    shouldStoreVssMetadata Boolean
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    writers List<String>
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
    backupType string
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    objectType string
    value: dataprotection.v4.common.VssProperties
    shouldIncludeWriters boolean
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    shouldStoreVssMetadata boolean
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    writers string[]
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
    backup_type str
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    object_type str
    value: dataprotection.v4.common.VssProperties
    should_include_writers bool
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    should_store_vss_metadata bool
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    writers Sequence[str]
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
    backupType String
    The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:

    • supported values:
    • FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
    • COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
    objectType String
    value: dataprotection.v4.common.VssProperties
    shouldIncludeWriters Boolean
    Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
    shouldStoreVssMetadata Boolean
    Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
    writers List<String>
    List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.

    GetVmRecoveryPointInfoV2DiskRecoveryPoint

    DiskExtId string
    External identifier of the disk.
    DiskRecoveryPointExtId string
    External identifier of the disk recovery point.
    DiskExtId string
    External identifier of the disk.
    DiskRecoveryPointExtId string
    External identifier of the disk recovery point.
    diskExtId String
    External identifier of the disk.
    diskRecoveryPointExtId String
    External identifier of the disk recovery point.
    diskExtId string
    External identifier of the disk.
    diskRecoveryPointExtId string
    External identifier of the disk recovery point.
    disk_ext_id str
    External identifier of the disk.
    disk_recovery_point_ext_id str
    External identifier of the disk recovery point.
    diskExtId String
    External identifier of the disk.
    diskRecoveryPointExtId String
    External identifier of the disk recovery point.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href string
    • The URL at which the entity described by the link can be accessed.
    rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href str
    • The URL at which the entity described by the link can be accessed.
    rel str
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix