Get-AzPostgreSqlFlexibleServerConfiguration

Preview

Module:: Az.PostgreSqlFlexibleServer Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Gets information about a specific configuration (also known as server parameter) of a server.

Syntax

List (Default)

Get-AzPostgreSqlFlexibleServerConfiguration
    -ResourceGroupName <String>
    -ServerName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityFlexibleServer

Get-AzPostgreSqlFlexibleServerConfiguration
    -Name <String>
    -FlexibleServerInputObject <IPostgreSqlFlexibleServerIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzPostgreSqlFlexibleServerConfiguration
    -Name <String>
    -ResourceGroupName <String>
    -ServerName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzPostgreSqlFlexibleServerConfiguration
    -InputObject <IPostgreSqlFlexibleServerIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets information about a specific configuration (also known as server parameter) of a server.

Examples

Example 1: List all configurations (also known as server parameters) in a flexible server

Get-AzPostgreSqlFlexibleServerConfiguration -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName example-server

Name                                DataType        Value                AllowedValue         DefaultValue         Source          Description
----                                --------        -----                ------------         ------------         ------          -----------
allow_alter_system                  Boolean         on                   on,off               on                   system-default  Allows running the ALTER SYSTEM command. Can be s…
allow_in_place_tablespaces          Boolean         off                  on,off               off                  system-default  Allows tablespaces directly inside pg_tblspc, for…
allow_system_table_mods             Boolean         off                  on,off               off                  system-default  Allows modifications of the structure of system t…
...
wal_writer_flush_after              Integer         128                  0-2147483647         128                  system-default  Amount of WAL written out by WAL writer that trig…
work_mem                            Integer         4096                 4096-2097151         4096                 system-default  Sets the maximum memory to be used for query work…
xmlbinary                           Enumeration     base64               base64,hex           base64               system-default  Sets how binary values are to be encoded in XML.
xmloption                           Enumeration     content              content,document     content              system-default  Sets whether XML data in implicit parsing and ser…
zero_damaged_pages                  Boolean         off                  on,off               off                  system-default  Continues processing past damaged page headers. D…

Lists all configurations (also known as server parameters) in an Azure Database for PostgreSQL flexible server with server name, resource group, and subscription explicitly passed as arguments. If subscription is not passed explicitly, it's taken from default context.

Example 2: Get one configuration (also known as server parameter) in a flexible server

Get-AzPostgreSqlFlexibleServerConfiguration -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName example-server -Name work_mem

Name                                DataType        Value                AllowedValue         DefaultValue         Source          Description
----                                --------        -----                ------------         ------------         ------          -----------
work_mem                            Integer         4096                 4096-2097151         4096                 system-default  Sets the maximum memory to be used for query work…

Gets one configuration (also known as server parameter) in an Azure Database for PostgreSQL flexible server with configuration name, server name, resource group, and subscription explicitly passed as arguments. If subscription is not passed explicitly, it's taken from default context.

Example 3: Get one configuration (also known as server parameter) corresponding to specific resource identifier

$ID = "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/example-resource-group/providers/Microsoft.DBforPostgreSQL/flexibleServers/example-server/configurations/work_mem"
Get-AzPostgreSqlFlexibleServerConfiguration -InputObject $ID

Name                                DataType        Value                AllowedValue         DefaultValue         Source          Description
----                                --------        -----                ------------         ------------         ------          -----------
work_mem                            Integer         4096                 4096-2097151         4096                 system-default  Sets the maximum memory to be used for query work…

Gets one configuration (also known as server parameter) in an Azure Database for PostgreSQL flexible server with the specific resource identifier of the configuration, explicitly passed as an argument.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FlexibleServerInputObject

Identity Parameter

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentityFlexibleServer

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Name of the configuration (also known as server parameter).

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ConfigurationName

Parameter sets

GetViaIdentityFlexibleServer

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ServerName

The name of the server.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:	String[]
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IConfiguration

Feedback

Was this page helpful?