Edit

Get-AzPostgreSqlFlexibleServer

  • Reference
Module:
Az.PostgreSql

Gets information about a server.

Syntax

Get-AzPostgreSqlFlexibleServer
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPostgreSqlFlexibleServer
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPostgreSqlFlexibleServer
   -InputObject <IPostgreSqlIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPostgreSqlFlexibleServer
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets information about a server.

Examples

Example 1: Get PostgreSql servers in the subscription

Get-AzPostgreSqlFlexibleServer

Name                Location  SkuName         SkuTier        AdministratorLogin StorageSizeGb
----                --------  -------         -------        ------------------ -------------
postgresql-test     East US   Standard_D2s_v3 GeneralPurpose daeunyim           128
postgresql-test-2   East US   Standard_D2s_v3 GeneralPurpose daeunyim           128
postgresql-test-3   East US   Standard_D2s_v3 GeneralPurpose daeunyim           128

This cmdlet gets PostgreSql servers with default context.

Example 2: Get PostgreSql server by resource group and server name

Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test

Name                Location  SkuName         SkuTier        AdministratorLogin StorageSizeGb
----                --------  -------         -------        ------------------ -------------
postgresql-test     East US   Standard_D2s_v3 GeneralPurpose daeunyim           128

This cmdlet gets PostgreSql servers by resource group and server name.

Example 3: Lists all the PostgreSql servers in specified resource group

Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest

Name                Location  SkuName         SkuTier        AdministratorLogin StorageSizeGb
----                --------  -------         -------        ------------------ -------------
postgresql-test     East US   Standard_D2s_v3 GeneralPurpose daeunyim           128
postgresql-test-2   East US   Standard_D2s_v3 GeneralPurpose daeunyim           128

This cmdlet lists all the PostgreSql servers in the specified resource group.

Example 4: Get PostgreSql server by identity

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

Name                Location  SkuName         SkuTier        AdministratorLogin StorageSizeGb
----                --------  -------         -------        ------------------ -------------
postgresql-test     East US   Standard_D2s_v3 GeneralPurpose daeunyim           128

This cmdlet lists gets PostgreSql servers by identity.

Parameters

-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

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

-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

-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

Inputs

IPostgreSqlIdentity

Outputs

IServerAutoGenerated

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.