Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. CapacityPoolBackup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.netapp.CapacityPoolBackup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Backup of a Volume

Uses Azure REST API version 2022-11-01.

Example Usage

Backups_Create

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

return await Deployment.RunAsync(() => 
{
    var capacityPoolBackup = new AzureNative.NetApp.CapacityPoolBackup("capacityPoolBackup", new()
    {
        AccountName = "account1",
        BackupName = "backup1",
        Label = "myLabel",
        Location = "eastus",
        PoolName = "pool1",
        ResourceGroupName = "myRG",
        VolumeName = "volume1",
    });

});
Copy
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.NewCapacityPoolBackup(ctx, "capacityPoolBackup", &netapp.CapacityPoolBackupArgs{
			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
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.netapp.CapacityPoolBackup;
import com.pulumi.azurenative.netapp.CapacityPoolBackupArgs;
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 capacityPoolBackup = new CapacityPoolBackup("capacityPoolBackup", CapacityPoolBackupArgs.builder()
            .accountName("account1")
            .backupName("backup1")
            .label("myLabel")
            .location("eastus")
            .poolName("pool1")
            .resourceGroupName("myRG")
            .volumeName("volume1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const capacityPoolBackup = new azure_native.netapp.CapacityPoolBackup("capacityPoolBackup", {
    accountName: "account1",
    backupName: "backup1",
    label: "myLabel",
    location: "eastus",
    poolName: "pool1",
    resourceGroupName: "myRG",
    volumeName: "volume1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

capacity_pool_backup = azure_native.netapp.CapacityPoolBackup("capacityPoolBackup",
    account_name="account1",
    backup_name="backup1",
    label="myLabel",
    location="eastus",
    pool_name="pool1",
    resource_group_name="myRG",
    volume_name="volume1")
Copy
resources:
  capacityPoolBackup:
    type: azure-native:netapp:CapacityPoolBackup
    properties:
      accountName: account1
      backupName: backup1
      label: myLabel
      location: eastus
      poolName: pool1
      resourceGroupName: myRG
      volumeName: volume1
Copy

Create CapacityPoolBackup Resource

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

Constructor syntax

new CapacityPoolBackup(name: string, args: CapacityPoolBackupArgs, opts?: CustomResourceOptions);
@overload
def CapacityPoolBackup(resource_name: str,
                       args: CapacityPoolBackupArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def CapacityPoolBackup(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 NewCapacityPoolBackup(ctx *Context, name string, args CapacityPoolBackupArgs, opts ...ResourceOption) (*CapacityPoolBackup, error)
public CapacityPoolBackup(string name, CapacityPoolBackupArgs args, CustomResourceOptions? opts = null)
public CapacityPoolBackup(String name, CapacityPoolBackupArgs args)
public CapacityPoolBackup(String name, CapacityPoolBackupArgs args, CustomResourceOptions options)

type: azure-native:netapp:CapacityPoolBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CapacityPoolBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CapacityPoolBackupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityPoolBackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityPoolBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CapacityPoolBackupArgs
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 capacityPoolBackupResource = new AzureNative.NetApp.CapacityPoolBackup("capacityPoolBackupResource", new()
{
    AccountName = "string",
    PoolName = "string",
    ResourceGroupName = "string",
    VolumeName = "string",
    BackupName = "string",
    Label = "string",
    Location = "string",
    UseExistingSnapshot = false,
});
Copy
example, err := netapp.NewCapacityPoolBackup(ctx, "capacityPoolBackupResource", &netapp.CapacityPoolBackupArgs{
	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),
})
Copy
var capacityPoolBackupResource = new CapacityPoolBackup("capacityPoolBackupResource", CapacityPoolBackupArgs.builder()
    .accountName("string")
    .poolName("string")
    .resourceGroupName("string")
    .volumeName("string")
    .backupName("string")
    .label("string")
    .location("string")
    .useExistingSnapshot(false)
    .build());
Copy
capacity_pool_backup_resource = azure_native.netapp.CapacityPoolBackup("capacityPoolBackupResource",
    account_name="string",
    pool_name="string",
    resource_group_name="string",
    volume_name="string",
    backup_name="string",
    label="string",
    location="string",
    use_existing_snapshot=False)
Copy
const capacityPoolBackupResource = new azure_native.netapp.CapacityPoolBackup("capacityPoolBackupResource", {
    accountName: "string",
    poolName: "string",
    resourceGroupName: "string",
    volumeName: "string",
    backupName: "string",
    label: "string",
    location: "string",
    useExistingSnapshot: false,
});
Copy
type: azure-native:netapp:CapacityPoolBackup
properties:
    accountName: string
    backupName: string
    label: string
    location: string
    poolName: string
    resourceGroupName: string
    useExistingSnapshot: false
    volumeName: string
Copy

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

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
PoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
BackupName Changes to this property will trigger replacement. string
The name of the backup
Label string
Label for backup
Location Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
PoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
BackupName Changes to this property will trigger replacement. string
The name of the backup
Label string
Label for backup
Location Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume
backupName Changes to this property will trigger replacement. String
The name of the backup
label String
Label for backup
location Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
backupName Changes to this property will trigger replacement. string
The name of the backup
label string
Label for backup
location Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
str
The name of the NetApp account
pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the capacity pool
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
volume_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the volume
backup_name Changes to this property will trigger replacement. str
The name of the backup
label str
Label for backup
location Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume
backupName Changes to this property will trigger replacement. String
The name of the backup
label String
Label for backup
location Changes to this property will trigger replacement. 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 CapacityPoolBackup resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
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"
AzureApiVersion string
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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"
azureApiVersion string
The Azure API version of the resource.
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"
azure_api_version str
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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:CapacityPoolBackup account1/pool1/volume1/backup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native