azure-native.netapp.Backup
Explore with Pulumi AI
Backup under a Backup Vault
Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2022-11-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, 2024-09-01-preview, 2025-01-01, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native netapp [ApiVersion]
. See the version guide for details.
Example Usage
BackupsUnderBackupVault_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",
BackupVaultName = "backupVault1",
Label = "myLabel",
ResourceGroupName = "myRG",
VolumeResourceId = "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1",
});
});
package main
import (
netapp "github.com/pulumi/pulumi-azure-native-sdk/netapp/v3"
"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"),
BackupVaultName: pulumi.String("backupVault1"),
Label: pulumi.String("myLabel"),
ResourceGroupName: pulumi.String("myRG"),
VolumeResourceId: pulumi.String("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/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")
.backupVaultName("backupVault1")
.label("myLabel")
.resourceGroupName("myRG")
.volumeResourceId("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1")
.build());
}
}
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",
backupVaultName: "backupVault1",
label: "myLabel",
resourceGroupName: "myRG",
volumeResourceId: "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1",
});
import pulumi
import pulumi_azure_native as azure_native
backup = azure_native.netapp.Backup("backup",
account_name="account1",
backup_name="backup1",
backup_vault_name="backupVault1",
label="myLabel",
resource_group_name="myRG",
volume_resource_id="/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1")
resources:
backup:
type: azure-native:netapp:Backup
properties:
accountName: account1
backupName: backup1
backupVaultName: backupVault1
label: myLabel
resourceGroupName: myRG
volumeResourceId: /subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/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,
backup_vault_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
volume_resource_id: Optional[str] = None,
backup_name: Optional[str] = None,
label: Optional[str] = None,
snapshot_name: 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",
BackupVaultName = "string",
ResourceGroupName = "string",
VolumeResourceId = "string",
BackupName = "string",
Label = "string",
SnapshotName = "string",
UseExistingSnapshot = false,
});
example, err := netapp.NewBackup(ctx, "azure-nativeBackupResource", &netapp.BackupArgs{
AccountName: pulumi.String("string"),
BackupVaultName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
VolumeResourceId: pulumi.String("string"),
BackupName: pulumi.String("string"),
Label: pulumi.String("string"),
SnapshotName: pulumi.String("string"),
UseExistingSnapshot: pulumi.Bool(false),
})
var azure_nativeBackupResource = new com.pulumi.azurenative.netapp.Backup("azure-nativeBackupResource", com.pulumi.azurenative.netapp.BackupArgs.builder()
.accountName("string")
.backupVaultName("string")
.resourceGroupName("string")
.volumeResourceId("string")
.backupName("string")
.label("string")
.snapshotName("string")
.useExistingSnapshot(false)
.build());
azure_native_backup_resource = azure_native.netapp.Backup("azure-nativeBackupResource",
account_name="string",
backup_vault_name="string",
resource_group_name="string",
volume_resource_id="string",
backup_name="string",
label="string",
snapshot_name="string",
use_existing_snapshot=False)
const azure_nativeBackupResource = new azure_native.netapp.Backup("azure-nativeBackupResource", {
accountName: "string",
backupVaultName: "string",
resourceGroupName: "string",
volumeResourceId: "string",
backupName: "string",
label: "string",
snapshotName: "string",
useExistingSnapshot: false,
});
type: azure-native:netapp:Backup
properties:
accountName: string
backupName: string
backupVaultName: string
label: string
resourceGroupName: string
snapshotName: string
useExistingSnapshot: false
volumeResourceId: 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:
- Account
Name string - The name of the NetApp account
- Backup
Vault stringName - The name of the Backup Vault
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Volume
Resource stringId - ResourceId used to identify the Volume
- Backup
Name string - The name of the backup
- Label string
- Label for backup
- Snapshot
Name string - The name of the snapshot
- Use
Existing boolSnapshot - Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
- Account
Name string - The name of the NetApp account
- Backup
Vault stringName - The name of the Backup Vault
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Volume
Resource stringId - ResourceId used to identify the Volume
- Backup
Name string - The name of the backup
- Label string
- Label for backup
- Snapshot
Name string - The name of the snapshot
- Use
Existing boolSnapshot - Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
- account
Name String - The name of the NetApp account
- backup
Vault StringName - The name of the Backup Vault
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- volume
Resource StringId - ResourceId used to identify the Volume
- backup
Name String - The name of the backup
- label String
- Label for backup
- snapshot
Name String - The name of the snapshot
- use
Existing BooleanSnapshot - Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
- account
Name string - The name of the NetApp account
- backup
Vault stringName - The name of the Backup Vault
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- volume
Resource stringId - ResourceId used to identify the Volume
- backup
Name string - The name of the backup
- label string
- Label for backup
- snapshot
Name string - The name of the snapshot
- use
Existing booleanSnapshot - 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
- backup_
vault_ strname - The name of the Backup Vault
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- volume_
resource_ strid - ResourceId used to identify the Volume
- backup_
name str - The name of the backup
- label str
- Label for backup
- snapshot_
name str - The name of the snapshot
- use_
existing_ boolsnapshot - Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
- account
Name String - The name of the NetApp account
- backup
Vault StringName - The name of the Backup Vault
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- volume
Resource StringId - ResourceId used to identify the Volume
- backup
Name String - The name of the backup
- label String
- Label for backup
- snapshot
Name String - The name of the snapshot
- use
Existing BooleanSnapshot - 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- Backup
Id string - UUID v4 used to identify the Backup
- Backup
Policy stringResource Id - ResourceId used to identify the backup policy
- Backup
Type string - Type of backup Manual or Scheduled
- Creation
Date string - The creation date of the backup
- Failure
Reason string - Failure reason
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Azure lifecycle management
- Size double
- Size of backup in bytes
- System
Data Pulumi.Azure Native. Net App. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Backup
Id string - UUID v4 used to identify the Backup
- Backup
Policy stringResource Id - ResourceId used to identify the backup policy
- Backup
Type string - Type of backup Manual or Scheduled
- Creation
Date string - The creation date of the backup
- Failure
Reason string - Failure reason
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Azure lifecycle management
- Size float64
- Size of backup in bytes
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- backup
Id String - UUID v4 used to identify the Backup
- backup
Policy StringResource Id - ResourceId used to identify the backup policy
- backup
Type String - Type of backup Manual or Scheduled
- creation
Date String - The creation date of the backup
- failure
Reason String - Failure reason
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Azure lifecycle management
- size Double
- Size of backup in bytes
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- backup
Id string - UUID v4 used to identify the Backup
- backup
Policy stringResource Id - ResourceId used to identify the backup policy
- backup
Type string - Type of backup Manual or Scheduled
- creation
Date string - The creation date of the backup
- failure
Reason string - Failure reason
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - Azure lifecycle management
- size number
- Size of backup in bytes
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- backup_
id str - UUID v4 used to identify the Backup
- backup_
policy_ strresource_ id - ResourceId used to identify the backup policy
- 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 in bytes
- system_
data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- backup
Id String - UUID v4 used to identify the Backup
- backup
Policy StringResource Id - ResourceId used to identify the backup policy
- backup
Type String - Type of backup Manual or Scheduled
- creation
Date String - The creation date of the backup
- failure
Reason String - Failure reason
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Azure lifecycle management
- size Number
- Size of backup in bytes
- system
Data 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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/backupVault1/backup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/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