We recommend using Azure Native.
azure.postgresql.FlexibleServer
Explore with Pulumi AI
Manages a PostgreSQL Flexible Server.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
AddressSpaces = new[]
{
"10.0.0.0/16",
},
});
var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
{
ResourceGroupName = exampleResourceGroup.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
ServiceEndpoints = new[]
{
"Microsoft.Storage",
},
Delegations = new[]
{
new Azure.Network.Inputs.SubnetDelegationArgs
{
Name = "fs",
ServiceDelegation = new Azure.Network.Inputs.SubnetDelegationServiceDelegationArgs
{
Name = "Microsoft.DBforPostgreSQL/flexibleServers",
Actions = new[]
{
"Microsoft.Network/virtualNetworks/subnets/join/action",
},
},
},
},
});
var exampleZone = new Azure.PrivateDns.Zone("exampleZone", new()
{
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleZoneVirtualNetworkLink = new Azure.PrivateDns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", new()
{
PrivateDnsZoneName = exampleZone.Name,
VirtualNetworkId = exampleVirtualNetwork.Id,
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleFlexibleServer = new Azure.PostgreSql.FlexibleServer("exampleFlexibleServer", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Version = "12",
DelegatedSubnetId = exampleSubnet.Id,
PrivateDnsZoneId = exampleZone.Id,
AdministratorLogin = "psqladmin",
AdministratorPassword = "H@Sh1CoR3!",
Zone = "1",
StorageMb = 32768,
SkuName = "GP_Standard_D4s_v3",
}, new CustomResourceOptions
{
DependsOn = new[]
{
exampleZoneVirtualNetworkLink,
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/postgresql"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatedns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
})
if err != nil {
return err
}
exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
ResourceGroupName: exampleResourceGroup.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
ServiceEndpoints: pulumi.StringArray{
pulumi.String("Microsoft.Storage"),
},
Delegations: network.SubnetDelegationArray{
&network.SubnetDelegationArgs{
Name: pulumi.String("fs"),
ServiceDelegation: &network.SubnetDelegationServiceDelegationArgs{
Name: pulumi.String("Microsoft.DBforPostgreSQL/flexibleServers"),
Actions: pulumi.StringArray{
pulumi.String("Microsoft.Network/virtualNetworks/subnets/join/action"),
},
},
},
},
})
if err != nil {
return err
}
exampleZone, err := privatedns.NewZone(ctx, "exampleZone", &privatedns.ZoneArgs{
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
exampleZoneVirtualNetworkLink, err := privatedns.NewZoneVirtualNetworkLink(ctx, "exampleZoneVirtualNetworkLink", &privatedns.ZoneVirtualNetworkLinkArgs{
PrivateDnsZoneName: exampleZone.Name,
VirtualNetworkId: exampleVirtualNetwork.ID(),
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
_, err = postgresql.NewFlexibleServer(ctx, "exampleFlexibleServer", &postgresql.FlexibleServerArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Version: pulumi.String("12"),
DelegatedSubnetId: exampleSubnet.ID(),
PrivateDnsZoneId: exampleZone.ID(),
AdministratorLogin: pulumi.String("psqladmin"),
AdministratorPassword: pulumi.String("H@Sh1CoR3!"),
Zone: pulumi.String("1"),
StorageMb: pulumi.Int(32768),
SkuName: pulumi.String("GP_Standard_D4s_v3"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleZoneVirtualNetworkLink,
}))
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationServiceDelegationArgs;
import com.pulumi.azure.privatedns.Zone;
import com.pulumi.azure.privatedns.ZoneArgs;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLink;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLinkArgs;
import com.pulumi.azure.postgresql.FlexibleServer;
import com.pulumi.azure.postgresql.FlexibleServerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.addressSpaces("10.0.0.0/16")
.build());
var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.serviceEndpoints("Microsoft.Storage")
.delegations(SubnetDelegationArgs.builder()
.name("fs")
.serviceDelegation(SubnetDelegationServiceDelegationArgs.builder()
.name("Microsoft.DBforPostgreSQL/flexibleServers")
.actions("Microsoft.Network/virtualNetworks/subnets/join/action")
.build())
.build())
.build());
var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleZoneVirtualNetworkLink = new ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", ZoneVirtualNetworkLinkArgs.builder()
.privateDnsZoneName(exampleZone.name())
.virtualNetworkId(exampleVirtualNetwork.id())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleFlexibleServer = new FlexibleServer("exampleFlexibleServer", FlexibleServerArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.version("12")
.delegatedSubnetId(exampleSubnet.id())
.privateDnsZoneId(exampleZone.id())
.administratorLogin("psqladmin")
.administratorPassword("H@Sh1CoR3!")
.zone("1")
.storageMb(32768)
.skuName("GP_Standard_D4s_v3")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleZoneVirtualNetworkLink)
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
resource_group_name=example_resource_group.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"],
service_endpoints=["Microsoft.Storage"],
delegations=[azure.network.SubnetDelegationArgs(
name="fs",
service_delegation=azure.network.SubnetDelegationServiceDelegationArgs(
name="Microsoft.DBforPostgreSQL/flexibleServers",
actions=["Microsoft.Network/virtualNetworks/subnets/join/action"],
),
)])
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink",
private_dns_zone_name=example_zone.name,
virtual_network_id=example_virtual_network.id,
resource_group_name=example_resource_group.name)
example_flexible_server = azure.postgresql.FlexibleServer("exampleFlexibleServer",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
version="12",
delegated_subnet_id=example_subnet.id,
private_dns_zone_id=example_zone.id,
administrator_login="psqladmin",
administrator_password="H@Sh1CoR3!",
zone="1",
storage_mb=32768,
sku_name="GP_Standard_D4s_v3",
opts=pulumi.ResourceOptions(depends_on=[example_zone_virtual_network_link]))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
resourceGroupName: exampleResourceGroup.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
serviceEndpoints: ["Microsoft.Storage"],
delegations: [{
name: "fs",
serviceDelegation: {
name: "Microsoft.DBforPostgreSQL/flexibleServers",
actions: ["Microsoft.Network/virtualNetworks/subnets/join/action"],
},
}],
});
const exampleZone = new azure.privatedns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleZoneVirtualNetworkLink = new azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", {
privateDnsZoneName: exampleZone.name,
virtualNetworkId: exampleVirtualNetwork.id,
resourceGroupName: exampleResourceGroup.name,
});
const exampleFlexibleServer = new azure.postgresql.FlexibleServer("exampleFlexibleServer", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
version: "12",
delegatedSubnetId: exampleSubnet.id,
privateDnsZoneId: exampleZone.id,
administratorLogin: "psqladmin",
administratorPassword: "H@Sh1CoR3!",
zone: "1",
storageMb: 32768,
skuName: "GP_Standard_D4s_v3",
}, {
dependsOn: [exampleZoneVirtualNetworkLink],
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
addressSpaces:
- 10.0.0.0/16
exampleSubnet:
type: azure:network:Subnet
properties:
resourceGroupName: ${exampleResourceGroup.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
serviceEndpoints:
- Microsoft.Storage
delegations:
- name: fs
serviceDelegation:
name: Microsoft.DBforPostgreSQL/flexibleServers
actions:
- Microsoft.Network/virtualNetworks/subnets/join/action
exampleZone:
type: azure:privatedns:Zone
properties:
resourceGroupName: ${exampleResourceGroup.name}
exampleZoneVirtualNetworkLink:
type: azure:privatedns:ZoneVirtualNetworkLink
properties:
privateDnsZoneName: ${exampleZone.name}
virtualNetworkId: ${exampleVirtualNetwork.id}
resourceGroupName: ${exampleResourceGroup.name}
exampleFlexibleServer:
type: azure:postgresql:FlexibleServer
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
version: '12'
delegatedSubnetId: ${exampleSubnet.id}
privateDnsZoneId: ${exampleZone.id}
administratorLogin: psqladmin
administratorPassword: H@Sh1CoR3!
zone: '1'
storageMb: 32768
skuName: GP_Standard_D4s_v3
options:
dependson:
- ${exampleZoneVirtualNetworkLink}
Create FlexibleServer Resource
new FlexibleServer(name: string, args: FlexibleServerArgs, opts?: CustomResourceOptions);
@overload
def FlexibleServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
administrator_login: Optional[str] = None,
administrator_password: Optional[str] = None,
authentication: Optional[FlexibleServerAuthenticationArgs] = None,
backup_retention_days: Optional[int] = None,
create_mode: Optional[str] = None,
customer_managed_key: Optional[FlexibleServerCustomerManagedKeyArgs] = None,
delegated_subnet_id: Optional[str] = None,
geo_redundant_backup_enabled: Optional[bool] = None,
high_availability: Optional[FlexibleServerHighAvailabilityArgs] = None,
identity: Optional[FlexibleServerIdentityArgs] = None,
location: Optional[str] = None,
maintenance_window: Optional[FlexibleServerMaintenanceWindowArgs] = None,
name: Optional[str] = None,
point_in_time_restore_time_in_utc: Optional[str] = None,
private_dns_zone_id: Optional[str] = None,
replication_role: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku_name: Optional[str] = None,
source_server_id: Optional[str] = None,
storage_mb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
version: Optional[str] = None,
zone: Optional[str] = None)
@overload
def FlexibleServer(resource_name: str,
args: FlexibleServerArgs,
opts: Optional[ResourceOptions] = None)
func NewFlexibleServer(ctx *Context, name string, args FlexibleServerArgs, opts ...ResourceOption) (*FlexibleServer, error)
public FlexibleServer(string name, FlexibleServerArgs args, CustomResourceOptions? opts = null)
public FlexibleServer(String name, FlexibleServerArgs args)
public FlexibleServer(String name, FlexibleServerArgs args, CustomResourceOptions options)
type: azure:postgresql:FlexibleServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FlexibleServer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The FlexibleServer resource accepts the following input properties:
- Resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- Administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- Authentication
Flexible
Server Authentication An
authentication
block as defined below.- Backup
Retention intDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- Create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- Customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- Delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- Geo
Redundant boolBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- High
Availability FlexibleServer High Availability A
high_availability
block as defined below.- Identity
Flexible
Server Identity An
identity
block as defined below.- Location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- Name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- Point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- Private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- Replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- Sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- Source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- Storage
Mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Dictionary<string, string>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- Version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- Zone string
- Resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- Administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- Authentication
Flexible
Server Authentication Args An
authentication
block as defined below.- Backup
Retention intDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- Create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- Customer
Managed FlexibleKey Server Customer Managed Key Args A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- Delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- Geo
Redundant boolBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- High
Availability FlexibleServer High Availability Args A
high_availability
block as defined below.- Identity
Flexible
Server Identity Args An
identity
block as defined below.- Location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Maintenance
Window FlexibleServer Maintenance Window Args A
maintenance_window
block as defined below.- Name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- Point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- Private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- Replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- Sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- Source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- Storage
Mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- map[string]string
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- Version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- Zone string
- resource
Group StringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- administrator
Login String The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password String The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication An
authentication
block as defined below.- backup
Retention IntegerDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode String The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet StringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- geo
Redundant BooleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability FlexibleServer High Availability A
high_availability
block as defined below.- identity
Flexible
Server Identity An
identity
block as defined below.- location String
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- name String
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In StringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns StringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- replication
Role String The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- sku
Name String The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server StringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb Integer The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Map<String,String>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version String
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone String
- resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication An
authentication
block as defined below.- backup
Retention numberDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- geo
Redundant booleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability FlexibleServer High Availability A
high_availability
block as defined below.- identity
Flexible
Server Identity An
identity
block as defined below.- location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb number The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- {[key: string]: string}
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone string
- resource_
group_ strname The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- administrator_
login str The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator_
password str The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication Args An
authentication
block as defined below.- backup_
retention_ intdays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create_
mode str The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer_
managed_ Flexiblekey Server Customer Managed Key Args A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated_
subnet_ strid The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- geo_
redundant_ boolbackup_ enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high_
availability FlexibleServer High Availability Args A
high_availability
block as defined below.- identity
Flexible
Server Identity Args An
identity
block as defined below.- location str
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance_
window FlexibleServer Maintenance Window Args A
maintenance_window
block as defined below.- name str
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point_
in_ strtime_ restore_ time_ in_ utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private_
dns_ strzone_ id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- replication_
role str The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- sku_
name str The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source_
server_ strid The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage_
mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Mapping[str, str]
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version str
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone str
- resource
Group StringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- administrator
Login String The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password String The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication Property Map
An
authentication
block as defined below.- backup
Retention NumberDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode String The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed Property MapKey A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet StringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- geo
Redundant BooleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability Property Map A
high_availability
block as defined below.- identity Property Map
An
identity
block as defined below.- location String
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window Property Map A
maintenance_window
block as defined below.- name String
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In StringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns StringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- replication
Role String The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- sku
Name String The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server StringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb Number The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Map<String>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version String
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone String
Outputs
All input properties are implicitly available as output properties. Additionally, the FlexibleServer resource produces the following output properties:
- Fqdn string
The FQDN of the PostgreSQL Flexible Server.
- Id string
The provider-assigned unique ID for this managed resource.
- Public
Network boolAccess Enabled Is public network access enabled?
- Fqdn string
The FQDN of the PostgreSQL Flexible Server.
- Id string
The provider-assigned unique ID for this managed resource.
- Public
Network boolAccess Enabled Is public network access enabled?
- fqdn String
The FQDN of the PostgreSQL Flexible Server.
- id String
The provider-assigned unique ID for this managed resource.
- public
Network BooleanAccess Enabled Is public network access enabled?
- fqdn string
The FQDN of the PostgreSQL Flexible Server.
- id string
The provider-assigned unique ID for this managed resource.
- public
Network booleanAccess Enabled Is public network access enabled?
- fqdn str
The FQDN of the PostgreSQL Flexible Server.
- id str
The provider-assigned unique ID for this managed resource.
- public_
network_ boolaccess_ enabled Is public network access enabled?
- fqdn String
The FQDN of the PostgreSQL Flexible Server.
- id String
The provider-assigned unique ID for this managed resource.
- public
Network BooleanAccess Enabled Is public network access enabled?
Look up Existing FlexibleServer Resource
Get an existing FlexibleServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FlexibleServerState, opts?: CustomResourceOptions): FlexibleServer
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
administrator_login: Optional[str] = None,
administrator_password: Optional[str] = None,
authentication: Optional[FlexibleServerAuthenticationArgs] = None,
backup_retention_days: Optional[int] = None,
create_mode: Optional[str] = None,
customer_managed_key: Optional[FlexibleServerCustomerManagedKeyArgs] = None,
delegated_subnet_id: Optional[str] = None,
fqdn: Optional[str] = None,
geo_redundant_backup_enabled: Optional[bool] = None,
high_availability: Optional[FlexibleServerHighAvailabilityArgs] = None,
identity: Optional[FlexibleServerIdentityArgs] = None,
location: Optional[str] = None,
maintenance_window: Optional[FlexibleServerMaintenanceWindowArgs] = None,
name: Optional[str] = None,
point_in_time_restore_time_in_utc: Optional[str] = None,
private_dns_zone_id: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
replication_role: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku_name: Optional[str] = None,
source_server_id: Optional[str] = None,
storage_mb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
version: Optional[str] = None,
zone: Optional[str] = None) -> FlexibleServer
func GetFlexibleServer(ctx *Context, name string, id IDInput, state *FlexibleServerState, opts ...ResourceOption) (*FlexibleServer, error)
public static FlexibleServer Get(string name, Input<string> id, FlexibleServerState? state, CustomResourceOptions? opts = null)
public static FlexibleServer get(String name, Output<String> id, FlexibleServerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- Administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- Authentication
Flexible
Server Authentication An
authentication
block as defined below.- Backup
Retention intDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- Create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- Customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- Delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- Fqdn string
The FQDN of the PostgreSQL Flexible Server.
- Geo
Redundant boolBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- High
Availability FlexibleServer High Availability A
high_availability
block as defined below.- Identity
Flexible
Server Identity An
identity
block as defined below.- Location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- Name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- Point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- Private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- Public
Network boolAccess Enabled Is public network access enabled?
- Replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- Resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- Source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- Storage
Mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Dictionary<string, string>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- Version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- Zone string
- Administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- Administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- Authentication
Flexible
Server Authentication Args An
authentication
block as defined below.- Backup
Retention intDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- Create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- Customer
Managed FlexibleKey Server Customer Managed Key Args A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- Delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- Fqdn string
The FQDN of the PostgreSQL Flexible Server.
- Geo
Redundant boolBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- High
Availability FlexibleServer High Availability Args A
high_availability
block as defined below.- Identity
Flexible
Server Identity Args An
identity
block as defined below.- Location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Maintenance
Window FlexibleServer Maintenance Window Args A
maintenance_window
block as defined below.- Name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- Point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- Private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- Public
Network boolAccess Enabled Is public network access enabled?
- Replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- Resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- Sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- Source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- Storage
Mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- map[string]string
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- Version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- Zone string
- administrator
Login String The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password String The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication An
authentication
block as defined below.- backup
Retention IntegerDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode String The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet StringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- fqdn String
The FQDN of the PostgreSQL Flexible Server.
- geo
Redundant BooleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability FlexibleServer High Availability A
high_availability
block as defined below.- identity
Flexible
Server Identity An
identity
block as defined below.- location String
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- name String
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In StringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns StringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- public
Network BooleanAccess Enabled Is public network access enabled?
- replication
Role String The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- resource
Group StringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- sku
Name String The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server StringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb Integer The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Map<String,String>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version String
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone String
- administrator
Login string The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password string The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication An
authentication
block as defined below.- backup
Retention numberDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode string The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed FlexibleKey Server Customer Managed Key A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet stringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- fqdn string
The FQDN of the PostgreSQL Flexible Server.
- geo
Redundant booleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability FlexibleServer High Availability A
high_availability
block as defined below.- identity
Flexible
Server Identity An
identity
block as defined below.- location string
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window FlexibleServer Maintenance Window A
maintenance_window
block as defined below.- name string
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In stringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns stringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- public
Network booleanAccess Enabled Is public network access enabled?
- replication
Role string The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- resource
Group stringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- sku
Name string The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server stringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb number The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- {[key: string]: string}
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version string
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone string
- administrator_
login str The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator_
password str The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication
Flexible
Server Authentication Args An
authentication
block as defined below.- backup_
retention_ intdays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create_
mode str The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer_
managed_ Flexiblekey Server Customer Managed Key Args A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated_
subnet_ strid The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- fqdn str
The FQDN of the PostgreSQL Flexible Server.
- geo_
redundant_ boolbackup_ enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high_
availability FlexibleServer High Availability Args A
high_availability
block as defined below.- identity
Flexible
Server Identity Args An
identity
block as defined below.- location str
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance_
window FlexibleServer Maintenance Window Args A
maintenance_window
block as defined below.- name str
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point_
in_ strtime_ restore_ time_ in_ utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private_
dns_ strzone_ id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- public_
network_ boolaccess_ enabled Is public network access enabled?
- replication_
role str The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- resource_
group_ strname The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- sku_
name str The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source_
server_ strid The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage_
mb int The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Mapping[str, str]
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version str
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone str
- administrator
Login String The Administrator login for the PostgreSQL Flexible Server. Required when
create_mode
isDefault
andauthentication.password_auth_enabled
istrue
.Note: Once
administrator_login
is specified, changing this forces a new PostgreSQL Flexible Server to be created.Note: To create with
administrator_login
specified or update with it first specified ,authentication.password_auth_enabled
must be set totrue
.- administrator
Password String The Password associated with the
administrator_login
for the PostgreSQL Flexible Server. Required whencreate_mode
isDefault
andauthentication.password_auth_enabled
istrue
.- authentication Property Map
An
authentication
block as defined below.- backup
Retention NumberDays The backup retention days for the PostgreSQL Flexible Server. Possible values are between
7
and35
days.- create
Mode String The creation mode which can be used to restore or replicate existing servers. Possible values are
Default
,PointInTimeRestore
,Replica
andUpdate
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: While creating the resource,
create_mode
cannot be set toUpdate
.- customer
Managed Property MapKey A
customer_managed_key
block as defined below. Changing this forces a new resource to be created.- delegated
Subnet StringId The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.
- fqdn String
The FQDN of the PostgreSQL Flexible Server.
- geo
Redundant BooleanBackup Enabled Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to
false
. Changing this forces a new PostgreSQL Flexible Server to be created.- high
Availability Property Map A
high_availability
block as defined below.- identity Property Map
An
identity
block as defined below.- location String
The Azure Region where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- maintenance
Window Property Map A
maintenance_window
block as defined below.- name String
The name which should be used for this PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
Note This must be unique across the entire Azure service, not just within the resource group.
- point
In StringTime Restore Time In Utc The point in time to restore from
source_server_id
whencreate_mode
isPointInTimeRestore
. Changing this forces a new PostgreSQL Flexible Server to be created.- private
Dns StringZone Id The ID of the private DNS zone to create the PostgreSQL Flexible Server. Changing this forces a new PostgreSQL Flexible Server to be created.
NOTE: There will be a breaking change from upstream service at 15th July 2021, the
private_dns_zone_id
will be required when setting adelegated_subnet_id
. For existing flexible servers who don't want to be recreated, you need to provide theprivate_dns_zone_id
to the service team to manually migrate to the specified private DNS zone. Theazure.privatedns.Zone
should end with suffix.postgres.database.azure.com
.- public
Network BooleanAccess Enabled Is public network access enabled?
- replication
Role String The replication role for the PostgreSQL Flexible Server. Possible value is
None
.NOTE: The
replication_role
cannot be set while creating and only can be updated toNone
for replica server.- resource
Group StringName The name of the Resource Group where the PostgreSQL Flexible Server should exist. Changing this forces a new PostgreSQL Flexible Server to be created.
- sku
Name String The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the
tier
+name
pattern (e.g.B_Standard_B1ms
,GP_Standard_D2s_v3
,MO_Standard_E4s_v3
).- source
Server StringId The resource ID of the source PostgreSQL Flexible Server to be restored. Required when
create_mode
isPointInTimeRestore
orReplica
. Changing this forces a new PostgreSQL Flexible Server to be created.- storage
Mb Number The max storage allowed for the PostgreSQL Flexible Server. Possible values are
32768
,65536
,131072
,262144
,524288
,1048576
,2097152
,4194304
,8388608
,16777216
and33553408
.- Map<String>
A mapping of tags which should be assigned to the PostgreSQL Flexible Server.
- version String
The version of PostgreSQL Flexible Server to use. Possible values are
11
,12
,13
,14
and15
. Required whencreate_mode
isDefault
. Changing this forces a new PostgreSQL Flexible Server to be created.Note: When
create_mode
isUpdate
, upgrading version wouldn't force a new resource to be created.- zone String
Supporting Types
FlexibleServerAuthentication, FlexibleServerAuthenticationArgs
- Active
Directory boolAuth Enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- Password
Auth boolEnabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- Tenant
Id string The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
- Active
Directory boolAuth Enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- Password
Auth boolEnabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- Tenant
Id string The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
- active
Directory BooleanAuth Enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- password
Auth BooleanEnabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- tenant
Id String The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
- active
Directory booleanAuth Enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- password
Auth booleanEnabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- tenant
Id string The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
- active_
directory_ boolauth_ enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- password_
auth_ boolenabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- tenant_
id str The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
- active
Directory BooleanAuth Enabled Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
false
.- password
Auth BooleanEnabled Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to
true
.- tenant
Id String The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication.
active_directory_auth_enabled
must be set totrue
.Note: Setting
active_directory_auth_enabled
totrue
requires a Service Principal for the Postgres Flexible Server. For more details see this document.Note:
tenant_id
is required whenactive_directory_auth_enabled
is set totrue
. And it should not be specified whenactive_directory_auth_enabled
is set tofalse
FlexibleServerCustomerManagedKey, FlexibleServerCustomerManagedKeyArgs
- Geo
Backup stringKey Vault Key Id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- Geo
Backup stringUser Assigned Identity Id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- Key
Vault stringKey Id The ID of the Key Vault Key.
- Primary
User stringAssigned Identity Id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
- Geo
Backup stringKey Vault Key Id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- Geo
Backup stringUser Assigned Identity Id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- Key
Vault stringKey Id The ID of the Key Vault Key.
- Primary
User stringAssigned Identity Id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
- geo
Backup StringKey Vault Key Id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geo
Backup StringUser Assigned Identity Id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- key
Vault StringKey Id The ID of the Key Vault Key.
- primary
User StringAssigned Identity Id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
- geo
Backup stringKey Vault Key Id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geo
Backup stringUser Assigned Identity Id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- key
Vault stringKey Id The ID of the Key Vault Key.
- primary
User stringAssigned Identity Id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
- geo_
backup_ strkey_ vault_ key_ id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geo_
backup_ struser_ assigned_ identity_ id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- key_
vault_ strkey_ id The ID of the Key Vault Key.
- primary_
user_ strassigned_ identity_ id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
- geo
Backup StringKey Vault Key Id The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geo
Backup StringUser Assigned Identity Id The geo backup user managed identity id for a Customer Managed Key. Should be added with
identity_ids
. It can't cross region and need identity in same region as geo backup.NOTE:
primary_user_assigned_identity_id
orgeo_backup_user_assigned_identity_id
is required whentype
is set toUserAssigned
.- key
Vault StringKey Id The ID of the Key Vault Key.
- primary
User StringAssigned Identity Id Specifies the primary user managed identity id for a Customer Managed Key. Should be added with
identity_ids
.
FlexibleServerHighAvailability, FlexibleServerHighAvailabilityArgs
- Mode string
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- Standby
Availability stringZone
- Mode string
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- Standby
Availability stringZone
- mode String
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- standby
Availability StringZone
- mode string
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- standby
Availability stringZone
- mode str
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- standby_
availability_ strzone
- mode String
The high availability mode for the PostgreSQL Flexible Server. Possible value are
SameZone
orZoneRedundant
.- standby
Availability StringZone
FlexibleServerIdentity, FlexibleServerIdentityArgs
- Identity
Ids List<string> A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- Type string
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
- Identity
Ids []string A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- Type string
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- type String
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
- identity
Ids string[] A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- type string
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
- identity_
ids Sequence[str] A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- type str
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this PostgreSQL Flexible Server. Required if used together with
customer_managed_key
block.- type String
Specifies the type of Managed Service Identity that should be configured on this PostgreSQL Flexible Server. The only possible value is
UserAssigned
.
FlexibleServerMaintenanceWindow, FlexibleServerMaintenanceWindowArgs
- Day
Of intWeek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- Start
Hour int The start hour for maintenance window. Defaults to
0
.- Start
Minute int The start minute for maintenance window. Defaults to
0
.
- Day
Of intWeek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- Start
Hour int The start hour for maintenance window. Defaults to
0
.- Start
Minute int The start minute for maintenance window. Defaults to
0
.
- day
Of IntegerWeek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- start
Hour Integer The start hour for maintenance window. Defaults to
0
.- start
Minute Integer The start minute for maintenance window. Defaults to
0
.
- day
Of numberWeek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- start
Hour number The start hour for maintenance window. Defaults to
0
.- start
Minute number The start minute for maintenance window. Defaults to
0
.
- day_
of_ intweek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- start_
hour int The start hour for maintenance window. Defaults to
0
.- start_
minute int The start minute for maintenance window. Defaults to
0
.
- day
Of NumberWeek The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday =
0
, Monday =1
. Defaults to0
.- start
Hour Number The start hour for maintenance window. Defaults to
0
.- start
Minute Number The start minute for maintenance window. Defaults to
0
.
Import
PostgreSQL Flexible Servers can be imported using the resource id
, e.g.
$ pulumi import azure:postgresql/flexibleServer:FlexibleServer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforPostgreSQL/flexibleServers/server1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.