Restart-AzPostgreSqlFlexibleServer

Module:

Az.PostgreSql

Restarts a server.

Syntax

Restart-AzPostgreSqlFlexibleServer
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       [-FailoverMode <String>]
       [-RestartWithFailover]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Restart-AzPostgreSqlFlexibleServer
       -Name <String>
       -ResourceGroupName <String>
       -Parameter <IRestartParameter>
       [-SubscriptionId <String>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Restart-AzPostgreSqlFlexibleServer
       -InputObject <IPostgreSqlIdentity>
       -Parameter <IRestartParameter>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Restart-AzPostgreSqlFlexibleServer
       -InputObject <IPostgreSqlIdentity>
       [-FailoverMode <String>]
       [-RestartWithFailover]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Description

Restarts a server.

Examples

Example 1: Restart the server by resource name

Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test

Restart the server by name

Example 2: Restart the server by identity

$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBForPostgreSql/flexibleServers/postgresql-test/restart"
Restart-AzPostgreSqlFlexibleServer -InputObject $ID

Restart the server by identity

Example 3: Restart the server with planned failover

Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -RestartWithFailover -FailoverMode PlannedFailover

Restart the server by name with planned failover

Example 4: Restart the server with forced failover

Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -RestartWithFailover -FailoverMode ForcedFailover

Restart the server by name with forced failover

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

-FailoverMode

Failover mode.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IPostgreSqlIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-Parameter

Represents server restart parameters. To construct, see NOTES section for PARAMETER properties and create a hash table.

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-RestartWithFailover

Indicates whether to restart the server with failover.

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

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IRestartParameter

IPostgreSqlIdentity

Outputs

Boolean

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 <IPostgreSqlIdentity>: Identity Parameter

• [ConfigurationName <String>]: The name of the server configuration.
• [DatabaseName <String>]: The name of the database.
• [FirewallRuleName <String>]: The name of the server firewall rule.
• [Id <String>]: Resource identity path
• [LocationName <String>]: The name of the location.
• [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
• [SecurityAlertPolicyName <SecurityAlertPolicyName?>]: The name of the security alert policy.
• [ServerName <String>]: The name of the server.
• [SubscriptionId <String>]: The ID of the target subscription.
• [VirtualNetworkRuleName <String>]: The name of the virtual network rule.

PARAMETER <IRestartParameter>: Represents server restart parameters.

• [FailoverMode <String>]: Failover mode.
• [RestartWithFailover <Boolean?>]: Indicates whether to restart the server with failover.