Class SqlContainer

Manages a SQL Container within a Cosmos DB Account.

Inheritance

System.Object

Resource

CustomResource

SqlContainer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.CosmosDB

Assembly: Pulumi.Azure.dll

Syntax

public class SqlContainer : CustomResource

Constructors

SqlContainer(String, SqlContainerArgs, CustomResourceOptions)

Create a SqlContainer resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SqlContainerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccountName

The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.

Declaration

public Output<string> AccountName { get; }

Property Value

Type	Description
Output<System.String>

DatabaseName

The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

DefaultTtl

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.

Declaration

public Output<int> DefaultTtl { get; }

Property Value

Type	Description
Output<System.Int32>

Name

Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PartitionKeyPath

Define a partition key. Changing this forces a new resource to be created.

Declaration

public Output<string> PartitionKeyPath { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Throughput

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.

Declaration

public Output<int> Throughput { get; }

Property Value

Type	Description
Output<System.Int32>

UniqueKeys

One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<SqlContainerUniqueKey>> UniqueKeys { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<SqlContainerUniqueKey>>

Methods

Get(String, Input<String>, SqlContainerState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SqlContainerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SqlContainer