1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. Backup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.netapp.Backup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Backup of a Volume Azure REST API version: 2022-11-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2022-11-01-preview, 2023-05-01-preview, 2023-07-01-preview, 2023-11-01, 2023-11-01-preview, 2024-01-01, 2024-03-01, 2024-03-01-preview, 2024-05-01, 2024-05-01-preview, 2024-07-01, 2024-07-01-preview.

    Example Usage

    Backups_Create

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var backup = new AzureNative.NetApp.Backup("backup", new()
        {
            AccountName = "account1",
            BackupName = "backup1",
            Label = "myLabel",
            Location = "eastus",
            PoolName = "pool1",
            ResourceGroupName = "myRG",
            VolumeName = "volume1",
        });
    
    });
    
    package main
    
    import (
    	netapp "github.com/pulumi/pulumi-azure-native-sdk/netapp/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netapp.NewBackup(ctx, "backup", &netapp.BackupArgs{
    			AccountName:       pulumi.String("account1"),
    			BackupName:        pulumi.String("backup1"),
    			Label:             pulumi.String("myLabel"),
    			Location:          pulumi.String("eastus"),
    			PoolName:          pulumi.String("pool1"),
    			ResourceGroupName: pulumi.String("myRG"),
    			VolumeName:        pulumi.String("volume1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.netapp.Backup;
    import com.pulumi.azurenative.netapp.BackupArgs;
    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) {
            var backup = new Backup("backup", BackupArgs.builder()
                .accountName("account1")
                .backupName("backup1")
                .label("myLabel")
                .location("eastus")
                .poolName("pool1")
                .resourceGroupName("myRG")
                .volumeName("volume1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    backup = azure_native.netapp.Backup("backup",
        account_name="account1",
        backup_name="backup1",
        label="myLabel",
        location="eastus",
        pool_name="pool1",
        resource_group_name="myRG",
        volume_name="volume1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const backup = new azure_native.netapp.Backup("backup", {
        accountName: "account1",
        backupName: "backup1",
        label: "myLabel",
        location: "eastus",
        poolName: "pool1",
        resourceGroupName: "myRG",
        volumeName: "volume1",
    });
    
    resources:
      backup:
        type: azure-native:netapp:Backup
        properties:
          accountName: account1
          backupName: backup1
          label: myLabel
          location: eastus
          poolName: pool1
          resourceGroupName: myRG
          volumeName: volume1
    

    Create Backup Resource

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

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
    def Backup(resource_name: str,
               args: BackupArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               account_name: Optional[str] = None,
               pool_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               volume_name: Optional[str] = None,
               backup_name: Optional[str] = None,
               label: Optional[str] = None,
               location: Optional[str] = None,
               use_existing_snapshot: Optional[bool] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
    public Backup(String name, BackupArgs args, CustomResourceOptions options)
    
    type: azure-native:netapp:Backup
    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 BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 azure_nativeBackupResource = new AzureNative.NetApp.Backup("azure-nativeBackupResource", new()
    {
        AccountName = "string",
        PoolName = "string",
        ResourceGroupName = "string",
        VolumeName = "string",
        BackupName = "string",
        Label = "string",
        Location = "string",
        UseExistingSnapshot = false,
    });
    
    example, err := netapp.NewBackup(ctx, "azure-nativeBackupResource", &netapp.BackupArgs{
    	AccountName:         pulumi.String("string"),
    	PoolName:            pulumi.String("string"),
    	ResourceGroupName:   pulumi.String("string"),
    	VolumeName:          pulumi.String("string"),
    	BackupName:          pulumi.String("string"),
    	Label:               pulumi.String("string"),
    	Location:            pulumi.String("string"),
    	UseExistingSnapshot: pulumi.Bool(false),
    })
    
    var azure_nativeBackupResource = new Backup("azure-nativeBackupResource", BackupArgs.builder()
        .accountName("string")
        .poolName("string")
        .resourceGroupName("string")
        .volumeName("string")
        .backupName("string")
        .label("string")
        .location("string")
        .useExistingSnapshot(false)
        .build());
    
    azure_native_backup_resource = azure_native.netapp.Backup("azure-nativeBackupResource",
        account_name="string",
        pool_name="string",
        resource_group_name="string",
        volume_name="string",
        backup_name="string",
        label="string",
        location="string",
        use_existing_snapshot=False)
    
    const azure_nativeBackupResource = new azure_native.netapp.Backup("azure-nativeBackupResource", {
        accountName: "string",
        poolName: "string",
        resourceGroupName: "string",
        volumeName: "string",
        backupName: "string",
        label: "string",
        location: "string",
        useExistingSnapshot: false,
    });
    
    type: azure-native:netapp:Backup
    properties:
        accountName: string
        backupName: string
        label: string
        location: string
        poolName: string
        resourceGroupName: string
        useExistingSnapshot: false
        volumeName: string
    

    Backup 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 Backup resource accepts the following input properties:

    AccountName string
    The name of the NetApp account
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume
    BackupName string
    The name of the backup
    Label string
    Label for backup
    Location string
    Resource location
    UseExistingSnapshot bool
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
    AccountName string
    The name of the NetApp account
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume
    BackupName string
    The name of the backup
    Label string
    Label for backup
    Location string
    Resource location
    UseExistingSnapshot bool
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
    accountName String
    The name of the NetApp account
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume
    backupName String
    The name of the backup
    label String
    Label for backup
    location String
    Resource location
    useExistingSnapshot Boolean
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
    accountName string
    The name of the NetApp account
    poolName string
    The name of the capacity pool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    volumeName string
    The name of the volume
    backupName string
    The name of the backup
    label string
    Label for backup
    location string
    Resource location
    useExistingSnapshot boolean
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
    account_name str
    The name of the NetApp account
    pool_name str
    The name of the capacity pool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    volume_name str
    The name of the volume
    backup_name str
    The name of the backup
    label str
    Label for backup
    location str
    Resource location
    use_existing_snapshot bool
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
    accountName String
    The name of the NetApp account
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume
    backupName String
    The name of the backup
    label String
    Label for backup
    location String
    Resource location
    useExistingSnapshot Boolean
    Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups

    Outputs

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

    BackupId string
    UUID v4 used to identify the Backup
    BackupType string
    Type of backup Manual or Scheduled
    CreationDate string
    The creation date of the backup
    FailureReason string
    Failure reason
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Azure lifecycle management
    Size double
    Size of backup
    SystemData Pulumi.AzureNative.NetApp.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    BackupId string
    UUID v4 used to identify the Backup
    BackupType string
    Type of backup Manual or Scheduled
    CreationDate string
    The creation date of the backup
    FailureReason string
    Failure reason
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Azure lifecycle management
    Size float64
    Size of backup
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    backupId String
    UUID v4 used to identify the Backup
    backupType String
    Type of backup Manual or Scheduled
    creationDate String
    The creation date of the backup
    failureReason String
    Failure reason
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Azure lifecycle management
    size Double
    Size of backup
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    backupId string
    UUID v4 used to identify the Backup
    backupType string
    Type of backup Manual or Scheduled
    creationDate string
    The creation date of the backup
    failureReason string
    Failure reason
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    Azure lifecycle management
    size number
    Size of backup
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    backup_id str
    UUID v4 used to identify the Backup
    backup_type str
    Type of backup Manual or Scheduled
    creation_date str
    The creation date of the backup
    failure_reason str
    Failure reason
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    Azure lifecycle management
    size float
    Size of backup
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    backupId String
    UUID v4 used to identify the Backup
    backupType String
    Type of backup Manual or Scheduled
    creationDate String
    The creation date of the backup
    failureReason String
    Failure reason
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Azure lifecycle management
    size Number
    Size of backup
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:netapp:Backup account1/pool1/volume1/backup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi