1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. listWebAppBackupConfiguration
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.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.web.listWebAppBackupConfiguration

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.0.1 published on Monday, Apr 7, 2025 by Pulumi

Description for Gets the backup configuration of an app.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2016-08-01, 2018-02-01, 2018-11-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

Using listWebAppBackupConfiguration

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 listWebAppBackupConfiguration(args: ListWebAppBackupConfigurationArgs, opts?: InvokeOptions): Promise<ListWebAppBackupConfigurationResult>
function listWebAppBackupConfigurationOutput(args: ListWebAppBackupConfigurationOutputArgs, opts?: InvokeOptions): Output<ListWebAppBackupConfigurationResult>
Copy
def list_web_app_backup_configuration(name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> ListWebAppBackupConfigurationResult
def list_web_app_backup_configuration_output(name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[ListWebAppBackupConfigurationResult]
Copy
func ListWebAppBackupConfiguration(ctx *Context, args *ListWebAppBackupConfigurationArgs, opts ...InvokeOption) (*ListWebAppBackupConfigurationResult, error)
func ListWebAppBackupConfigurationOutput(ctx *Context, args *ListWebAppBackupConfigurationOutputArgs, opts ...InvokeOption) ListWebAppBackupConfigurationResultOutput
Copy

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

public static class ListWebAppBackupConfiguration 
{
    public static Task<ListWebAppBackupConfigurationResult> InvokeAsync(ListWebAppBackupConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<ListWebAppBackupConfigurationResult> Invoke(ListWebAppBackupConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListWebAppBackupConfigurationResult> listWebAppBackupConfiguration(ListWebAppBackupConfigurationArgs args, InvokeOptions options)
public static Output<ListWebAppBackupConfigurationResult> listWebAppBackupConfiguration(ListWebAppBackupConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:listWebAppBackupConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the app.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

listWebAppBackupConfiguration Result

The following output properties are available:

Id string
Resource Id.
Name string
Resource Name.
StorageAccountUrl string
SAS URL to the container.
Type string
Resource type.
BackupName string
Name of the backup.
BackupSchedule Pulumi.AzureNative.Web.Outputs.BackupScheduleResponse
Schedule for the backup if it is executed periodically.
Databases List<Pulumi.AzureNative.Web.Outputs.DatabaseBackupSettingResponse>
Databases included in the backup.
Enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
Kind string
Kind of resource.
Id string
Resource Id.
Name string
Resource Name.
StorageAccountUrl string
SAS URL to the container.
Type string
Resource type.
BackupName string
Name of the backup.
BackupSchedule BackupScheduleResponse
Schedule for the backup if it is executed periodically.
Databases []DatabaseBackupSettingResponse
Databases included in the backup.
Enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
Kind string
Kind of resource.
id String
Resource Id.
name String
Resource Name.
storageAccountUrl String
SAS URL to the container.
type String
Resource type.
backupName String
Name of the backup.
backupSchedule BackupScheduleResponse
Schedule for the backup if it is executed periodically.
databases List<DatabaseBackupSettingResponse>
Databases included in the backup.
enabled Boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind String
Kind of resource.
id string
Resource Id.
name string
Resource Name.
storageAccountUrl string
SAS URL to the container.
type string
Resource type.
backupName string
Name of the backup.
backupSchedule BackupScheduleResponse
Schedule for the backup if it is executed periodically.
databases DatabaseBackupSettingResponse[]
Databases included in the backup.
enabled boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind string
Kind of resource.
id str
Resource Id.
name str
Resource Name.
storage_account_url str
SAS URL to the container.
type str
Resource type.
backup_name str
Name of the backup.
backup_schedule BackupScheduleResponse
Schedule for the backup if it is executed periodically.
databases Sequence[DatabaseBackupSettingResponse]
Databases included in the backup.
enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind str
Kind of resource.
id String
Resource Id.
name String
Resource Name.
storageAccountUrl String
SAS URL to the container.
type String
Resource type.
backupName String
Name of the backup.
backupSchedule Property Map
Schedule for the backup if it is executed periodically.
databases List<Property Map>
Databases included in the backup.
enabled Boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind String
Kind of resource.

Supporting Types

BackupScheduleResponse

FrequencyInterval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
FrequencyUnit This property is required. string
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
KeepAtLeastOneBackup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
LastExecutionTime This property is required. string
Last time when this schedule was triggered.
RetentionPeriodInDays This property is required. int
After how many days backups should be deleted.
StartTime string
When the schedule should start working.
FrequencyInterval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
FrequencyUnit This property is required. string
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
KeepAtLeastOneBackup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
LastExecutionTime This property is required. string
Last time when this schedule was triggered.
RetentionPeriodInDays This property is required. int
After how many days backups should be deleted.
StartTime string
When the schedule should start working.
frequencyInterval This property is required. Integer
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. String
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. Boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
lastExecutionTime This property is required. String
Last time when this schedule was triggered.
retentionPeriodInDays This property is required. Integer
After how many days backups should be deleted.
startTime String
When the schedule should start working.
frequencyInterval This property is required. number
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. string
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
lastExecutionTime This property is required. string
Last time when this schedule was triggered.
retentionPeriodInDays This property is required. number
After how many days backups should be deleted.
startTime string
When the schedule should start working.
frequency_interval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequency_unit This property is required. str
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keep_at_least_one_backup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
last_execution_time This property is required. str
Last time when this schedule was triggered.
retention_period_in_days This property is required. int
After how many days backups should be deleted.
start_time str
When the schedule should start working.
frequencyInterval This property is required. Number
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. String
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. Boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
lastExecutionTime This property is required. String
Last time when this schedule was triggered.
retentionPeriodInDays This property is required. Number
After how many days backups should be deleted.
startTime String
When the schedule should start working.

DatabaseBackupSettingResponse

DatabaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
DatabaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
databaseType This property is required. String
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String
databaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
connectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name string
database_type This property is required. str
Database type (e.g. SqlAzure / MySql).
connection_string str
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connection_string_name str
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name str
databaseType This property is required. String
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String

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.0.1 published on Monday, Apr 7, 2025 by Pulumi