Azure Native v1.102.0, May 2 23

azure-native.documentdb.SqlResourceSqlDatabase

Explore with Pulumi AI

An Azure Cosmos DB SQL database. API Version: 2021-03-15.

Example Usage

CosmosDBSqlDatabaseCreateUpdate

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

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

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewSqlResourceSqlDatabase(ctx, "sqlResourceSqlDatabase", &documentdb.SqlResourceSqlDatabaseArgs{
			AccountName:  pulumi.String("ddb1"),
			DatabaseName: pulumi.String("databaseName"),
			Location:     pulumi.String("West US"),
			Options:      nil,
			Resource: &documentdb.SqlDatabaseResourceArgs{
				Id: pulumi.String("databaseName"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			Tags:              nil,
		})
		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.documentdb.SqlResourceSqlDatabase;
import com.pulumi.azurenative.documentdb.SqlResourceSqlDatabaseArgs;
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()
            .resource(Map.of("id", "databaseName"))
            .resourceGroupName("rg1")
            .tags()
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

sql_resource_sql_database = azure_native.documentdb.SqlResourceSqlDatabase("sqlResourceSqlDatabase",
    account_name="ddb1",
    database_name="databaseName",
    location="West US",
    options=azure_native.documentdb.CreateUpdateOptionsArgs(),
    resource=azure_native.documentdb.SqlDatabaseResourceArgs(
        id="databaseName",
    ),
    resource_group_name="rg1",
    tags={})

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

const sqlResourceSqlDatabase = new azure_native.documentdb.SqlResourceSqlDatabase("sqlResourceSqlDatabase", {
    accountName: "ddb1",
    databaseName: "databaseName",
    location: "West US",
    options: {},
    resource: {
        id: "databaseName",
    },
    resourceGroupName: "rg1",
    tags: {},
});

resources:
  sqlResourceSqlDatabase:
    type: azure-native:documentdb:SqlResourceSqlDatabase
    properties:
      accountName: ddb1
      databaseName: databaseName
      location: West US
      options: {}
      resource:
        id: databaseName
      resourceGroupName: rg1
      tags: {}

Create SqlResourceSqlDatabase Resource

new SqlResourceSqlDatabase(name: string, args: SqlResourceSqlDatabaseArgs, opts?: CustomResourceOptions);

@overload
def SqlResourceSqlDatabase(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_name: Optional[str] = None,
                           database_name: Optional[str] = None,
                           location: Optional[str] = None,
                           options: Optional[CreateUpdateOptionsArgs] = None,
                           resource: Optional[SqlDatabaseResourceArgs] = None,
                           resource_group_name: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
@overload
def SqlResourceSqlDatabase(resource_name: str,
                           args: SqlResourceSqlDatabaseArgs,
                           opts: Optional[ResourceOptions] = 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:documentdb:SqlResourceSqlDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args SqlResourceSqlDatabaseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SqlResourceSqlDatabaseArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

The SqlResourceSqlDatabase resource accepts the following input properties:

AccountName string: Cosmos DB database account name.
Resource Pulumi.AzureNative.DocumentDB.Inputs.SqlDatabaseResourceArgs: The standard JSON format of a SQL database
ResourceGroupName string: The name of the resource group. The name is case insensitive.
DatabaseName string: Cosmos DB database name.
Location string: The location of the resource group to which the resource belongs.
Options Pulumi.AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs: 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 string: Cosmos DB database account name.
Resource SqlDatabaseResourceArgs: The standard JSON format of a SQL database
ResourceGroupName string: The name of the resource group. The name is case insensitive.
DatabaseName 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 String: Cosmos DB database account name.
resource SqlDatabaseResourceArgs: The standard JSON format of a SQL database
resourceGroupName String: The name of the resource group. The name is case insensitive.
databaseName 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 string: Cosmos DB database account name.
resource SqlDatabaseResourceArgs: The standard JSON format of a SQL database
resourceGroupName string: The name of the resource group. The name is case insensitive.
databaseName 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 {[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 str: Cosmos DB database account name.
resource SqlDatabaseResourceArgs: The standard JSON format of a SQL database
resource_group_name str: The name of the resource group. The name is case insensitive.
database_name 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 String: Cosmos DB database account name.
resource Property Map: The standard JSON format of a SQL database
resourceGroupName String: The name of the resource group. The name is case insensitive.
databaseName 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:

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.

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.

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.

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.

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.

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

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

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.

CreateUpdateOptions

AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettings: Specifies the Autoscale settings.
Throughput int: Request Units per second. For example, "throughput": 10000.

AutoscaleSettings AutoscaleSettings: Specifies the Autoscale settings.
Throughput int: Request Units per second. For example, "throughput": 10000.

autoscaleSettings AutoscaleSettings: Specifies the Autoscale settings.
throughput Integer: Request Units per second. For example, "throughput": 10000.

autoscaleSettings AutoscaleSettings: Specifies the Autoscale settings.
throughput number: Request Units per second. For example, "throughput": 10000.

autoscale_settings AutoscaleSettings: Specifies the Autoscale settings.
throughput int: Request Units per second. For example, "throughput": 10000.

autoscaleSettings Property Map: Specifies the Autoscale settings.
throughput Number: Request Units per second. For example, "throughput": 10000.

SqlDatabaseGetPropertiesResponseOptions

AutoscaleSettings Pulumi.AzureNative.DocumentDB.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

Etag string: A system generated property representing the resource etag required for optimistic concurrency control.
Id string: Name of the Cosmos DB SQL database
Rid string: A system generated property. A unique identifier.
Ts 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.
Users string: A system generated property that specifies the addressable path of the users resource.

Etag string: A system generated property representing the resource etag required for optimistic concurrency control.
Id string: Name of the Cosmos DB SQL database
Rid string: A system generated property. A unique identifier.
Ts 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.
Users string: A system generated property that specifies the addressable path of the users resource.

etag String: A system generated property representing the resource etag required for optimistic concurrency control.
id String: Name of the Cosmos DB SQL database
rid String: A system generated property. A unique identifier.
ts 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.
users String: A system generated property that specifies the addressable path of the users resource.

etag string: A system generated property representing the resource etag required for optimistic concurrency control.
id string: Name of the Cosmos DB SQL database
rid string: A system generated property. A unique identifier.
ts 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.
users string: A system generated property that specifies the addressable path of the users resource.

etag str: A system generated property representing the resource etag required for optimistic concurrency control.
id str: Name of the Cosmos DB SQL database
rid str: A system generated property. A unique identifier.
ts 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.
users str: A system generated property that specifies the addressable path of the users resource.

etag String: A system generated property representing the resource etag required for optimistic concurrency control.
id String: Name of the Cosmos DB SQL database
rid String: A system generated property. A unique identifier.
ts 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.
users String: A system generated property that specifies the addressable path of the users resource.

SqlDatabaseResource

Id string: Name of the Cosmos DB SQL database

Id string: Name of the Cosmos DB SQL database

id String: Name of the Cosmos DB SQL database

id string: Name of the Cosmos DB SQL database

id str: Name of the Cosmos DB SQL database

id String: Name of the Cosmos DB SQL database

Import

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

$ pulumi import azure-native:documentdb:SqlResourceSqlDatabase databaseName /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0