SqlContainer

Manages a SQL Container within a Cosmos DB Account.

Create a SqlContainer Resource

new SqlContainer(name: string, args: SqlContainerArgs, opts?: CustomResourceOptions);

def SqlContainer(resource_name, opts=None, account_name=None, database_name=None, default_ttl=None, name=None, partition_key_path=None, resource_group_name=None, throughput=None, unique_keys=None, __props__=None);

func NewSqlContainer(ctx *Context, name string, args SqlContainerArgs, opts ...ResourceOption) (*SqlContainer, error)

public SqlContainer(string name, SqlContainerArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SqlContainerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

SqlContainer Resource Properties

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

Inputs

The SqlContainer resource accepts the following input properties:

AccountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
DatabaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
DefaultTtl int: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
Name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
PartitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
Throughput int: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
UniqueKeys List<SqlContainerUniqueKeyArgs>: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

AccountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
DatabaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
DefaultTtl int: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
Name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
PartitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
Throughput int: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
UniqueKeys []SqlContainerUniqueKey: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

accountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
databaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
defaultTtl number: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
partitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
throughput number: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
uniqueKeys SqlContainerUniqueKey[]: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

account_name str: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
database_name str: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
default_ttl float: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
name str: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
partition_key_path str: Define a partition key. Changing this forces a new resource to be created.
throughput float: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
unique_keys List[SqlContainerUniqueKey]: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing SqlContainer Resource

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

public static get(name: string, id: Input<ID>, state?: SqlContainerState, opts?: CustomResourceOptions): SqlContainer

static get(resource_name, id, opts=None, account_name=None, database_name=None, default_ttl=None, name=None, partition_key_path=None, resource_group_name=None, throughput=None, unique_keys=None, __props__=None);

func GetSqlContainer(ctx *Context, name string, id IDInput, state *SqlContainerState, opts ...ResourceOption) (*SqlContainer, error)

public static SqlContainer Get(string name, Input<string> id, SqlContainerState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
DatabaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
DefaultTtl int: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
Name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
PartitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
Throughput int: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
UniqueKeys List<SqlContainerUniqueKeyArgs>: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

AccountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
DatabaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
DefaultTtl int: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
Name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
PartitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
Throughput int: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
UniqueKeys []SqlContainerUniqueKey: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

accountName string: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
databaseName string: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
defaultTtl number: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
name string: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
partitionKeyPath string: Define a partition key. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
throughput number: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
uniqueKeys SqlContainerUniqueKey[]: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

account_name str: The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
database_name str: The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
default_ttl float: The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.
name str: Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
partition_key_path str: Define a partition key. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
throughput float: The throughput of SQL container (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
unique_keys List[SqlContainerUniqueKey]: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

Supporting Types

SqlContainerUniqueKey

See the input and output API doc for this type.

Paths List<string>: A list of paths to use for this unique key.

Paths []string: A list of paths to use for this unique key.

paths string[]: A list of paths to use for this unique key.

paths List[str]: A list of paths to use for this unique key.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud