Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storsimple
  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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.storsimple.getBackupPolicy

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 properties of the specified backup policy name.

Uses Azure REST API version 2017-06-01.

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>
Copy
def get_backup_policy(backup_policy_name: Optional[str] = None,
                      device_name: Optional[str] = None,
                      manager_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBackupPolicyResult
def get_backup_policy_output(backup_policy_name: Optional[pulumi.Input[str]] = None,
                      device_name: Optional[pulumi.Input[str]] = None,
                      manager_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBackupPolicyResult]
Copy
func LookupBackupPolicy(ctx *Context, args *LookupBackupPolicyArgs, opts ...InvokeOption) (*LookupBackupPolicyResult, error)
func LookupBackupPolicyOutput(ctx *Context, args *LookupBackupPolicyOutputArgs, opts ...InvokeOption) LookupBackupPolicyResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
public static Output<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storsimple:getBackupPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of backup policy to be fetched.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
BackupPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of backup policy to be fetched.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
backupPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of backup policy to be fetched.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
backupPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of backup policy to be fetched.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
backup_policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of backup policy to be fetched.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name
manager_name
This property is required.
Changes to this property will trigger replacement.
str
The manager name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name
backupPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of backup policy to be fetched.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name

getBackupPolicy Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
BackupPolicyCreationType string
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
Id string
The path ID that uniquely identifies the object.
LastBackupTime string
The time of the last backup for the backup policy.
Name string
The name of the object.
NextBackupTime string
The time of the next backup for the backup policy.
ScheduledBackupStatus string
Indicates whether at least one of the schedules in the backup policy is active or not.
SchedulesCount double
The count of schedules the backup policy contains.
SsmHostName string
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
Type string
The hierarchical type of the object.
VolumeIds List<string>
The path IDs of the volumes which are part of the backup policy.
Kind string
The Kind of the object. Currently only Series8000 is supported
AzureApiVersion string
The Azure API version of the resource.
BackupPolicyCreationType string
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
Id string
The path ID that uniquely identifies the object.
LastBackupTime string
The time of the last backup for the backup policy.
Name string
The name of the object.
NextBackupTime string
The time of the next backup for the backup policy.
ScheduledBackupStatus string
Indicates whether at least one of the schedules in the backup policy is active or not.
SchedulesCount float64
The count of schedules the backup policy contains.
SsmHostName string
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
Type string
The hierarchical type of the object.
VolumeIds []string
The path IDs of the volumes which are part of the backup policy.
Kind string
The Kind of the object. Currently only Series8000 is supported
azureApiVersion String
The Azure API version of the resource.
backupPolicyCreationType String
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
id String
The path ID that uniquely identifies the object.
lastBackupTime String
The time of the last backup for the backup policy.
name String
The name of the object.
nextBackupTime String
The time of the next backup for the backup policy.
scheduledBackupStatus String
Indicates whether at least one of the schedules in the backup policy is active or not.
schedulesCount Double
The count of schedules the backup policy contains.
ssmHostName String
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
type String
The hierarchical type of the object.
volumeIds List<String>
The path IDs of the volumes which are part of the backup policy.
kind String
The Kind of the object. Currently only Series8000 is supported
azureApiVersion string
The Azure API version of the resource.
backupPolicyCreationType string
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
id string
The path ID that uniquely identifies the object.
lastBackupTime string
The time of the last backup for the backup policy.
name string
The name of the object.
nextBackupTime string
The time of the next backup for the backup policy.
scheduledBackupStatus string
Indicates whether at least one of the schedules in the backup policy is active or not.
schedulesCount number
The count of schedules the backup policy contains.
ssmHostName string
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
type string
The hierarchical type of the object.
volumeIds string[]
The path IDs of the volumes which are part of the backup policy.
kind string
The Kind of the object. Currently only Series8000 is supported
azure_api_version str
The Azure API version of the resource.
backup_policy_creation_type str
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
id str
The path ID that uniquely identifies the object.
last_backup_time str
The time of the last backup for the backup policy.
name str
The name of the object.
next_backup_time str
The time of the next backup for the backup policy.
scheduled_backup_status str
Indicates whether at least one of the schedules in the backup policy is active or not.
schedules_count float
The count of schedules the backup policy contains.
ssm_host_name str
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
type str
The hierarchical type of the object.
volume_ids Sequence[str]
The path IDs of the volumes which are part of the backup policy.
kind str
The Kind of the object. Currently only Series8000 is supported
azureApiVersion String
The Azure API version of the resource.
backupPolicyCreationType String
The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
id String
The path ID that uniquely identifies the object.
lastBackupTime String
The time of the last backup for the backup policy.
name String
The name of the object.
nextBackupTime String
The time of the next backup for the backup policy.
scheduledBackupStatus String
Indicates whether at least one of the schedules in the backup policy is active or not.
schedulesCount Number
The count of schedules the backup policy contains.
ssmHostName String
If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
type String
The hierarchical type of the object.
volumeIds List<String>
The path IDs of the volumes which are part of the backup policy.
kind String
The Kind of the object. Currently only Series8000 is supported

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