Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. SqlResourceSqlDatabase
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.SqlResourceSqlDatabase

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Cosmos DB SQL database.

Uses Azure REST API version 2024-11-15.

Other available API versions: 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

Example Usage

CosmosDBSqlDatabaseCreateUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlResourceSqlDatabase = new AzureNative.CosmosDB.SqlResourceSqlDatabase("sqlResourceSqlDatabase", new()
    {
        AccountName = "ddb1",
        DatabaseName = "databaseName",
        Location = "West US",
        Options = null,
        Resource = new AzureNative.CosmosDB.Inputs.SqlDatabaseResourceArgs
        {
            Id = "databaseName",
        },
        ResourceGroupName = "rg1",
        Tags = null,
    });

});
Copy
package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewSqlResourceSqlDatabase(ctx, "sqlResourceSqlDatabase", &cosmosdb.SqlResourceSqlDatabaseArgs{
			AccountName:  pulumi.String("ddb1"),
			DatabaseName: pulumi.String("databaseName"),
			Location:     pulumi.String("West US"),
			Options:      &cosmosdb.CreateUpdateOptionsArgs{},
			Resource: &cosmosdb.SqlDatabaseResourceArgs{
				Id: pulumi.String("databaseName"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.SqlResourceSqlDatabase;
import com.pulumi.azurenative.cosmosdb.SqlResourceSqlDatabaseArgs;
import com.pulumi.azurenative.cosmosdb.inputs.CreateUpdateOptionsArgs;
import com.pulumi.azurenative.cosmosdb.inputs.SqlDatabaseResourceArgs;
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 sqlResourceSqlDatabase = new SqlResourceSqlDatabase("sqlResourceSqlDatabase", SqlResourceSqlDatabaseArgs.builder()
            .accountName("ddb1")
            .databaseName("databaseName")
            .location("West US")
            .options(CreateUpdateOptionsArgs.builder()
                .build())
            .resource(SqlDatabaseResourceArgs.builder()
                .id("databaseName")
                .build())
            .resourceGroupName("rg1")
            .tags(Map.ofEntries(
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlResourceSqlDatabase = new azure_native.cosmosdb.SqlResourceSqlDatabase("sqlResourceSqlDatabase", {
    accountName: "ddb1",
    databaseName: "databaseName",
    location: "West US",
    options: {},
    resource: {
        id: "databaseName",
    },
    resourceGroupName: "rg1",
    tags: {},
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_resource_sql_database = azure_native.cosmosdb.SqlResourceSqlDatabase("sqlResourceSqlDatabase",
    account_name="ddb1",
    database_name="databaseName",
    location="West US",
    options={},
    resource={
        "id": "databaseName",
    },
    resource_group_name="rg1",
    tags={})
Copy
resources:
  sqlResourceSqlDatabase:
    type: azure-native:cosmosdb:SqlResourceSqlDatabase
    properties:
      accountName: ddb1
      databaseName: databaseName
      location: West US
      options: {}
      resource:
        id: databaseName
      resourceGroupName: rg1
      tags: {}
Copy

Create SqlResourceSqlDatabase Resource

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

Constructor syntax

new SqlResourceSqlDatabase(name: string, args: SqlResourceSqlDatabaseArgs, opts?: CustomResourceOptions);
@overload
def SqlResourceSqlDatabase(resource_name: str,
                           args: SqlResourceSqlDatabaseArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def SqlResourceSqlDatabase(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_name: Optional[str] = None,
                           resource: Optional[SqlDatabaseResourceArgs] = None,
                           resource_group_name: Optional[str] = None,
                           database_name: Optional[str] = None,
                           location: Optional[str] = None,
                           options: Optional[CreateUpdateOptionsArgs] = None,
                           tags: Optional[Mapping[str, str]] = None)
func NewSqlResourceSqlDatabase(ctx *Context, name string, args SqlResourceSqlDatabaseArgs, opts ...ResourceOption) (*SqlResourceSqlDatabase, error)
public SqlResourceSqlDatabase(string name, SqlResourceSqlDatabaseArgs args, CustomResourceOptions? opts = null)
public SqlResourceSqlDatabase(String name, SqlResourceSqlDatabaseArgs args)
public SqlResourceSqlDatabase(String name, SqlResourceSqlDatabaseArgs args, CustomResourceOptions options)

type: azure-native:cosmosdb:SqlResourceSqlDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SqlResourceSqlDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SqlResourceSqlDatabaseArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SqlResourceSqlDatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SqlResourceSqlDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SqlResourceSqlDatabaseArgs
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 sqlResourceSqlDatabaseResource = new AzureNative.CosmosDB.SqlResourceSqlDatabase("sqlResourceSqlDatabaseResource", new()
{
    AccountName = "string",
    Resource = new AzureNative.CosmosDB.Inputs.SqlDatabaseResourceArgs
    {
        Id = "string",
        CreateMode = "string",
        RestoreParameters = new AzureNative.CosmosDB.Inputs.ResourceRestoreParametersArgs
        {
            RestoreSource = "string",
            RestoreTimestampInUtc = "string",
            RestoreWithTtlDisabled = false,
        },
    },
    ResourceGroupName = "string",
    DatabaseName = "string",
    Location = "string",
    Options = new AzureNative.CosmosDB.Inputs.CreateUpdateOptionsArgs
    {
        AutoscaleSettings = new AzureNative.CosmosDB.Inputs.AutoscaleSettingsArgs
        {
            MaxThroughput = 0,
        },
        Throughput = 0,
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := cosmosdb.NewSqlResourceSqlDatabase(ctx, "sqlResourceSqlDatabaseResource", &cosmosdb.SqlResourceSqlDatabaseArgs{
	AccountName: pulumi.String("string"),
	Resource: &cosmosdb.SqlDatabaseResourceArgs{
		Id:         pulumi.String("string"),
		CreateMode: pulumi.String("string"),
		RestoreParameters: &cosmosdb.ResourceRestoreParametersArgs{
			RestoreSource:          pulumi.String("string"),
			RestoreTimestampInUtc:  pulumi.String("string"),
			RestoreWithTtlDisabled: pulumi.Bool(false),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	DatabaseName:      pulumi.String("string"),
	Location:          pulumi.String("string"),
	Options: &cosmosdb.CreateUpdateOptionsArgs{
		AutoscaleSettings: &cosmosdb.AutoscaleSettingsArgs{
			MaxThroughput: pulumi.Int(0),
		},
		Throughput: pulumi.Int(0),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var sqlResourceSqlDatabaseResource = new SqlResourceSqlDatabase("sqlResourceSqlDatabaseResource", SqlResourceSqlDatabaseArgs.builder()
    .accountName("string")
    .resource(SqlDatabaseResourceArgs.builder()
        .id("string")
        .createMode("string")
        .restoreParameters(ResourceRestoreParametersArgs.builder()
            .restoreSource("string")
            .restoreTimestampInUtc("string")
            .restoreWithTtlDisabled(false)
            .build())
        .build())
    .resourceGroupName("string")
    .databaseName("string")
    .location("string")
    .options(CreateUpdateOptionsArgs.builder()
        .autoscaleSettings(AutoscaleSettingsArgs.builder()
            .maxThroughput(0)
            .build())
        .throughput(0)
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
sql_resource_sql_database_resource = azure_native.cosmosdb.SqlResourceSqlDatabase("sqlResourceSqlDatabaseResource",
    account_name="string",
    resource={
        "id": "string",
        "create_mode": "string",
        "restore_parameters": {
            "restore_source": "string",
            "restore_timestamp_in_utc": "string",
            "restore_with_ttl_disabled": False,
        },
    },
    resource_group_name="string",
    database_name="string",
    location="string",
    options={
        "autoscale_settings": {
            "max_throughput": 0,
        },
        "throughput": 0,
    },
    tags={
        "string": "string",
    })
Copy
const sqlResourceSqlDatabaseResource = new azure_native.cosmosdb.SqlResourceSqlDatabase("sqlResourceSqlDatabaseResource", {
    accountName: "string",
    resource: {
        id: "string",
        createMode: "string",
        restoreParameters: {
            restoreSource: "string",
            restoreTimestampInUtc: "string",
            restoreWithTtlDisabled: false,
        },
    },
    resourceGroupName: "string",
    databaseName: "string",
    location: "string",
    options: {
        autoscaleSettings: {
            maxThroughput: 0,
        },
        throughput: 0,
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:cosmosdb:SqlResourceSqlDatabase
properties:
    accountName: string
    databaseName: string
    location: string
    options:
        autoscaleSettings:
            maxThroughput: 0
        throughput: 0
    resource:
        createMode: string
        id: string
        restoreParameters:
            restoreSource: string
            restoreTimestampInUtc: string
            restoreWithTtlDisabled: false
    resourceGroupName: string
    tags:
        string: string
Copy

SqlResourceSqlDatabase Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SqlResourceSqlDatabase resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
Resource This property is required. Pulumi.AzureNative.CosmosDB.Inputs.SqlDatabaseResource
The standard JSON format of a SQL database
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DatabaseName Changes to this property will trigger replacement. string
Cosmos DB database name.
Location string
The location of the resource group to which the resource belongs.
Options Pulumi.AzureNative.CosmosDB.Inputs.CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Tags Dictionary<string, string>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
Resource This property is required. SqlDatabaseResourceArgs
The standard JSON format of a SQL database
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DatabaseName Changes to this property will trigger replacement. string
Cosmos DB database name.
Location string
The location of the resource group to which the resource belongs.
Options CreateUpdateOptionsArgs
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Tags map[string]string
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resource This property is required. SqlDatabaseResource
The standard JSON format of a SQL database
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
databaseName Changes to this property will trigger replacement. String
Cosmos DB database name.
location String
The location of the resource group to which the resource belongs.
options CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tags Map<String,String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resource This property is required. SqlDatabaseResource
The standard JSON format of a SQL database
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
databaseName Changes to this property will trigger replacement. string
Cosmos DB database name.
location string
The location of the resource group to which the resource belongs.
options CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tags {[key: string]: string}
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
resource This property is required. SqlDatabaseResourceArgs
The standard JSON format of a SQL database
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
database_name Changes to this property will trigger replacement. str
Cosmos DB database name.
location str
The location of the resource group to which the resource belongs.
options CreateUpdateOptionsArgs
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tags Mapping[str, str]
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resource This property is required. Property Map
The standard JSON format of a SQL database
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
databaseName Changes to this property will trigger replacement. String
Cosmos DB database name.
location String
The location of the resource group to which the resource belongs.
options Property Map
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tags Map<String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the ARM resource.
type string
The type of Azure resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the ARM resource.
type str
The type of Azure resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.

Supporting Types

AutoscaleSettings
, AutoscaleSettingsArgs

MaxThroughput int
Represents maximum throughput, the resource can scale up to.
MaxThroughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Integer
Represents maximum throughput, the resource can scale up to.
maxThroughput number
Represents maximum throughput, the resource can scale up to.
max_throughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Number
Represents maximum throughput, the resource can scale up to.

AutoscaleSettingsResponse
, AutoscaleSettingsResponseArgs

MaxThroughput int
Represents maximum throughput, the resource can scale up to.
MaxThroughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Integer
Represents maximum throughput, the resource can scale up to.
maxThroughput number
Represents maximum throughput, the resource can scale up to.
max_throughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Number
Represents maximum throughput, the resource can scale up to.

CreateMode
, CreateModeArgs

Default
Default
Restore
Restore
CreateModeDefault
Default
CreateModeRestore
Restore
Default
Default
Restore
Restore
Default
Default
Restore
Restore
DEFAULT
Default
RESTORE
Restore
"Default"
Default
"Restore"
Restore

CreateUpdateOptions
, CreateUpdateOptionsArgs

AutoscaleSettings Pulumi.AzureNative.CosmosDB.Inputs.AutoscaleSettings
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
Throughput int
Request Units per second. For example, "throughput": 10000.
AutoscaleSettings AutoscaleSettings
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
Throughput int
Request Units per second. For example, "throughput": 10000.
autoscaleSettings AutoscaleSettings
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
throughput Integer
Request Units per second. For example, "throughput": 10000.
autoscaleSettings AutoscaleSettings
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
throughput number
Request Units per second. For example, "throughput": 10000.
autoscale_settings AutoscaleSettings
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
throughput int
Request Units per second. For example, "throughput": 10000.
autoscaleSettings Property Map
Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
throughput Number
Request Units per second. For example, "throughput": 10000.

ResourceRestoreParameters
, ResourceRestoreParametersArgs

RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restore_source str
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restore_timestamp_in_utc str
Time to which the account has to be restored (ISO-8601 format).
restore_with_ttl_disabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

ResourceRestoreParametersResponse
, ResourceRestoreParametersResponseArgs

RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restore_source str
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restore_timestamp_in_utc str
Time to which the account has to be restored (ISO-8601 format).
restore_with_ttl_disabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

SqlDatabaseGetPropertiesResponseOptions
, SqlDatabaseGetPropertiesResponseOptionsArgs

AutoscaleSettings Pulumi.AzureNative.CosmosDB.Inputs.AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
AutoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput Integer
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput number
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings Property Map
Specifies the Autoscale settings.
throughput Number
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

SqlDatabaseGetPropertiesResponseResource
, SqlDatabaseGetPropertiesResponseResourceArgs

Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB SQL database
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. double
A system generated property that denotes the last updated timestamp of the resource.
Colls string
A system generated property that specified the addressable path of the collections resource.
CreateMode string
Enum to indicate the mode of resource creation.
RestoreParameters Pulumi.AzureNative.CosmosDB.Inputs.ResourceRestoreParametersResponse
Parameters to indicate the information about the restore
Users string
A system generated property that specifies the addressable path of the users resource.
Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB SQL database
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. float64
A system generated property that denotes the last updated timestamp of the resource.
Colls string
A system generated property that specified the addressable path of the collections resource.
CreateMode string
Enum to indicate the mode of resource creation.
RestoreParameters ResourceRestoreParametersResponse
Parameters to indicate the information about the restore
Users string
A system generated property that specifies the addressable path of the users resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB SQL database
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Double
A system generated property that denotes the last updated timestamp of the resource.
colls String
A system generated property that specified the addressable path of the collections resource.
createMode String
Enum to indicate the mode of resource creation.
restoreParameters ResourceRestoreParametersResponse
Parameters to indicate the information about the restore
users String
A system generated property that specifies the addressable path of the users resource.
etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. string
Name of the Cosmos DB SQL database
rid This property is required. string
A system generated property. A unique identifier.
ts This property is required. number
A system generated property that denotes the last updated timestamp of the resource.
colls string
A system generated property that specified the addressable path of the collections resource.
createMode string
Enum to indicate the mode of resource creation.
restoreParameters ResourceRestoreParametersResponse
Parameters to indicate the information about the restore
users string
A system generated property that specifies the addressable path of the users resource.
etag This property is required. str
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. str
Name of the Cosmos DB SQL database
rid This property is required. str
A system generated property. A unique identifier.
ts This property is required. float
A system generated property that denotes the last updated timestamp of the resource.
colls str
A system generated property that specified the addressable path of the collections resource.
create_mode str
Enum to indicate the mode of resource creation.
restore_parameters ResourceRestoreParametersResponse
Parameters to indicate the information about the restore
users str
A system generated property that specifies the addressable path of the users resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB SQL database
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Number
A system generated property that denotes the last updated timestamp of the resource.
colls String
A system generated property that specified the addressable path of the collections resource.
createMode String
Enum to indicate the mode of resource creation.
restoreParameters Property Map
Parameters to indicate the information about the restore
users String
A system generated property that specifies the addressable path of the users resource.

SqlDatabaseResource
, SqlDatabaseResourceArgs

Id This property is required. string
Name of the Cosmos DB SQL database
CreateMode string | Pulumi.AzureNative.CosmosDB.CreateMode
Enum to indicate the mode of resource creation.
RestoreParameters Pulumi.AzureNative.CosmosDB.Inputs.ResourceRestoreParameters
Parameters to indicate the information about the restore
Id This property is required. string
Name of the Cosmos DB SQL database
CreateMode string | CreateMode
Enum to indicate the mode of resource creation.
RestoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
id This property is required. String
Name of the Cosmos DB SQL database
createMode String | CreateMode
Enum to indicate the mode of resource creation.
restoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
id This property is required. string
Name of the Cosmos DB SQL database
createMode string | CreateMode
Enum to indicate the mode of resource creation.
restoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
id This property is required. str
Name of the Cosmos DB SQL database
create_mode str | CreateMode
Enum to indicate the mode of resource creation.
restore_parameters ResourceRestoreParameters
Parameters to indicate the information about the restore
id This property is required. String
Name of the Cosmos DB SQL database
createMode String | "Default" | "Restore"
Enum to indicate the mode of resource creation.
restoreParameters Property Map
Parameters to indicate the information about the restore

Import

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

$ pulumi import azure-native:cosmosdb:SqlResourceSqlDatabase databaseName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native