New-AzPostgreSqlFlexibleServer
Creates a new server.
Syntax
New-AzPostgreSqlFlexibleServer
[-Name <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String>]
[-AdministratorLoginPassword <SecureString>]
[-AdministratorUserName <String>]
[-BackupRetentionDay <Int32>]
[-HaEnabled <String>]
[-Location <String>]
[-PrivateDnsZone <String>]
[-PublicAccess <String>]
[-Sku <String>]
[-SkuTier <String>]
[-StorageInMb <Int32>]
[-Subnet <String>]
[-SubnetPrefix <String>]
[-Tag <Hashtable>]
[-Version <ServerVersion>]
[-Vnet <String>]
[-VnetPrefix <String>]
[-Zone <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Description
Creates a new server.
Examples
Example 1: Create a new PostgreSql Flexible Server with arguments
New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest `
-Location eastus -AdministratorUserName postgresqltest -AdministratorLoginPassword $password -Sku Standard_D2s_v3 -SkuTier GeneralPurpose -Version 12 -StorageInMb 131072 -PublicAccess none
Checking the existence of the resource group PowershellPostgreSqlTest ...
Resource group PowershellPostgreSqlTest exists ? : True
Creating PostgreSQL server postgresql-test in group PostgreSqlTest...
Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128Example 2: Create a new PostgreSql Flexible Server with default setting
$server = New-AzPostgreSqlFlexibleServer
Creating resource group group00000000...
Creating PostgreSQL server server00000000 in group group00000000...
Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server with default parameter values and provision the server with public access enabled. The default values of location is East US 2, Sku is Standard_D2s_v3, Sku tier is GeneralPurpose, and storage size is 128GiB.
If you want to find the auto-generated password for your server, use ConvertFrom-SecureString to convert 'SecuredPassword' property to plain text. (E.g., $server.SecuredPassword | ConvertFrom-SecureString -AsPlainText)
Example 3: Create a new PostgreSql Flexible Server with existing Subnet
$Subnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname'
$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com'
New-AzPostgreSqlFlexibleServer -ResourceGroupName postgresqltest -ServerName testserver -Subnet $Subnet -PrivateDnsZone $DnsZone
Resource group PowershellPostgreSqlTest exists ? : True
You have supplied a subnet Id.
Verifying its existence...
Creating PostgreSQL server testserver in group PowershellPostgreSqlTest...
Your server server00000000 is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Creating database flexibleserverdb...
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server with an existing Subnet Id provided by a user. The subnet will be delegated to PostgreSQL Flexible Server if not already delegated. You cannot use a subnet delegated to different services. the subnet can be in a different resource group.
Example 4: Create a new PostgreSql Flexible Server with virtual network and subnet name
New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -Vnet postgresql-vnet -Subnet postgresql-subnet -VnetPrefix 10.0.0.0/16 -SubnetPrefix 10.0.0.0/24 -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/postgresql-test.private.postgres.database.azure.com
Resource group PowershellPostgreSqlTest exists ? : True
Creating new vnet postgresql-vnet in resource group PowershellPostgreSqlTest
Creating new subnet postgresql-subnet in resource group PowershellPostgreSqlTest and delegating it to Microsoft.DBforPostgreSQL/flexibleServers
Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest...
Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Creating database flexibleserverdb...
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server with vnet name, subnet name, vnet prefix, and subnet prefix. If the virtual network and subnet don't exist, the cmdlet creates one.
Example 5: Create a new PostgreSql Flexible Server with virtual network
$Vnet = 'vnetname'
New-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Vnet $Vnet -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com
# or
$Vnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname'
New-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Vnet $Vnet -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com
Resource group PowershellPostgreSqlTest exists ? : True
You have supplied a vnet Id/name.
Verifying its existence...
Creating new vnet vnetname in resource group PowershellPostgreSqlTest
Creating new subnet Subnetserver00000000 in resource group PowershellPostgreSqlTest and delegating it to Microsoft.DBforPostgreSQL/flexibleServers
Creating PostgreSQL server server00000000 in group PowershellPostgreSqlTest...
Your server server00000000 is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Creating database flexibleserverdb...
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server with vnet id or vnet name provided by a user. If the virtual network doesn't exist, the cmdlet creates one.
Example 6: Create a new PostgreSql Flexible Server with public access to all IPs
New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -PublicAccess All
Resource group PowershellPostgreSqlTest exists ? : True
Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest...
Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Creating database flexibleserverdb...
Configuring server firewall rule to accept connections from 0.0.0.0 to 255.255.255.255
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server open to all IP addresses.
Example 7: Create a new PostgreSql Flexible Server with firewall
New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -PublicAccess 10.10.10.10-10.10.10.12
Resource group PowershellPostgreSqlTest exists ? : True
Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest...
Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier).
Please refer to https://aka.ms/postgresql-pricing for pricing details
Creating database flexibleserverdb...
Configuring server firewall rule to accept connections from 10.10.10.10 to 10.10.10.12
Name Location SkuName SkuTier AdministratorLogin StorageSizeGb
---- -------- ------- ------- ------------------ -------------
postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128This cmdlet creates PostgreSql Flexible Server open to specified IP addresses.
Parameters
-AdministratorLoginPassword
The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AdministratorUserName
Administrator username for the server. Once set, it cannot be changed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupRetentionDay
Backup retention days for the server. Day count is between 7 and 35.
| Type: | Int32 |
| 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 |
-HaEnabled
Enable or disable high availability feature. Allowed values: Enabled, Disabled
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The location the resource resides in.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the server.
| Type: | String |
| Aliases: | ServerName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-PrivateDnsZone
The id of an existing private dns zone. You can use the private dns zone from same resource group, different resource group, or different subscription. The suffix of dns zone has to be same as that of fully qualified domain of the server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublicAccess
Determines the public access. Enter single or range of IP addresses to be included in the allowed list of IPs. IP address ranges must be dash- separated and not contain any spaces. Specifying 0.0.0.0 allows public access from any resources deployed within Azure to access your server. Specifying no IP address sets the server in public access mode but does not create a firewall rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sku
The name of the sku, typically, tier + family + cores, e.g. Standard_B1ms, Standard_D2s_v3.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkuTier
Compute tier of the server. Accepted values: Burstable, GeneralPurpose, Memory Optimized. Default: Burstable.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageInMb
Max storage allowed for a server.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Subnet
The Name or Id of an existing Subnet or name of a new one to create. Please note that the subnet will be delegated to Microsoft.DBforPostgreSQL/flexibleServers. After delegation, this subnet cannot be used for any other type of Azure resources.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubnetPrefix
The subnet IP address prefix to use when creating a new vnet in CIDR format. Default value is 10.0.0.0/24.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Tag
Application-specific metadata in the form of key-value pairs.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
Server version.
| Type: | ServerVersion |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Vnet
The Name or Id of an existing virtual network or name of a new one to create. The name must be between 2 to 64 characters. The name must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VnetPrefix
The IP address prefix to use when creating a new vnet in CIDR format. Default value is 10.0.0.0/16.
| Type: | String |
| Position: | Named |
| Default value: | None |
| 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 |
-Zone
Availability zone into which to provision the resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Notes
ALIASES
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for