Set-​Azure​Rm​Sql​Database​Geo​Backup​Policy

Sets a database geo backup policy.

Syntax

Set-AzureRmSqlDatabaseGeoBackupPolicy
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   -State <GeoBackupPolicyState>
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-AzureRmSqlDatabaseGeoBackupPolicy 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

1:

Required Parameters

-DatabaseName

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

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerName

Specifies the name of the server that hosts the database.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-State

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

  • Enabled
  • Disabled
Type:GeoBackupPolicyState
Parameter Sets:Disabled, Enabled
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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
Accept pipeline input:False
Accept wildcard characters:False