import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a SQL Container within a Cosmos DB Account. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = azure.cosmosdb.getAccount({ * name: "tfex-cosmosdb-account", * resourceGroupName: "tfex-cosmosdb-account-rg", * }); * const exampleSqlDatabase = new azure.cosmosdb.SqlDatabase("example", { * name: "example-acsd", * resourceGroupName: example.then(example => example.resourceGroupName), * accountName: example.then(example => example.name), * }); * const exampleSqlContainer = new azure.cosmosdb.SqlContainer("example", { * name: "example-container", * resourceGroupName: example.then(example => example.resourceGroupName), * accountName: example.then(example => example.name), * databaseName: exampleSqlDatabase.name, * partitionKeyPaths: ["/definition/id"], * partitionKeyVersion: 1, * throughput: 400, * indexingPolicy: { * indexingMode: "consistent", * includedPaths: [ * { * path: "/*", * }, * { * path: "/included/?", * }, * ], * excludedPaths: [{ * path: "/excluded/?", * }], * }, * uniqueKeys: [{ * paths: [ * "/definition/idlong", * "/definition/idshort", * ], * }], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.DocumentDB` - 2024-08-15 * * ## Import * * Cosmos SQL Containers can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:cosmosdb/sqlContainer:SqlContainer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1/sqlDatabases/database1/containers/container1 * ``` */ export declare class SqlContainer extends pulumi.CustomResource { /** * Get an existing SqlContainer resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SqlContainerState, opts?: pulumi.CustomResourceOptions): SqlContainer; /** * Returns true if the given object is an instance of SqlContainer. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is SqlContainer; /** * The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created. */ readonly accountName: pulumi.Output; /** * The default time to live of Analytical Storage for this SQL container. 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. */ readonly analyticalStorageTtl: pulumi.Output; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ readonly autoscaleSettings: pulumi.Output; /** * A `conflictResolutionPolicy` blocks as defined below. Changing this forces a new resource to be created. */ readonly conflictResolutionPolicy: pulumi.Output; /** * The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created. */ readonly databaseName: pulumi.Output; /** * 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. */ readonly defaultTtl: pulumi.Output; /** * An `indexingPolicy` block as defined below. */ readonly indexingPolicy: pulumi.Output; /** * Specifies the name of the Cosmos DB SQL Container. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Define a partition key kind. Possible values are `Hash` and `MultiHash`. Defaults to `Hash`. Changing this forces a new resource to be created. */ readonly partitionKeyKind: pulumi.Output; /** * A list of partition key paths. Changing this forces a new resource to be created. */ readonly partitionKeyPaths: pulumi.Output; /** * Define a partition key version. Possible values are `1`and `2`. This should be set to `2` in order to use large partition keys. * * > **Note:** If `partitionKeyVersion` is not specified when creating a new resource, you can update `partitionKeyVersion` to `1`, updating to `2` forces a new resource to be created. */ readonly partitionKeyVersion: pulumi.Output; /** * The name of the resource group in which the Cosmos DB SQL Container is created. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * 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. */ readonly throughput: pulumi.Output; /** * One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created. */ readonly uniqueKeys: pulumi.Output; /** * Create a SqlContainer resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SqlContainerArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SqlContainer resources. */ export interface SqlContainerState { /** * The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created. */ accountName?: pulumi.Input; /** * The default time to live of Analytical Storage for this SQL container. 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. */ analyticalStorageTtl?: pulumi.Input; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ autoscaleSettings?: pulumi.Input; /** * A `conflictResolutionPolicy` blocks as defined below. Changing this forces a new resource to be created. */ conflictResolutionPolicy?: pulumi.Input; /** * The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created. */ databaseName?: pulumi.Input; /** * 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. */ defaultTtl?: pulumi.Input; /** * An `indexingPolicy` block as defined below. */ indexingPolicy?: pulumi.Input; /** * Specifies the name of the Cosmos DB SQL Container. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Define a partition key kind. Possible values are `Hash` and `MultiHash`. Defaults to `Hash`. Changing this forces a new resource to be created. */ partitionKeyKind?: pulumi.Input; /** * A list of partition key paths. Changing this forces a new resource to be created. */ partitionKeyPaths?: pulumi.Input[]>; /** * Define a partition key version. Possible values are `1`and `2`. This should be set to `2` in order to use large partition keys. * * > **Note:** If `partitionKeyVersion` is not specified when creating a new resource, you can update `partitionKeyVersion` to `1`, updating to `2` forces a new resource to be created. */ partitionKeyVersion?: pulumi.Input; /** * The name of the resource group in which the Cosmos DB SQL Container is created. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * 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. */ throughput?: pulumi.Input; /** * One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created. */ uniqueKeys?: pulumi.Input[]>; } /** * The set of arguments for constructing a SqlContainer resource. */ export interface SqlContainerArgs { /** * The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created. */ accountName: pulumi.Input; /** * The default time to live of Analytical Storage for this SQL container. 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. */ analyticalStorageTtl?: pulumi.Input; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ autoscaleSettings?: pulumi.Input; /** * A `conflictResolutionPolicy` blocks as defined below. Changing this forces a new resource to be created. */ conflictResolutionPolicy?: pulumi.Input; /** * The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created. */ databaseName: pulumi.Input; /** * 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. */ defaultTtl?: pulumi.Input; /** * An `indexingPolicy` block as defined below. */ indexingPolicy?: pulumi.Input; /** * Specifies the name of the Cosmos DB SQL Container. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Define a partition key kind. Possible values are `Hash` and `MultiHash`. Defaults to `Hash`. Changing this forces a new resource to be created. */ partitionKeyKind?: pulumi.Input; /** * A list of partition key paths. Changing this forces a new resource to be created. */ partitionKeyPaths: pulumi.Input[]>; /** * Define a partition key version. Possible values are `1`and `2`. This should be set to `2` in order to use large partition keys. * * > **Note:** If `partitionKeyVersion` is not specified when creating a new resource, you can update `partitionKeyVersion` to `1`, updating to `2` forces a new resource to be created. */ partitionKeyVersion?: pulumi.Input; /** * The name of the resource group in which the Cosmos DB SQL Container is created. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * 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. */ throughput?: pulumi.Input; /** * One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created. */ uniqueKeys?: pulumi.Input[]>; }