Module postgresql

@pulumi/azure > postgresql

Index

postgresql/configuration.ts postgresql/database.ts postgresql/firewallRule.ts postgresql/server.ts postgresql/virtualNetworkRule.ts

class Configuration

Sets a PostgreSQL Configuration value on a PostgreSQL Server.

constructor

new Configuration(name: string, args: ConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a Configuration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationState): Configuration

Get an existing Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the PostgreSQL Configuration, which needs to be a valid PostgreSQL configuration name. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

Specifies the value of the PostgreSQL Configuration. See the PostgreSQL documentation for valid values.

class Database

Manages a PostgreSQL Database within a PostgreSQL Server

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState): Database

Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property charset

public charset: pulumi.Output<string>;

Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created.

property collation

public collation: pulumi.Output<string>;

Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation - en-US instead of en_US. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class FirewallRule

Manages a Firewall Rule for a PostgreSQL Server

constructor

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallRuleState): FirewallRule

Get an existing FirewallRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endIpAddress

public endIpAddress: pulumi.Output<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the PostgreSQL Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property startIpAddress

public startIpAddress: pulumi.Output<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Server

Manage a PostgreSQL Server.

constructor

new Server(name: string, args: ServerArgs, opts?: pulumi.CustomResourceOptions)

Create a Server resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServerState): Server

Get an existing Server resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administratorLogin

public administratorLogin: pulumi.Output<string>;

The Administrator Login for the PostgreSQL Server. Changing this forces a new resource to be created.

property administratorLoginPassword

public administratorLoginPassword: pulumi.Output<string>;

The Password associated with the administrator_login for the PostgreSQL Server.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the PostgreSQL Server.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the SKU Name for this PostgreSQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the PostgreSQL Server. Changing this forces a new resource to be created.

property sku

public sku: pulumi.Output<{ ... }>;

A sku block as defined below.

property sslEnforcement

public sslEnforcement: pulumi.Output<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

public storageProfile: pulumi.Output<{ ... }>;

A storage_profile block as defined below.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

Specifies the version of PostgreSQL to use. Valid values are 9.5, 9.6, and 10.0. Changing this forces a new resource to be created.

class VirtualNetworkRule

Manages a PostgreSQL Virtual Network Rule.

-> NOTE: PostgreSQL Virtual Network Rules can only be used with SKU Tiers of GeneralPurpose or MemoryOptimized

constructor

new VirtualNetworkRule(name: string, args: VirtualNetworkRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkRuleState): VirtualNetworkRule

Get an existing VirtualNetworkRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ignoreMissingVnetServiceEndpoint

public ignoreMissingVnetServiceEndpoint: pulumi.Output<boolean | undefined>;

Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled? Defaults to false.

property name

public name: pulumi.Output<string>;

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

public subnetId: pulumi.Output<string>;

The ID of the subnet that the PostgreSQL server will be connected to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface ConfigurationArgs

The set of arguments for constructing a Configuration resource.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Configuration, which needs to be a valid PostgreSQL configuration name. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property value

value: pulumi.Input<string>;

Specifies the value of the PostgreSQL Configuration. See the PostgreSQL documentation for valid values.

interface ConfigurationState

Input properties used for looking up and filtering Configuration resources.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Configuration, which needs to be a valid PostgreSQL configuration name. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property value

value?: pulumi.Input<string>;

Specifies the value of the PostgreSQL Configuration. See the PostgreSQL documentation for valid values.

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property charset

charset: pulumi.Input<string>;

Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created.

property collation

collation: pulumi.Input<string>;

Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation - en-US instead of en_US. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property charset

charset?: pulumi.Input<string>;

Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created.

property collation

collation?: pulumi.Input<string>;

Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation - en-US instead of en_US. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

interface FirewallRuleArgs

The set of arguments for constructing a FirewallRule resource.

property endIpAddress

endIpAddress: pulumi.Input<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property startIpAddress

startIpAddress: pulumi.Input<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

interface FirewallRuleState

Input properties used for looking up and filtering FirewallRule resources.

property endIpAddress

endIpAddress?: pulumi.Input<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

property startIpAddress

startIpAddress?: pulumi.Input<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

interface ServerArgs

The set of arguments for constructing a Server resource.

property administratorLogin

administratorLogin: pulumi.Input<string>;

The Administrator Login for the PostgreSQL Server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword: pulumi.Input<string>;

The Password associated with the administrator_login for the PostgreSQL Server.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the SKU Name for this PostgreSQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the PostgreSQL Server. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<{ ... }>;

A sku block as defined below.

property sslEnforcement

sslEnforcement: pulumi.Input<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

storageProfile: pulumi.Input<{ ... }>;

A storage_profile block as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property version

version: pulumi.Input<string>;

Specifies the version of PostgreSQL to use. Valid values are 9.5, 9.6, and 10.0. Changing this forces a new resource to be created.

interface ServerState

Input properties used for looking up and filtering Server resources.

property administratorLogin

administratorLogin?: pulumi.Input<string>;

The Administrator Login for the PostgreSQL Server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword?: pulumi.Input<string>;

The Password associated with the administrator_login for the PostgreSQL Server.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the PostgreSQL Server.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the SKU Name for this PostgreSQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the PostgreSQL Server. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<{ ... }>;

A sku block as defined below.

property sslEnforcement

sslEnforcement?: pulumi.Input<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

storageProfile?: pulumi.Input<{ ... }>;

A storage_profile block as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

Specifies the version of PostgreSQL to use. Valid values are 9.5, 9.6, and 10.0. Changing this forces a new resource to be created.

interface VirtualNetworkRuleArgs

The set of arguments for constructing a VirtualNetworkRule resource.

property ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint?: pulumi.Input<boolean>;

Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled? Defaults to false.

property name

name?: pulumi.Input<string>;

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId: pulumi.Input<string>;

The ID of the subnet that the PostgreSQL server will be connected to.

interface VirtualNetworkRuleState

Input properties used for looking up and filtering VirtualNetworkRule resources.

property ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint?: pulumi.Input<boolean>;

Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled? Defaults to false.

property name

name?: pulumi.Input<string>;

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the subnet that the PostgreSQL server will be connected to.