Restore-AzPostgreSqlServer

Module:

Az.PostgreSql

Restore a server from an existing backup

Syntax

Restore-AzPostgreSqlServer
       -Name <String>
       -ResourceGroupName <String>
       -InputObject <IServer>
       -UseGeoRestore
       [-SubscriptionId <String>]
       [-Location <String>]
       [-Sku <String>]
       [-Tag <Hashtable>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Restore-AzPostgreSqlServer
       -Name <String>
       -ResourceGroupName <String>
       -InputObject <IServer>
       -RestorePointInTime <DateTime>
       -UsePointInTimeRestore
       [-SubscriptionId <String>]
       [-Location <String>]
       [-Sku <String>]
       [-Tag <Hashtable>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Description

Restore a server from an existing backup

Examples

Example 1: Restore PostgreSql server using GeoReplica Restore

Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName postgresqltestserverreplica | Restore-AzPostgreSqlServer -Name PostgreSqlTestServer -ResourceGroupName PostgreSqlTestRG -UseGeoRestore

Name                 Location AdministratorLogin Version StorageProfileStorageMb SkuName   SkuTier        SslEnforcement
----                 -------- ------------------ ------- ----------------------- -------   -------        --------------
postgresqltestserver eastus   pwsh               9.6     5120                    GP_Gen5_4 GeneralPurpose Enabled

This cmdlet restores PostgreSql server using GeoReplica Restore.

Example 2: Restore PostgreSql server using PointInTime Restore

$restorePointInTime = (Get-Date).AddMinutes(-10)
Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Restore-AzPostgreSqlServer -Name PostgreSqlTestServerGEO -ResourceGroupName PostgreSqlTestRG -RestorePointInTime $restorePointInTime -UsePointInTimeRestore

Name                    Location AdministratorLogin Version StorageProfileStorageMb SkuName   SkuTier        SslEnforcement
----                    -------- ------------------ ------- ----------------------- -------   -------        --------------
postgresqltestservergeo eastus   pwsh               9.6     5120                    GP_Gen5_4 GeneralPurpose Enabled

These cmdlets restore PostgreSql server using PointInTime Restore.

Parameters

-AsJob

Run the command as a job.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

The source server object to restore from. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IServer
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Location

The location the resource resides in.

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

-Name

The name of the server.

Type:	String
Aliases:	ServerName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously.

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

-ResourceGroupName

The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal.

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

-RestorePointInTime

The location the resource resides in.

Type:	DateTime
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Sku

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

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

-SubscriptionId

The subscription ID that identifies an Azure subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Application-specific metadata in the form of key-value pairs.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseGeoRestore

Use Geo mode to restore

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UsePointInTimeRestore

Use PointInTime mode to restore

Type:	SwitchParameter
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IServer

Outputs

IServer

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IServer>: The source server object to restore from.

• Location <String>: The geo-location where the resource lives
• [Tag <ITrackedResourceTags>]: Resource tags.
  • [(Any) <String>]: This indicates any property can be added to this object.
• [AdministratorLogin <String>]: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
• [EarliestRestoreDate <DateTime?>]: Earliest restore point creation time (ISO8601 format)
• [FullyQualifiedDomainName <String>]: The fully qualified domain name of a server.
• [IdentityType <IdentityType?>]: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign a Microsoft Entra principal for the resource.
• [InfrastructureEncryption <InfrastructureEncryption?>]: Status showing whether the server enabled infrastructure encryption.
• [MasterServerId <String>]: The master server id of a replica server.
• [MinimalTlsVersion <MinimalTlsVersionEnum?>]: Enforce a minimal Tls version for the server.
• [PublicNetworkAccess <PublicNetworkAccessEnum?>]: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
• [ReplicaCapacity <Int32?>]: The maximum number of replicas that a master server can have.
• [ReplicationRole <String>]: The replication role of the server.
• [SkuCapacity <Int32?>]: The scale up/out capacity, representing server's compute units.
• [SkuFamily <String>]: The family of hardware.
• [SkuName <String>]: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
• [SkuSize <String>]: The size code, to be interpreted by resource as appropriate.
• [SkuTier <SkuTier?>]: The tier of the particular SKU, e.g. Basic.
• [SslEnforcement <SslEnforcementEnum?>]: Enable ssl enforcement or not when connect to server.
• [StorageProfileBackupRetentionDay <Int32?>]: Backup retention days for the server.
• [StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]: Enable Geo-redundant or not for server backup.
• [StorageProfileStorageAutogrow <StorageAutogrow?>]: Enable Storage Auto Grow.
• [StorageProfileStorageMb <Int32?>]: Max storage allowed for a server.
• [UserVisibleState <ServerState?>]: A state of a server that is visible to user.
• [Version <ServerVersion?>]: Server version.