Azure v6.21.0, Mar 7 25

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.compute.RestorePoint

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-network
      addressSpaces:
        - 10.0.0.0/16
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: internal
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
  exampleNetworkInterface:
    type: azure:network:NetworkInterface
    name: example
    properties:
      name: example-nic
      location: ${example.location}
      resourceGroupName: ${example.name}
      ipConfigurations:
        - name: internal
          subnetId: ${exampleSubnet.id}
          privateIpAddressAllocation: Dynamic
  exampleLinuxVirtualMachine:
    type: azure:compute:LinuxVirtualMachine
    name: example
    properties:
      name: example-machine
      resourceGroupName: ${example.name}
      location: ${example.location}
      size: Standard_F2
      adminUsername: adminuser
      networkInterfaceIds:
        - ${exampleNetworkInterface.id}
      adminSshKeys:
        - username: adminuser
          publicKey:
            fn::invoke:
              function: std:file
              arguments:
                input: ~/.ssh/id_rsa.pub
              return: result
      osDisk:
        caching: ReadWrite
        storageAccountType: Standard_LRS
      sourceImageReference:
        publisher: Canonical
        offer: 0001-com-ubuntu-server-jammy
        sku: 22_04-lts
        version: latest
  exampleRestorePointCollection:
    type: azure:compute:RestorePointCollection
    name: example
    properties:
      name: example-collection
      resourceGroupName: ${example.name}
      location: ${exampleLinuxVirtualMachine.location}
      sourceVirtualMachineId: ${exampleLinuxVirtualMachine.id}
  exampleRestorePoint:
    type: azure:compute:RestorePoint
    name: example
    properties:
      name: example-restore-point
      restorePointCollectionId: ${test.id}

Create RestorePoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RestorePoint(name: string, args: RestorePointArgs, opts?: CustomResourceOptions);

@overload
def RestorePoint(resource_name: str,
                 args: RestorePointArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def RestorePoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 virtual_machine_restore_point_collection_id: Optional[str] = None,
                 crash_consistency_mode_enabled: Optional[bool] = None,
                 excluded_disks: Optional[Sequence[str]] = None,
                 name: Optional[str] = None)

func NewRestorePoint(ctx *Context, name string, args RestorePointArgs, opts ...ResourceOption) (*RestorePoint, error)

public RestorePoint(string name, RestorePointArgs args, CustomResourceOptions? opts = null)

public RestorePoint(String name, RestorePointArgs args)
public RestorePoint(String name, RestorePointArgs args, CustomResourceOptions options)

type: azure:compute:RestorePoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RestorePointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RestorePointArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RestorePointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RestorePointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RestorePointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var restorePointResource = new Azure.Compute.RestorePoint("restorePointResource", new()
{
    VirtualMachineRestorePointCollectionId = "string",
    CrashConsistencyModeEnabled = false,
    ExcludedDisks = new[]
    {
        "string",
    },
    Name = "string",
});

example, err := compute.NewRestorePoint(ctx, "restorePointResource", &compute.RestorePointArgs{
	VirtualMachineRestorePointCollectionId: pulumi.String("string"),
	CrashConsistencyModeEnabled:            pulumi.Bool(false),
	ExcludedDisks: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

var restorePointResource = new RestorePoint("restorePointResource", RestorePointArgs.builder()
    .virtualMachineRestorePointCollectionId("string")
    .crashConsistencyModeEnabled(false)
    .excludedDisks("string")
    .name("string")
    .build());

restore_point_resource = azure.compute.RestorePoint("restorePointResource",
    virtual_machine_restore_point_collection_id="string",
    crash_consistency_mode_enabled=False,
    excluded_disks=["string"],
    name="string")

const restorePointResource = new azure.compute.RestorePoint("restorePointResource", {
    virtualMachineRestorePointCollectionId: "string",
    crashConsistencyModeEnabled: false,
    excludedDisks: ["string"],
    name: "string",
});

type: azure:compute:RestorePoint
properties:
    crashConsistencyModeEnabled: false
    excludedDisks:
        - string
    name: string
    virtualMachineRestorePointCollectionId: string

RestorePoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RestorePoint resource accepts the following input properties:

VirtualMachineRestorePointCollectionId string
CrashConsistencyModeEnabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
ExcludedDisks List<string>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
Name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

VirtualMachineRestorePointCollectionId string
CrashConsistencyModeEnabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
ExcludedDisks []string: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
Name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

virtualMachineRestorePointCollectionId String
crashConsistencyModeEnabled Boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks List<String>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name String: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

virtualMachineRestorePointCollectionId string
crashConsistencyModeEnabled boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks string[]: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

virtual_machine_restore_point_collection_id str
crash_consistency_mode_enabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excluded_disks Sequence[str]: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name str: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

virtualMachineRestorePointCollectionId String
crashConsistencyModeEnabled Boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks List<String>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name String: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the RestorePoint resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing RestorePoint Resource

Get an existing RestorePoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RestorePointState, opts?: CustomResourceOptions): RestorePoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crash_consistency_mode_enabled: Optional[bool] = None,
        excluded_disks: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        virtual_machine_restore_point_collection_id: Optional[str] = None) -> RestorePoint

func GetRestorePoint(ctx *Context, name string, id IDInput, state *RestorePointState, opts ...ResourceOption) (*RestorePoint, error)

public static RestorePoint Get(string name, Input<string> id, RestorePointState? state, CustomResourceOptions? opts = null)

public static RestorePoint get(String name, Output<String> id, RestorePointState state, CustomResourceOptions options)

resources:  _:    type: azure:compute:RestorePoint    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CrashConsistencyModeEnabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
ExcludedDisks List<string>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
Name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
VirtualMachineRestorePointCollectionId string

CrashConsistencyModeEnabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
ExcludedDisks []string: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
Name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
VirtualMachineRestorePointCollectionId string

crashConsistencyModeEnabled Boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks List<String>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name String: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
virtualMachineRestorePointCollectionId String

crashConsistencyModeEnabled boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks string[]: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name string: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
virtualMachineRestorePointCollectionId string

crash_consistency_mode_enabled bool: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excluded_disks Sequence[str]: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name str: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
virtual_machine_restore_point_collection_id str

crashConsistencyModeEnabled Boolean: Is Crash Consistent the Consistency Mode of the Virtual Machine Restore Point. Defaults to false. Changing this forces a new resource to be created.
excludedDisks List<String>: A list of disks that will be excluded from the Virtual Machine Restore Point. Changing this forces a new resource to be created.
name String: Specifies the name of the Virtual Machine Restore Point. Changing this forces a new resource to be created.
virtualMachineRestorePointCollectionId String

Import

Virtual Machine Restore Point can be imported using the resource id, e.g.

$ pulumi import azure:compute/restorePoint:RestorePoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/restorePointCollections/collection1/restorePoints/restorePoint1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.compute.RestorePoint

On this page

On this page

Example Usage

Create RestorePoint Resource

Constructor syntax

Parameters

Constructor example

RestorePoint Resource Properties

Inputs

Outputs

Look up Existing RestorePoint Resource

Import

Package Details

On this page

On this page