Edit

Share via

Get-AzPostgreSqlConnectionString

  • Reference
Module:
Az.PostgreSql

Get the connection string according to client connection provider.

Syntax

Get-AzPostgreSqlConnectionString
   -Client <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPostgreSqlConnectionString
   -Client <String>
   -InputObject <IServer>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the connection string according to client connection provider.

Examples

Example 1: Get PostgreSql server connection string by resource group and server name

Get-AzPostgreSqlConnectionString -Client ADO.NET -Name PostgreSqlTestServer -ResourceGroupName PostgreSqlTestRG

Server=postgresqltestserver.postgres.database.azure.com;Database={your_database};Port=5432;User Id=pwsh@postgresqltestserver;Password={your_password};Ssl Mode=Require;

This cmdlet gets PostgreSql server connection string by resource group and server name.

Example 2: Get PostgreSql server connection string by identity

Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Get-AzPostgreSqlConnectionString -Client PHP

host=postgresqltestserver.postgres.database.azure.com port=5432 dbname={your_database} user=pwsh@postgresqltestserver password={your_password} sslmode=require

This cmdlet gets PostgreSql server connection string by identity.

Parameters

-Client

Client connection provider.

Type:String
Position:Named
Default value:None
Required:True
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 server for the connection string 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

-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 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

-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

Inputs

IServer

Outputs

String

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 server for the connection string

  • 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.