1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. listWebAppBackupConfiguration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.web.listWebAppBackupConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Description for Gets the backup configuration of an app. Azure REST API version: 2022-09-01.

    Other available API versions: 2016-08-01, 2020-10-01, 2023-01-01.

    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>
    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]
    func ListWebAppBackupConfiguration(ctx *Context, args *ListWebAppBackupConfigurationArgs, opts ...InvokeOption) (*ListWebAppBackupConfigurationResult, error)
    func ListWebAppBackupConfigurationOutput(ctx *Context, args *ListWebAppBackupConfigurationOutputArgs, opts ...InvokeOption) ListWebAppBackupConfigurationResultOutput

    > 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)
    }
    public static CompletableFuture<ListWebAppBackupConfigurationResult> listWebAppBackupConfiguration(ListWebAppBackupConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:web:listWebAppBackupConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    name string
    Name of the app.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    name str
    Name of the app.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    name String
    Name of the app.
    resourceGroupName 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 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)
    KeepAtLeastOneBackup 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 string
    Last time when this schedule was triggered.
    RetentionPeriodInDays int
    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)
    KeepAtLeastOneBackup 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 string
    Last time when this schedule was triggered.
    RetentionPeriodInDays int
    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)
    keepAtLeastOneBackup 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 String
    Last time when this schedule was triggered.
    retentionPeriodInDays Integer
    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)
    keepAtLeastOneBackup 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 string
    Last time when this schedule was triggered.
    retentionPeriodInDays number
    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_least_one_backup 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 str
    Last time when this schedule was triggered.
    retention_period_in_days int
    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)
    keepAtLeastOneBackup 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 String
    Last time when this schedule was triggered.
    retentionPeriodInDays Number
    After how many days backups should be deleted.
    startTime String
    When the schedule should start working.

    DatabaseBackupSettingResponse

    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.
    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 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 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 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 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 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi