Edit

Set-AzSqlDatabaseGeoBackupPolicy

  • Reference
Module:
Az.Sql

Sets a database geo backup policy.

Syntax

Set-AzSqlDatabaseGeoBackupPolicy
   -State <GeoBackupPolicyState>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzSqlDatabaseGeoBackupPolicy cmdlet sets the geo backup policy registered to a database. This is an Azure Backup resource that is used to define backup storage policy.

Examples

Example 1

Sets a database geo backup policy. (autogenerated)

Set-AzSqlDatabaseGeoBackupPolicy -DatabaseName db1 -ResourceGroupName myresourcegroup -ServerName s1 -State Disabled

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseName

Specifies the name of the database for which this cmdlet sets the geo backup policy.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group of the server that contains this database.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the name of the server that hosts the database.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-State

Specifies the state of the geo backup policy. The acceptable values for this parameter are:

  • Enabled
  • Disabled
Type:Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel+GeoBackupPolicyState
Accepted values:Disabled, Enabled
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AzureSqlDatabaseGeoBackupPolicyModel