1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. Database
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

azure-native.dbforpostgresql.Database

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

    Represents a Database. Azure REST API version: 2022-12-01. Prior API version in Azure Native 1.x: 2017-12-01.

    Other available API versions: 2017-12-01, 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview.

    Example Usage

    Create a database

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var database = new AzureNative.DBforPostgreSQL.Database("database", new()
        {
            Charset = "utf8",
            Collation = "en_US.utf8",
            DatabaseName = "db1",
            ResourceGroupName = "TestGroup",
            ServerName = "testserver",
        });
    
    });
    
    package main
    
    import (
    	dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dbforpostgresql.NewDatabase(ctx, "database", &dbforpostgresql.DatabaseArgs{
    			Charset:           pulumi.String("utf8"),
    			Collation:         pulumi.String("en_US.utf8"),
    			DatabaseName:      pulumi.String("db1"),
    			ResourceGroupName: pulumi.String("TestGroup"),
    			ServerName:        pulumi.String("testserver"),
    		})
    		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.azurenative.dbforpostgresql.Database;
    import com.pulumi.azurenative.dbforpostgresql.DatabaseArgs;
    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 database = new Database("database", DatabaseArgs.builder()
                .charset("utf8")
                .collation("en_US.utf8")
                .databaseName("db1")
                .resourceGroupName("TestGroup")
                .serverName("testserver")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    database = azure_native.dbforpostgresql.Database("database",
        charset="utf8",
        collation="en_US.utf8",
        database_name="db1",
        resource_group_name="TestGroup",
        server_name="testserver")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const database = new azure_native.dbforpostgresql.Database("database", {
        charset: "utf8",
        collation: "en_US.utf8",
        databaseName: "db1",
        resourceGroupName: "TestGroup",
        serverName: "testserver",
    });
    
    resources:
      database:
        type: azure-native:dbforpostgresql:Database
        properties:
          charset: utf8
          collation: en_US.utf8
          databaseName: db1
          resourceGroupName: TestGroup
          serverName: testserver
    

    Create Database Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def Database(resource_name: str,
                 args: DatabaseArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Database(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 resource_group_name: Optional[str] = None,
                 server_name: Optional[str] = None,
                 charset: Optional[str] = None,
                 collation: Optional[str] = None,
                 database_name: Optional[str] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
    public Database(String name, DatabaseArgs args, CustomResourceOptions options)
    
    type: azure-native:dbforpostgresql:Database
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampledatabaseResourceResourceFromDbforpostgresql = new AzureNative.DBforPostgreSQL.Database("exampledatabaseResourceResourceFromDbforpostgresql", new()
    {
        ResourceGroupName = "string",
        ServerName = "string",
        Charset = "string",
        Collation = "string",
        DatabaseName = "string",
    });
    
    example, err := dbforpostgresql.NewDatabase(ctx, "exampledatabaseResourceResourceFromDbforpostgresql", &dbforpostgresql.DatabaseArgs{
    	ResourceGroupName: pulumi.String("string"),
    	ServerName:        pulumi.String("string"),
    	Charset:           pulumi.String("string"),
    	Collation:         pulumi.String("string"),
    	DatabaseName:      pulumi.String("string"),
    })
    
    var exampledatabaseResourceResourceFromDbforpostgresql = new Database("exampledatabaseResourceResourceFromDbforpostgresql", DatabaseArgs.builder()
        .resourceGroupName("string")
        .serverName("string")
        .charset("string")
        .collation("string")
        .databaseName("string")
        .build());
    
    exampledatabase_resource_resource_from_dbforpostgresql = azure_native.dbforpostgresql.Database("exampledatabaseResourceResourceFromDbforpostgresql",
        resource_group_name="string",
        server_name="string",
        charset="string",
        collation="string",
        database_name="string")
    
    const exampledatabaseResourceResourceFromDbforpostgresql = new azure_native.dbforpostgresql.Database("exampledatabaseResourceResourceFromDbforpostgresql", {
        resourceGroupName: "string",
        serverName: "string",
        charset: "string",
        collation: "string",
        databaseName: "string",
    });
    
    type: azure-native:dbforpostgresql:Database
    properties:
        charset: string
        collation: string
        databaseName: string
        resourceGroupName: string
        serverName: string
    

    Database 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 Database resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerName string
    The name of the server.
    Charset string
    The charset of the database.
    Collation string
    The collation of the database.
    DatabaseName string
    The name of the database.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerName string
    The name of the server.
    Charset string
    The charset of the database.
    Collation string
    The collation of the database.
    DatabaseName string
    The name of the database.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverName String
    The name of the server.
    charset String
    The charset of the database.
    collation String
    The collation of the database.
    databaseName String
    The name of the database.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serverName string
    The name of the server.
    charset string
    The charset of the database.
    collation string
    The collation of the database.
    databaseName string
    The name of the database.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    server_name str
    The name of the server.
    charset str
    The charset of the database.
    collation str
    The collation of the database.
    database_name str
    The name of the database.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverName String
    The name of the server.
    charset String
    The charset of the database.
    collation String
    The collation of the database.
    databaseName String
    The name of the database.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.DBforPostgreSQL.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:dbforpostgresql:Database db1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi