azure-native.netapp.getBackupPolicy
Explore with Pulumi AI
Get a particular backup Policy Azure REST API version: 2022-11-01.
Other available API versions: 2021-04-01, 2021-04-01-preview, 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, 2024-09-01-preview.
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 dictionaryThe following arguments are supported:
- AccountName string
- The name of the NetApp account
- BackupPolicy stringName 
- Backup policy Name which uniquely identify backup policy.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- AccountName string
- The name of the NetApp account
- BackupPolicy stringName 
- Backup policy Name which uniquely identify backup policy.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- accountName String
- The name of the NetApp account
- backupPolicy StringName 
- Backup policy Name which uniquely identify backup policy.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- accountName string
- The name of the NetApp account
- backupPolicy stringName 
- Backup policy Name which uniquely identify backup policy.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- account_name str
- The name of the NetApp account
- backup_policy_ strname 
- Backup policy Name which uniquely identify backup policy.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- accountName String
- The name of the NetApp account
- backupPolicy StringName 
- Backup policy Name which uniquely identify backup policy.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
getBackupPolicy Result
The following output properties are available:
- BackupPolicy stringId 
- Backup Policy Resource ID
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- Fully qualified resource ID for the resource. Ex - /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.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"
- VolumeBackups List<Pulumi.Azure Native. Net App. Outputs. Volume Backups Response> 
- A list of volumes assigned to this policy
- VolumesAssigned int
- Volumes using current backup policy
- DailyBackups intTo Keep 
- Daily backups count to keep
- Enabled bool
- The property to decide policy is enabled or not
- MonthlyBackups intTo Keep 
- Monthly backups count to keep
- Dictionary<string, string>
- Resource tags.
- WeeklyBackups intTo Keep 
- Weekly backups count to keep
- BackupPolicy stringId 
- Backup Policy Resource ID
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- Fully qualified resource ID for the resource. Ex - /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 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"
- VolumeBackups []VolumeBackups Response 
- A list of volumes assigned to this policy
- VolumesAssigned int
- Volumes using current backup policy
- DailyBackups intTo Keep 
- Daily backups count to keep
- Enabled bool
- The property to decide policy is enabled or not
- MonthlyBackups intTo Keep 
- Monthly backups count to keep
- map[string]string
- Resource tags.
- WeeklyBackups intTo Keep 
- Weekly backups count to keep
- backupPolicy StringId 
- Backup Policy Resource ID
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- Fully qualified resource ID for the resource. Ex - /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 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"
- volumeBackups List<VolumeBackups Response> 
- A list of volumes assigned to this policy
- volumesAssigned Integer
- Volumes using current backup policy
- dailyBackups IntegerTo Keep 
- Daily backups count to keep
- enabled Boolean
- The property to decide policy is enabled or not
- monthlyBackups IntegerTo Keep 
- Monthly backups count to keep
- Map<String,String>
- Resource tags.
- weeklyBackups IntegerTo Keep 
- Weekly backups count to keep
- backupPolicy stringId 
- Backup Policy Resource ID
- etag string
- A unique read-only string that changes whenever the resource is updated.
- id string
- Fully qualified resource ID for the resource. Ex - /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 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"
- volumeBackups VolumeBackups Response[] 
- A list of volumes assigned to this policy
- volumesAssigned number
- Volumes using current backup policy
- dailyBackups numberTo Keep 
- Daily backups count to keep
- enabled boolean
- The property to decide policy is enabled or not
- monthlyBackups numberTo Keep 
- Monthly backups count to keep
- {[key: string]: string}
- Resource tags.
- weeklyBackups numberTo Keep 
- Weekly backups count to keep
- backup_policy_ strid 
- Backup Policy Resource ID
- etag str
- A unique read-only string that changes whenever the resource is updated.
- id str
- Fully qualified resource ID for the resource. Ex - /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 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"
- volume_backups Sequence[VolumeBackups Response] 
- A list of volumes assigned to this policy
- volumes_assigned int
- Volumes using current backup policy
- daily_backups_ intto_ keep 
- Daily backups count to keep
- enabled bool
- The property to decide policy is enabled or not
- monthly_backups_ intto_ keep 
- Monthly backups count to keep
- Mapping[str, str]
- Resource tags.
- weekly_backups_ intto_ keep 
- Weekly backups count to keep
- backupPolicy StringId 
- Backup Policy Resource ID
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- Fully qualified resource ID for the resource. Ex - /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
- dailyBackups NumberTo Keep 
- Daily backups count to keep
- enabled Boolean
- The property to decide policy is enabled or not
- monthlyBackups NumberTo Keep 
- Monthly backups count to keep
- Map<String>
- Resource tags.
- weeklyBackups NumberTo Keep 
- Weekly backups count to keep
Supporting Types
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified 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.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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
- BackupsCount int
- Total count of backups for volume
- PolicyEnabled bool
- Policy enabled
- VolumeName string
- Volume name
- backupsCount Integer
- Total count of backups for volume
- policyEnabled Boolean
- Policy enabled
- volumeName String
- Volume name
- backupsCount number
- Total count of backups for volume
- policyEnabled boolean
- Policy enabled
- volumeName string
- Volume name
- backups_count int
- Total count of backups for volume
- policy_enabled bool
- Policy enabled
- volume_name str
- Volume name
- backupsCount Number
- Total count of backups for volume
- policyEnabled Boolean
- Policy enabled
- volumeName String
- Volume name
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0