Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. storsimple
  5. getBackupSchedule
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.storsimple.getBackupSchedule

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of the specified backup schedule name. Azure REST API version: 2017-06-01.

Using getBackupSchedule

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 getBackupSchedule(args: GetBackupScheduleArgs, opts?: InvokeOptions): Promise<GetBackupScheduleResult>
function getBackupScheduleOutput(args: GetBackupScheduleOutputArgs, opts?: InvokeOptions): Output<GetBackupScheduleResult>
Copy
def get_backup_schedule(backup_policy_name: Optional[str] = None,
                        backup_schedule_name: Optional[str] = None,
                        device_name: Optional[str] = None,
                        manager_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackupScheduleResult
def get_backup_schedule_output(backup_policy_name: Optional[pulumi.Input[str]] = None,
                        backup_schedule_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[GetBackupScheduleResult]
Copy
func LookupBackupSchedule(ctx *Context, args *LookupBackupScheduleArgs, opts ...InvokeOption) (*LookupBackupScheduleResult, error)
func LookupBackupScheduleOutput(ctx *Context, args *LookupBackupScheduleOutputArgs, opts ...InvokeOption) LookupBackupScheduleResultOutput
Copy

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

public static class GetBackupSchedule 
{
    public static Task<GetBackupScheduleResult> InvokeAsync(GetBackupScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupScheduleResult> Invoke(GetBackupScheduleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBackupScheduleResult> getBackupSchedule(GetBackupScheduleArgs args, InvokeOptions options)
public static Output<GetBackupScheduleResult> getBackupSchedule(GetBackupScheduleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storsimple:getBackupSchedule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The backup policy name.
BackupScheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup schedule 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 backup policy name.
BackupScheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup schedule 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 backup policy name.
backupScheduleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup schedule 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 backup policy name.
backupScheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup schedule 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 backup policy name.
backup_schedule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the backup schedule 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 backup policy name.
backupScheduleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup schedule 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

getBackupSchedule Result

The following output properties are available:

BackupType string
The type of backup which needs to be taken.
Id string
The path ID that uniquely identifies the object.
LastSuccessfulRun string
The last successful backup run which was triggered for the schedule.
Name string
The name of the object.
RetentionCount double
The number of backups to be retained.
ScheduleRecurrence Pulumi.AzureNative.StorSimple.Outputs.ScheduleRecurrenceResponse
The schedule recurrence.
ScheduleStatus string
The schedule status.
StartTime string
The start time of the schedule.
Type string
The hierarchical type of the object.
Kind string
The Kind of the object. Currently only Series8000 is supported
BackupType string
The type of backup which needs to be taken.
Id string
The path ID that uniquely identifies the object.
LastSuccessfulRun string
The last successful backup run which was triggered for the schedule.
Name string
The name of the object.
RetentionCount float64
The number of backups to be retained.
ScheduleRecurrence ScheduleRecurrenceResponse
The schedule recurrence.
ScheduleStatus string
The schedule status.
StartTime string
The start time of the schedule.
Type string
The hierarchical type of the object.
Kind string
The Kind of the object. Currently only Series8000 is supported
backupType String
The type of backup which needs to be taken.
id String
The path ID that uniquely identifies the object.
lastSuccessfulRun String
The last successful backup run which was triggered for the schedule.
name String
The name of the object.
retentionCount Double
The number of backups to be retained.
scheduleRecurrence ScheduleRecurrenceResponse
The schedule recurrence.
scheduleStatus String
The schedule status.
startTime String
The start time of the schedule.
type String
The hierarchical type of the object.
kind String
The Kind of the object. Currently only Series8000 is supported
backupType string
The type of backup which needs to be taken.
id string
The path ID that uniquely identifies the object.
lastSuccessfulRun string
The last successful backup run which was triggered for the schedule.
name string
The name of the object.
retentionCount number
The number of backups to be retained.
scheduleRecurrence ScheduleRecurrenceResponse
The schedule recurrence.
scheduleStatus string
The schedule status.
startTime string
The start time of the schedule.
type string
The hierarchical type of the object.
kind string
The Kind of the object. Currently only Series8000 is supported
backup_type str
The type of backup which needs to be taken.
id str
The path ID that uniquely identifies the object.
last_successful_run str
The last successful backup run which was triggered for the schedule.
name str
The name of the object.
retention_count float
The number of backups to be retained.
schedule_recurrence ScheduleRecurrenceResponse
The schedule recurrence.
schedule_status str
The schedule status.
start_time str
The start time of the schedule.
type str
The hierarchical type of the object.
kind str
The Kind of the object. Currently only Series8000 is supported
backupType String
The type of backup which needs to be taken.
id String
The path ID that uniquely identifies the object.
lastSuccessfulRun String
The last successful backup run which was triggered for the schedule.
name String
The name of the object.
retentionCount Number
The number of backups to be retained.
scheduleRecurrence Property Map
The schedule recurrence.
scheduleStatus String
The schedule status.
startTime String
The start time of the schedule.
type String
The hierarchical type of the object.
kind String
The Kind of the object. Currently only Series8000 is supported

Supporting Types

ScheduleRecurrenceResponse

RecurrenceType This property is required. string
The recurrence type.
RecurrenceValue This property is required. int
The recurrence value.
WeeklyDaysList List<string>
The week days list. Applicable only for schedules of recurrence type 'weekly'.
RecurrenceType This property is required. string
The recurrence type.
RecurrenceValue This property is required. int
The recurrence value.
WeeklyDaysList []string
The week days list. Applicable only for schedules of recurrence type 'weekly'.
recurrenceType This property is required. String
The recurrence type.
recurrenceValue This property is required. Integer
The recurrence value.
weeklyDaysList List<String>
The week days list. Applicable only for schedules of recurrence type 'weekly'.
recurrenceType This property is required. string
The recurrence type.
recurrenceValue This property is required. number
The recurrence value.
weeklyDaysList string[]
The week days list. Applicable only for schedules of recurrence type 'weekly'.
recurrence_type This property is required. str
The recurrence type.
recurrence_value This property is required. int
The recurrence value.
weekly_days_list Sequence[str]
The week days list. Applicable only for schedules of recurrence type 'weekly'.
recurrenceType This property is required. String
The recurrence type.
recurrenceValue This property is required. Number
The recurrence value.
weeklyDaysList List<String>
The week days list. Applicable only for schedules of recurrence type 'weekly'.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native