1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. StaticSiteDatabaseConnection
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.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.web.StaticSiteDatabaseConnection

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.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Static Site Database Connection resource. Azure REST API version: 2022-09-01.

    Other available API versions: 2023-01-01, 2023-12-01.

    Example Usage

    Create or update a database connection for a static site

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var staticSiteDatabaseConnection = new AzureNative.Web.StaticSiteDatabaseConnection("staticSiteDatabaseConnection", new()
        {
            ConnectionIdentity = "SystemAssigned",
            ConnectionString = "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
            DatabaseConnectionName = "default",
            Name = "testStaticSite0",
            Region = "West US 2",
            ResourceGroupName = "rg",
            ResourceId = "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
        });
    
    });
    
    package main
    
    import (
    	web "github.com/pulumi/pulumi-azure-native-sdk/web/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := web.NewStaticSiteDatabaseConnection(ctx, "staticSiteDatabaseConnection", &web.StaticSiteDatabaseConnectionArgs{
    			ConnectionIdentity:     pulumi.String("SystemAssigned"),
    			ConnectionString:       pulumi.String("AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;"),
    			DatabaseConnectionName: pulumi.String("default"),
    			Name:                   pulumi.String("testStaticSite0"),
    			Region:                 pulumi.String("West US 2"),
    			ResourceGroupName:      pulumi.String("rg"),
    			ResourceId:             pulumi.String("/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName"),
    		})
    		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.web.StaticSiteDatabaseConnection;
    import com.pulumi.azurenative.web.StaticSiteDatabaseConnectionArgs;
    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 staticSiteDatabaseConnection = new StaticSiteDatabaseConnection("staticSiteDatabaseConnection", StaticSiteDatabaseConnectionArgs.builder()
                .connectionIdentity("SystemAssigned")
                .connectionString("AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;")
                .databaseConnectionName("default")
                .name("testStaticSite0")
                .region("West US 2")
                .resourceGroupName("rg")
                .resourceId("/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    static_site_database_connection = azure_native.web.StaticSiteDatabaseConnection("staticSiteDatabaseConnection",
        connection_identity="SystemAssigned",
        connection_string="AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
        database_connection_name="default",
        name="testStaticSite0",
        region="West US 2",
        resource_group_name="rg",
        resource_id="/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const staticSiteDatabaseConnection = new azure_native.web.StaticSiteDatabaseConnection("staticSiteDatabaseConnection", {
        connectionIdentity: "SystemAssigned",
        connectionString: "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
        databaseConnectionName: "default",
        name: "testStaticSite0",
        region: "West US 2",
        resourceGroupName: "rg",
        resourceId: "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
    });
    
    resources:
      staticSiteDatabaseConnection:
        type: azure-native:web:StaticSiteDatabaseConnection
        properties:
          connectionIdentity: SystemAssigned
          connectionString: AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;
          databaseConnectionName: default
          name: testStaticSite0
          region: West US 2
          resourceGroupName: rg
          resourceId: /subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName
    

    Create StaticSiteDatabaseConnection Resource

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

    Constructor syntax

    new StaticSiteDatabaseConnection(name: string, args: StaticSiteDatabaseConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def StaticSiteDatabaseConnection(resource_name: str,
                                     args: StaticSiteDatabaseConnectionArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def StaticSiteDatabaseConnection(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     name: Optional[str] = None,
                                     region: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     resource_id: Optional[str] = None,
                                     connection_identity: Optional[str] = None,
                                     connection_string: Optional[str] = None,
                                     database_connection_name: Optional[str] = None,
                                     kind: Optional[str] = None)
    func NewStaticSiteDatabaseConnection(ctx *Context, name string, args StaticSiteDatabaseConnectionArgs, opts ...ResourceOption) (*StaticSiteDatabaseConnection, error)
    public StaticSiteDatabaseConnection(string name, StaticSiteDatabaseConnectionArgs args, CustomResourceOptions? opts = null)
    public StaticSiteDatabaseConnection(String name, StaticSiteDatabaseConnectionArgs args)
    public StaticSiteDatabaseConnection(String name, StaticSiteDatabaseConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:web:StaticSiteDatabaseConnection
    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 StaticSiteDatabaseConnectionArgs
    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 StaticSiteDatabaseConnectionArgs
    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 StaticSiteDatabaseConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StaticSiteDatabaseConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StaticSiteDatabaseConnectionArgs
    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 staticSiteDatabaseConnectionResource = new AzureNative.Web.StaticSiteDatabaseConnection("staticSiteDatabaseConnectionResource", new()
    {
        Name = "string",
        Region = "string",
        ResourceGroupName = "string",
        ResourceId = "string",
        ConnectionIdentity = "string",
        ConnectionString = "string",
        DatabaseConnectionName = "string",
        Kind = "string",
    });
    
    example, err := web.NewStaticSiteDatabaseConnection(ctx, "staticSiteDatabaseConnectionResource", &web.StaticSiteDatabaseConnectionArgs{
    	Name:                   pulumi.String("string"),
    	Region:                 pulumi.String("string"),
    	ResourceGroupName:      pulumi.String("string"),
    	ResourceId:             pulumi.String("string"),
    	ConnectionIdentity:     pulumi.String("string"),
    	ConnectionString:       pulumi.String("string"),
    	DatabaseConnectionName: pulumi.String("string"),
    	Kind:                   pulumi.String("string"),
    })
    
    var staticSiteDatabaseConnectionResource = new StaticSiteDatabaseConnection("staticSiteDatabaseConnectionResource", StaticSiteDatabaseConnectionArgs.builder()
        .name("string")
        .region("string")
        .resourceGroupName("string")
        .resourceId("string")
        .connectionIdentity("string")
        .connectionString("string")
        .databaseConnectionName("string")
        .kind("string")
        .build());
    
    static_site_database_connection_resource = azure_native.web.StaticSiteDatabaseConnection("staticSiteDatabaseConnectionResource",
        name="string",
        region="string",
        resource_group_name="string",
        resource_id="string",
        connection_identity="string",
        connection_string="string",
        database_connection_name="string",
        kind="string")
    
    const staticSiteDatabaseConnectionResource = new azure_native.web.StaticSiteDatabaseConnection("staticSiteDatabaseConnectionResource", {
        name: "string",
        region: "string",
        resourceGroupName: "string",
        resourceId: "string",
        connectionIdentity: "string",
        connectionString: "string",
        databaseConnectionName: "string",
        kind: "string",
    });
    
    type: azure-native:web:StaticSiteDatabaseConnection
    properties:
        connectionIdentity: string
        connectionString: string
        databaseConnectionName: string
        kind: string
        name: string
        region: string
        resourceGroupName: string
        resourceId: string
    

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

    Name string
    Name of the static site
    Region string
    The region of the database resource.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    ResourceId string
    The resource id of the database.
    ConnectionIdentity string
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    ConnectionString string
    The connection string to use to connect to the database.
    DatabaseConnectionName string
    Name of the database connection.
    Kind string
    Kind of resource.
    Name string
    Name of the static site
    Region string
    The region of the database resource.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    ResourceId string
    The resource id of the database.
    ConnectionIdentity string
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    ConnectionString string
    The connection string to use to connect to the database.
    DatabaseConnectionName string
    Name of the database connection.
    Kind string
    Kind of resource.
    name String
    Name of the static site
    region String
    The region of the database resource.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    resourceId String
    The resource id of the database.
    connectionIdentity String
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    connectionString String
    The connection string to use to connect to the database.
    databaseConnectionName String
    Name of the database connection.
    kind String
    Kind of resource.
    name string
    Name of the static site
    region string
    The region of the database resource.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    resourceId string
    The resource id of the database.
    connectionIdentity string
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    connectionString string
    The connection string to use to connect to the database.
    databaseConnectionName string
    Name of the database connection.
    kind string
    Kind of resource.
    name str
    Name of the static site
    region str
    The region of the database resource.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    resource_id str
    The resource id of the database.
    connection_identity str
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    connection_string str
    The connection string to use to connect to the database.
    database_connection_name str
    Name of the database connection.
    kind str
    Kind of resource.
    name String
    Name of the static site
    region String
    The region of the database resource.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    resourceId String
    The resource id of the database.
    connectionIdentity String
    If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
    connectionString String
    The connection string to use to connect to the database.
    databaseConnectionName String
    Name of the database connection.
    kind String
    Kind of resource.

    Outputs

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

    ConfigurationFiles List<Pulumi.AzureNative.Web.Outputs.StaticSiteDatabaseConnectionConfigurationFileOverviewResponse>
    A list of configuration files associated with this database connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    ConfigurationFiles []StaticSiteDatabaseConnectionConfigurationFileOverviewResponse
    A list of configuration files associated with this database connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    configurationFiles List<StaticSiteDatabaseConnectionConfigurationFileOverviewResponse>
    A list of configuration files associated with this database connection.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.
    configurationFiles StaticSiteDatabaseConnectionConfigurationFileOverviewResponse[]
    A list of configuration files associated with this database connection.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource type.
    configuration_files Sequence[StaticSiteDatabaseConnectionConfigurationFileOverviewResponse]
    A list of configuration files associated with this database connection.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource type.
    configurationFiles List<Property Map>
    A list of configuration files associated with this database connection.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.

    Supporting Types

    StaticSiteDatabaseConnectionConfigurationFileOverviewResponse, StaticSiteDatabaseConnectionConfigurationFileOverviewResponseArgs

    Contents string
    The Base64 encoding of the file contents.
    FileName string
    The name of the configuration file.
    Type string
    The type of configuration file.
    Contents string
    The Base64 encoding of the file contents.
    FileName string
    The name of the configuration file.
    Type string
    The type of configuration file.
    contents String
    The Base64 encoding of the file contents.
    fileName String
    The name of the configuration file.
    type String
    The type of configuration file.
    contents string
    The Base64 encoding of the file contents.
    fileName string
    The name of the configuration file.
    type string
    The type of configuration file.
    contents str
    The Base64 encoding of the file contents.
    file_name str
    The name of the configuration file.
    type str
    The type of configuration file.
    contents String
    The Base64 encoding of the file contents.
    fileName String
    The name of the configuration file.
    type String
    The type of configuration file.

    Import

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

    $ pulumi import azure-native:web:StaticSiteDatabaseConnection default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName} 
    

    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.1 published on Tuesday, Jul 16, 2024 by Pulumi