Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getBackupPolicy
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.netapp.getBackupPolicy

Explore with Pulumi AI

azure-native logo
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a particular backup Policy

    Uses Azure REST API version 2024-09-01.

    Other available API versions: 2022-11-01, 2022-11-01-preview, 2023-05-01, 2023-05-01-preview, 2023-07-01, 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.

    Using getBackupPolicy

    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 getBackupPolicy(args: GetBackupPolicyArgs, opts?: InvokeOptions): Promise<GetBackupPolicyResult>
function getBackupPolicyOutput(args: GetBackupPolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupPolicyResult>
    def get_backup_policy(account_name: Optional[str] = None,
                      backup_policy_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBackupPolicyResult
def get_backup_policy_output(account_name: Optional[pulumi.Input[str]] = None,
                      backup_policy_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBackupPolicyResult]
    func LookupBackupPolicy(ctx *Context, args *LookupBackupPolicyArgs, opts ...InvokeOption) (*LookupBackupPolicyResult, error)
func LookupBackupPolicyOutput(ctx *Context, args *LookupBackupPolicyOutputArgs, opts ...InvokeOption) LookupBackupPolicyResultOutput

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

    public static class GetBackupPolicy 
{
    public static Task<GetBackupPolicyResult> InvokeAsync(GetBackupPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupPolicyResult> Invoke(GetBackupPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
public static Output<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:netapp:getBackupPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the NetApp account
    BackupPolicyName string
    Backup policy Name which uniquely identify backup policy.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of the NetApp account
    BackupPolicyName string
    Backup policy Name which uniquely identify backup policy.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the NetApp account
    backupPolicyName String
    Backup policy Name which uniquely identify backup policy.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of the NetApp account
    backupPolicyName string
    Backup policy Name which uniquely identify backup policy.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of the NetApp account
    backup_policy_name str
    Backup policy Name which uniquely identify backup policy.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the NetApp account
    backupPolicyName String
    Backup policy Name which uniquely identify backup policy.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBackupPolicy Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    BackupPolicyId string
    Backup Policy GUID ID
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Azure lifecycle management
    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"
    VolumeBackups List<Pulumi.AzureNative.NetApp.Outputs.VolumeBackupsResponse>
    A list of volumes assigned to this policy
    VolumesAssigned int
    Volumes using current backup policy
    DailyBackupsToKeep int
    Daily backups count to keep
    Enabled bool
    The property to decide policy is enabled or not
    MonthlyBackupsToKeep int
    Monthly backups count to keep
    Tags Dictionary<string, string>
    Resource tags.
    WeeklyBackupsToKeep int
    Weekly backups count to keep
    AzureApiVersion string
    The Azure API version of the resource.
    BackupPolicyId string
    Backup Policy GUID ID
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Azure lifecycle management
    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"
    VolumeBackups []VolumeBackupsResponse
    A list of volumes assigned to this policy
    VolumesAssigned int
    Volumes using current backup policy
    DailyBackupsToKeep int
    Daily backups count to keep
    Enabled bool
    The property to decide policy is enabled or not
    MonthlyBackupsToKeep int
    Monthly backups count to keep
    Tags map[string]string
    Resource tags.
    WeeklyBackupsToKeep int
    Weekly backups count to keep
    azureApiVersion String
    The Azure API version of the resource.
    backupPolicyId String
    Backup Policy GUID ID
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Azure lifecycle management
    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"
    volumeBackups List<VolumeBackupsResponse>
    A list of volumes assigned to this policy
    volumesAssigned Integer
    Volumes using current backup policy
    dailyBackupsToKeep Integer
    Daily backups count to keep
    enabled Boolean
    The property to decide policy is enabled or not
    monthlyBackupsToKeep Integer
    Monthly backups count to keep
    tags Map<String,String>
    Resource tags.
    weeklyBackupsToKeep Integer
    Weekly backups count to keep
    azureApiVersion string
    The Azure API version of the resource.
    backupPolicyId string
    Backup Policy GUID ID
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Azure lifecycle management
    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"
    volumeBackups VolumeBackupsResponse[]
    A list of volumes assigned to this policy
    volumesAssigned number
    Volumes using current backup policy
    dailyBackupsToKeep number
    Daily backups count to keep
    enabled boolean
    The property to decide policy is enabled or not
    monthlyBackupsToKeep number
    Monthly backups count to keep
    tags {[key: string]: string}
    Resource tags.
    weeklyBackupsToKeep number
    Weekly backups count to keep
    azure_api_version str
    The Azure API version of the resource.
    backup_policy_id str
    Backup Policy GUID ID
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Azure lifecycle management
    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_backups Sequence[VolumeBackupsResponse]
    A list of volumes assigned to this policy
    volumes_assigned int
    Volumes using current backup policy
    daily_backups_to_keep int
    Daily backups count to keep
    enabled bool
    The property to decide policy is enabled or not
    monthly_backups_to_keep int
    Monthly backups count to keep
    tags Mapping[str, str]
    Resource tags.
    weekly_backups_to_keep int
    Weekly backups count to keep
    azureApiVersion String
    The Azure API version of the resource.
    backupPolicyId String
    Backup Policy GUID ID
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Azure lifecycle management
    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"
    volumeBackups List<Property Map>
    A list of volumes assigned to this policy
    volumesAssigned Number
    Volumes using current backup policy
    dailyBackupsToKeep Number
    Daily backups count to keep
    enabled Boolean
    The property to decide policy is enabled or not
    monthlyBackupsToKeep Number
    Monthly backups count to keep
    tags Map<String>
    Resource tags.
    weeklyBackupsToKeep Number
    Weekly backups count to keep

    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.

    VolumeBackupsResponse

    BackupsCount int
    Total count of backups for volume
    PolicyEnabled bool
    Policy enabled
    VolumeName string
    Volume name
    VolumeResourceId string
    ResourceId used to identify the Volume
    BackupsCount int
    Total count of backups for volume
    PolicyEnabled bool
    Policy enabled
    VolumeName string
    Volume name
    VolumeResourceId string
    ResourceId used to identify the Volume
    backupsCount Integer
    Total count of backups for volume
    policyEnabled Boolean
    Policy enabled
    volumeName String
    Volume name
    volumeResourceId String
    ResourceId used to identify the Volume
    backupsCount number
    Total count of backups for volume
    policyEnabled boolean
    Policy enabled
    volumeName string
    Volume name
    volumeResourceId string
    ResourceId used to identify the Volume
    backups_count int
    Total count of backups for volume
    policy_enabled bool
    Policy enabled
    volume_name str
    Volume name
    volume_resource_id str
    ResourceId used to identify the Volume
    backupsCount Number
    Total count of backups for volume
    policyEnabled Boolean
    Policy enabled
    volumeName String
    Volume name
    volumeResourceId String
    ResourceId used to identify the Volume

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native