Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getCapacityPoolBackup
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.getCapacityPoolBackup

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

Gets the specified backup of the volume

Uses Azure REST API version 2022-11-01.

Using getCapacityPoolBackup

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 getCapacityPoolBackup(args: GetCapacityPoolBackupArgs, opts?: InvokeOptions): Promise<GetCapacityPoolBackupResult>
function getCapacityPoolBackupOutput(args: GetCapacityPoolBackupOutputArgs, opts?: InvokeOptions): Output<GetCapacityPoolBackupResult>
Copy
def get_capacity_pool_backup(account_name: Optional[str] = None,
                             backup_name: Optional[str] = None,
                             pool_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             volume_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCapacityPoolBackupResult
def get_capacity_pool_backup_output(account_name: Optional[pulumi.Input[str]] = None,
                             backup_name: Optional[pulumi.Input[str]] = None,
                             pool_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             volume_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCapacityPoolBackupResult]
Copy
func LookupCapacityPoolBackup(ctx *Context, args *LookupCapacityPoolBackupArgs, opts ...InvokeOption) (*LookupCapacityPoolBackupResult, error)
func LookupCapacityPoolBackupOutput(ctx *Context, args *LookupCapacityPoolBackupOutputArgs, opts ...InvokeOption) LookupCapacityPoolBackupResultOutput
Copy

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

public static class GetCapacityPoolBackup 
{
    public static Task<GetCapacityPoolBackupResult> InvokeAsync(GetCapacityPoolBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetCapacityPoolBackupResult> Invoke(GetCapacityPoolBackupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCapacityPoolBackupResult> getCapacityPoolBackup(GetCapacityPoolBackupArgs args, InvokeOptions options)
public static Output<GetCapacityPoolBackupResult> getCapacityPoolBackup(GetCapacityPoolBackupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:netapp:getCapacityPoolBackup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
BackupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup
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
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
BackupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup
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
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
backupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup
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
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
backupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup
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
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NetApp account
backup_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the backup
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
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
backupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup
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

getCapacityPoolBackup Result

The following output properties are available:

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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
Resource location
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"
VolumeName string
Volume name
Label string
Label for backup
UseExistingSnapshot bool
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
Resource location
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"
VolumeName string
Volume name
Label string
Label for backup
UseExistingSnapshot bool
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
Resource location
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"
volumeName String
Volume name
label String
Label for backup
useExistingSnapshot Boolean
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
Resource location
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"
volumeName string
Volume name
label string
Label for backup
useExistingSnapshot boolean
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
Resource location
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"
volume_name str
Volume name
label str
Label for backup
use_existing_snapshot bool
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
Resource location
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"
volumeName String
Volume name
label String
Label for backup
useExistingSnapshot Boolean
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups

Supporting Types

SystemDataResponse

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.

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