Skip to content

Latest commit

 

History

History
184 lines (144 loc) · 4.95 KB

Get-AzPostgreSqlFlexibleServerConfiguration.md

File metadata and controls

184 lines (144 loc) · 4.95 KB
Raw
external help file Module Name online version schema
Az.PostgreSql-help.xml
Az.PostgreSql
2.0.0

Get-AzPostgreSqlFlexibleServerConfiguration

SYNOPSIS

Gets information about a configuration of server.

SYNTAX

List (Default)

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

Get

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

GetViaIdentity

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

DESCRIPTION

Gets information about a configuration of server.

EXAMPLES

Example 1: Get specified PostgreSql configuration by name

Get-AzPostgreSqlFlexibleServerConfiguration -Name work_mem -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test
Name     Value AllowedValue Source         DefaultValue
----     ----- ------------ ------         ------------
work_mem 4096  4096-2097151 system-default 4096

This cmdlet gets specified PostgreSql configuration by name.

Example 2: List all configurations in specified PostgreSql server

Get-AzPostgreSqlFlexibleServerConfiguration -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test
Name                                       Value                      AllowedValue
----                                       -----                      ------------
application_name                                                      [A-Za-z0-9._-]*
array_nulls                                on                         on,off
autovacuum                                 on                         on,off
autovacuum_analyze_scale_factor            0.1                        0-100
...
work_mem                                   4096                       4096-2097151
xmlbinary                                  base64                     base64,hex
xmloption                                  content                    content,document
intelligent_tuning                         off                        on,off
require_secure_transport                   on                         on,off
pgbouncer.enabled                          false                      true, false

This cmdlet lists all configurations in specified PostgreSql server.

PARAMETERS

-DefaultProfile

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

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
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: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the server configuration.

Type: System.String
Parameter Sets: Get
Aliases: ConfigurationName

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

-ResourceGroupName

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

Type: System.String
Parameter Sets: List, Get
Aliases:

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

-ServerName

The name of the server.

Type: System.String
Parameter Sets: List, Get
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: List, Get
Aliases:

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

CommonParameters

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

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IConfigurationAutoGenerated

NOTES

RELATED LINKS