azure-native.web.WebAppBackupConfiguration
Explore with Pulumi AI
Description of a backup which will be performed. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-08-01, 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:web:WebAppBackupConfiguration myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup 
Create WebAppBackupConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebAppBackupConfiguration(name: string, args: WebAppBackupConfigurationArgs, opts?: CustomResourceOptions);@overload
def WebAppBackupConfiguration(resource_name: str,
                              args: WebAppBackupConfigurationArgs,
                              opts: Optional[ResourceOptions] = None)
@overload
def WebAppBackupConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              storage_account_url: Optional[str] = None,
                              backup_name: Optional[str] = None,
                              backup_schedule: Optional[BackupScheduleArgs] = None,
                              databases: Optional[Sequence[DatabaseBackupSettingArgs]] = None,
                              enabled: Optional[bool] = None,
                              kind: Optional[str] = None)func NewWebAppBackupConfiguration(ctx *Context, name string, args WebAppBackupConfigurationArgs, opts ...ResourceOption) (*WebAppBackupConfiguration, error)public WebAppBackupConfiguration(string name, WebAppBackupConfigurationArgs args, CustomResourceOptions? opts = null)
public WebAppBackupConfiguration(String name, WebAppBackupConfigurationArgs args)
public WebAppBackupConfiguration(String name, WebAppBackupConfigurationArgs args, CustomResourceOptions options)
type: azure-native:web:WebAppBackupConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WebAppBackupConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WebAppBackupConfigurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WebAppBackupConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebAppBackupConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WebAppBackupConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var webAppBackupConfigurationResource = new AzureNative.Web.WebAppBackupConfiguration("webAppBackupConfigurationResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    StorageAccountUrl = "string",
    BackupName = "string",
    BackupSchedule = new AzureNative.Web.Inputs.BackupScheduleArgs
    {
        FrequencyInterval = 0,
        FrequencyUnit = AzureNative.Web.FrequencyUnit.Day,
        KeepAtLeastOneBackup = false,
        RetentionPeriodInDays = 0,
        StartTime = "string",
    },
    Databases = new[]
    {
        new AzureNative.Web.Inputs.DatabaseBackupSettingArgs
        {
            DatabaseType = "string",
            ConnectionString = "string",
            ConnectionStringName = "string",
            Name = "string",
        },
    },
    Enabled = false,
    Kind = "string",
});
example, err := web.NewWebAppBackupConfiguration(ctx, "webAppBackupConfigurationResource", &web.WebAppBackupConfigurationArgs{
	Name:              pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	StorageAccountUrl: pulumi.String("string"),
	BackupName:        pulumi.String("string"),
	BackupSchedule: &web.BackupScheduleArgs{
		FrequencyInterval:     pulumi.Int(0),
		FrequencyUnit:         web.FrequencyUnitDay,
		KeepAtLeastOneBackup:  pulumi.Bool(false),
		RetentionPeriodInDays: pulumi.Int(0),
		StartTime:             pulumi.String("string"),
	},
	Databases: web.DatabaseBackupSettingArray{
		&web.DatabaseBackupSettingArgs{
			DatabaseType:         pulumi.String("string"),
			ConnectionString:     pulumi.String("string"),
			ConnectionStringName: pulumi.String("string"),
			Name:                 pulumi.String("string"),
		},
	},
	Enabled: pulumi.Bool(false),
	Kind:    pulumi.String("string"),
})
var webAppBackupConfigurationResource = new WebAppBackupConfiguration("webAppBackupConfigurationResource", WebAppBackupConfigurationArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .storageAccountUrl("string")
    .backupName("string")
    .backupSchedule(BackupScheduleArgs.builder()
        .frequencyInterval(0)
        .frequencyUnit("Day")
        .keepAtLeastOneBackup(false)
        .retentionPeriodInDays(0)
        .startTime("string")
        .build())
    .databases(DatabaseBackupSettingArgs.builder()
        .databaseType("string")
        .connectionString("string")
        .connectionStringName("string")
        .name("string")
        .build())
    .enabled(false)
    .kind("string")
    .build());
web_app_backup_configuration_resource = azure_native.web.WebAppBackupConfiguration("webAppBackupConfigurationResource",
    name="string",
    resource_group_name="string",
    storage_account_url="string",
    backup_name="string",
    backup_schedule={
        "frequency_interval": 0,
        "frequency_unit": azure_native.web.FrequencyUnit.DAY,
        "keep_at_least_one_backup": False,
        "retention_period_in_days": 0,
        "start_time": "string",
    },
    databases=[{
        "database_type": "string",
        "connection_string": "string",
        "connection_string_name": "string",
        "name": "string",
    }],
    enabled=False,
    kind="string")
const webAppBackupConfigurationResource = new azure_native.web.WebAppBackupConfiguration("webAppBackupConfigurationResource", {
    name: "string",
    resourceGroupName: "string",
    storageAccountUrl: "string",
    backupName: "string",
    backupSchedule: {
        frequencyInterval: 0,
        frequencyUnit: azure_native.web.FrequencyUnit.Day,
        keepAtLeastOneBackup: false,
        retentionPeriodInDays: 0,
        startTime: "string",
    },
    databases: [{
        databaseType: "string",
        connectionString: "string",
        connectionStringName: "string",
        name: "string",
    }],
    enabled: false,
    kind: "string",
});
type: azure-native:web:WebAppBackupConfiguration
properties:
    backupName: string
    backupSchedule:
        frequencyInterval: 0
        frequencyUnit: Day
        keepAtLeastOneBackup: false
        retentionPeriodInDays: 0
        startTime: string
    databases:
        - connectionString: string
          connectionStringName: string
          databaseType: string
          name: string
    enabled: false
    kind: string
    name: string
    resourceGroupName: string
    storageAccountUrl: string
WebAppBackupConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WebAppBackupConfiguration resource accepts the following input properties:
- Name string
- Name of the app.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- StorageAccount stringUrl 
- SAS URL to the container.
- BackupName string
- Name of the backup.
- BackupSchedule Pulumi.Azure Native. Web. Inputs. Backup Schedule 
- Schedule for the backup if it is executed periodically.
- Databases
List<Pulumi.Azure Native. Web. Inputs. Database Backup Setting> 
- 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.
- Name string
- Name of the app.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- StorageAccount stringUrl 
- SAS URL to the container.
- BackupName string
- Name of the backup.
- BackupSchedule BackupSchedule Args 
- Schedule for the backup if it is executed periodically.
- Databases
[]DatabaseBackup Setting Args 
- 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.
- name String
- Name of the app.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- storageAccount StringUrl 
- SAS URL to the container.
- backupName String
- Name of the backup.
- backupSchedule BackupSchedule 
- Schedule for the backup if it is executed periodically.
- databases
List<DatabaseBackup Setting> 
- 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.
- name string
- Name of the app.
- resourceGroup stringName 
- Name of the resource group to which the resource belongs.
- storageAccount stringUrl 
- SAS URL to the container.
- backupName string
- Name of the backup.
- backupSchedule BackupSchedule 
- Schedule for the backup if it is executed periodically.
- databases
DatabaseBackup Setting[] 
- 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.
- name str
- Name of the app.
- resource_group_ strname 
- Name of the resource group to which the resource belongs.
- storage_account_ strurl 
- SAS URL to the container.
- backup_name str
- Name of the backup.
- backup_schedule BackupSchedule Args 
- Schedule for the backup if it is executed periodically.
- databases
Sequence[DatabaseBackup Setting Args] 
- 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.
- name String
- Name of the app.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- storageAccount StringUrl 
- SAS URL to the container.
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the WebAppBackupConfiguration resource produces the following output properties:
Supporting Types
BackupSchedule, BackupScheduleArgs    
- FrequencyInterval 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 Pulumi.Azure Native. Web. Frequency Unit 
- 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)
- KeepAt boolLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- RetentionPeriod intIn Days 
- After how many days backups should be deleted.
- StartTime string
- When the schedule should start working.
- FrequencyInterval 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 FrequencyUnit 
- 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)
- KeepAt boolLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- RetentionPeriod intIn Days 
- After how many days backups should be deleted.
- StartTime string
- When the schedule should start working.
- frequencyInterval 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 FrequencyUnit 
- 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)
- keepAt BooleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- retentionPeriod IntegerIn Days 
- After how many days backups should be deleted.
- startTime String
- When the schedule should start working.
- frequencyInterval 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 FrequencyUnit 
- 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)
- keepAt booleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- retentionPeriod numberIn Days 
- After how many days backups should be deleted.
- startTime string
- When the schedule should start working.
- frequency_interval 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 FrequencyUnit 
- 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_ boolleast_ one_ backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- retention_period_ intin_ days 
- After how many days backups should be deleted.
- start_time str
- When the schedule should start working.
- frequencyInterval 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 "Day" | "Hour"
- 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)
- keepAt BooleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- retentionPeriod NumberIn Days 
- After how many days backups should be deleted.
- startTime String
- When the schedule should start working.
BackupScheduleResponse, BackupScheduleResponseArgs      
- FrequencyInterval 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 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)
- KeepAt boolLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- LastExecution stringTime 
- Last time when this schedule was triggered.
- RetentionPeriod intIn Days 
- After how many days backups should be deleted.
- StartTime string
- When the schedule should start working.
- FrequencyInterval 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 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)
- KeepAt boolLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- LastExecution stringTime 
- Last time when this schedule was triggered.
- RetentionPeriod intIn Days 
- After how many days backups should be deleted.
- StartTime string
- When the schedule should start working.
- frequencyInterval 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 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)
- keepAt BooleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- lastExecution StringTime 
- Last time when this schedule was triggered.
- retentionPeriod IntegerIn Days 
- After how many days backups should be deleted.
- startTime String
- When the schedule should start working.
- frequencyInterval 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 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)
- keepAt booleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- lastExecution stringTime 
- Last time when this schedule was triggered.
- retentionPeriod numberIn Days 
- After how many days backups should be deleted.
- startTime string
- When the schedule should start working.
- frequency_interval 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 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_ boolleast_ one_ backup 
- 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_ strtime 
- Last time when this schedule was triggered.
- retention_period_ intin_ days 
- After how many days backups should be deleted.
- start_time str
- When the schedule should start working.
- frequencyInterval 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 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)
- keepAt BooleanLeast One Backup 
- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
- lastExecution StringTime 
- Last time when this schedule was triggered.
- retentionPeriod NumberIn Days 
- After how many days backups should be deleted.
- startTime String
- When the schedule should start working.
DatabaseBackupSetting, DatabaseBackupSettingArgs      
- DatabaseType string | Pulumi.Azure Native. Web. Database Type 
- 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.
- ConnectionString stringName 
- 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 string | DatabaseType 
- 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.
- ConnectionString stringName 
- 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 String | DatabaseType 
- 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.
- connectionString StringName 
- 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 string | DatabaseType 
- 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.
- connectionString stringName 
- 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 str | DatabaseType 
- 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_ strname 
- 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 String | "SqlAzure" | "My Sql" | "Local My Sql" | "Postgre Sql" 
- 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.
- connectionString StringName 
- Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
- name String
DatabaseBackupSettingResponse, DatabaseBackupSettingResponseArgs        
- DatabaseType 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.
- ConnectionString stringName 
- 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 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.
- ConnectionString stringName 
- 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 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.
- connectionString StringName 
- 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 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.
- connectionString stringName 
- 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 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_ strname 
- 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 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.
- connectionString StringName 
- 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, DatabaseTypeArgs    
- SqlAzure 
- SqlAzure
- MySql 
- MySql
- LocalMy Sql 
- LocalMySql
- PostgreSql 
- PostgreSql
- DatabaseType Sql Azure 
- SqlAzure
- DatabaseType My Sql 
- MySql
- DatabaseType Local My Sql 
- LocalMySql
- DatabaseType Postgre Sql 
- PostgreSql
- SqlAzure 
- SqlAzure
- MySql 
- MySql
- LocalMy Sql 
- LocalMySql
- PostgreSql 
- PostgreSql
- SqlAzure 
- SqlAzure
- MySql 
- MySql
- LocalMy Sql 
- LocalMySql
- PostgreSql 
- PostgreSql
- SQL_AZURE
- SqlAzure
- MY_SQL
- MySql
- LOCAL_MY_SQL
- LocalMySql
- POSTGRE_SQL
- PostgreSql
- "SqlAzure" 
- SqlAzure
- "MySql" 
- MySql
- "LocalMy Sql" 
- LocalMySql
- "PostgreSql" 
- PostgreSql
FrequencyUnit, FrequencyUnitArgs    
- Day
- Day
- Hour
- Hour
- FrequencyUnit Day 
- Day
- FrequencyUnit Hour 
- Hour
- Day
- Day
- Hour
- Hour
- Day
- Day
- Hour
- Hour
- DAY
- Day
- HOUR
- Hour
- "Day"
- Day
- "Hour"
- Hour
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0