Azure Native v3.2.0, Apr 14 25

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.getSqlResourceSqlContainer

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

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.

Using getSqlResourceSqlContainer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSqlResourceSqlContainer(args: GetSqlResourceSqlContainerArgs, opts?: InvokeOptions): Promise<GetSqlResourceSqlContainerResult>
function getSqlResourceSqlContainerOutput(args: GetSqlResourceSqlContainerOutputArgs, opts?: InvokeOptions): Output<GetSqlResourceSqlContainerResult>

def get_sql_resource_sql_container(account_name: Optional[str] = None,
                                   container_name: Optional[str] = None,
                                   database_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetSqlResourceSqlContainerResult
def get_sql_resource_sql_container_output(account_name: Optional[pulumi.Input[str]] = None,
                                   container_name: Optional[pulumi.Input[str]] = None,
                                   database_name: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetSqlResourceSqlContainerResult]

func LookupSqlResourceSqlContainer(ctx *Context, args *LookupSqlResourceSqlContainerArgs, opts ...InvokeOption) (*LookupSqlResourceSqlContainerResult, error)
func LookupSqlResourceSqlContainerOutput(ctx *Context, args *LookupSqlResourceSqlContainerOutputArgs, opts ...InvokeOption) LookupSqlResourceSqlContainerResultOutput

> Note: This function is named LookupSqlResourceSqlContainer in the Go SDK.

public static class GetSqlResourceSqlContainer 
{
    public static Task<GetSqlResourceSqlContainerResult> InvokeAsync(GetSqlResourceSqlContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlResourceSqlContainerResult> Invoke(GetSqlResourceSqlContainerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSqlResourceSqlContainerResult> getSqlResourceSqlContainer(GetSqlResourceSqlContainerArgs args, InvokeOptions options)
public static Output<GetSqlResourceSqlContainerResult> getSqlResourceSqlContainer(GetSqlResourceSqlContainerArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:cosmosdb:getSqlResourceSqlContainer
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: Cosmos DB database account name.
ContainerName string: Cosmos DB container name.
DatabaseName string: Cosmos DB database name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

AccountName string: Cosmos DB database account name.
ContainerName string: Cosmos DB container name.
DatabaseName string: Cosmos DB database name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

accountName String: Cosmos DB database account name.
containerName String: Cosmos DB container name.
databaseName String: Cosmos DB database name.
resourceGroupName String: The name of the resource group. The name is case insensitive.

accountName string: Cosmos DB database account name.
containerName string: Cosmos DB container name.
databaseName string: Cosmos DB database name.
resourceGroupName string: The name of the resource group. The name is case insensitive.

account_name str: Cosmos DB database account name.
container_name str: Cosmos DB container name.
database_name str: Cosmos DB database name.
resource_group_name str: The name of the resource group. The name is case insensitive.

accountName String: Cosmos DB database account name.
containerName String: Cosmos DB container name.
databaseName String: Cosmos DB database name.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getSqlResourceSqlContainer Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Id string: The unique resource identifier of the ARM resource.
Name string: The name of the ARM resource.
Type string: The type of Azure resource.
Location string: The location of the resource group to which the resource belongs.
Options Pulumi.AzureNative.CosmosDB.Outputs.SqlContainerGetPropertiesResponseOptions
Resource Pulumi.AzureNative.CosmosDB.Outputs.SqlContainerGetPropertiesResponseResource
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".

AzureApiVersion string: The Azure API version of the resource.
Id string: The unique resource identifier of the ARM resource.
Name string: The name of the ARM resource.
Type string: The type of Azure resource.
Location string: The location of the resource group to which the resource belongs.
Options SqlContainerGetPropertiesResponseOptions
Resource SqlContainerGetPropertiesResponseResource
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".

azureApiVersion String: The Azure API version of the resource.
id String: The unique resource identifier of the ARM resource.
name String: The name of the ARM resource.
type String: The type of Azure resource.
location String: The location of the resource group to which the resource belongs.
options SqlContainerGetPropertiesResponseOptions
resource SqlContainerGetPropertiesResponseResource
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".

azureApiVersion string: The Azure API version of the resource.
id string: The unique resource identifier of the ARM resource.
name string: The name of the ARM resource.
type string: The type of Azure resource.
location string: The location of the resource group to which the resource belongs.
options SqlContainerGetPropertiesResponseOptions
resource SqlContainerGetPropertiesResponseResource
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".

azure_api_version str: The Azure API version of the resource.
id str: The unique resource identifier of the ARM resource.
name str: The name of the ARM resource.
type str: The type of Azure resource.
location str: The location of the resource group to which the resource belongs.
options SqlContainerGetPropertiesResponseOptions
resource SqlContainerGetPropertiesResponseResource
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".

azureApiVersion String: The Azure API version of the resource.
id String: The unique resource identifier of the ARM resource.
name String: The name of the ARM resource.
type String: The type of Azure resource.
location String: The location of the resource group to which the resource belongs.
options Property Map
resource Property Map
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".

Supporting Types

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.

ClientEncryptionIncludedPathResponse

ClientEncryptionKeyId string: The identifier of the Client Encryption Key to be used to encrypt the path.
EncryptionAlgorithm string: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionType string: The type of encryption to be performed. Eg - Deterministic, Randomized.
Path string: Path that needs to be encrypted.

ClientEncryptionKeyId string: The identifier of the Client Encryption Key to be used to encrypt the path.
EncryptionAlgorithm string: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionType string: The type of encryption to be performed. Eg - Deterministic, Randomized.
Path string: Path that needs to be encrypted.

clientEncryptionKeyId String: The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm String: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType String: The type of encryption to be performed. Eg - Deterministic, Randomized.
path String: Path that needs to be encrypted.

clientEncryptionKeyId string: The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm string: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType string: The type of encryption to be performed. Eg - Deterministic, Randomized.
path string: Path that needs to be encrypted.

client_encryption_key_id str: The identifier of the Client Encryption Key to be used to encrypt the path.
encryption_algorithm str: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryption_type str: The type of encryption to be performed. Eg - Deterministic, Randomized.
path str: Path that needs to be encrypted.

clientEncryptionKeyId String: The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm String: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType String: The type of encryption to be performed. Eg - Deterministic, Randomized.
path String: Path that needs to be encrypted.

ClientEncryptionPolicyResponse

IncludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.ClientEncryptionIncludedPathResponse>: Paths of the item that need encryption along with path-specific settings.
PolicyFormatVersion int: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

IncludedPaths []ClientEncryptionIncludedPathResponse: Paths of the item that need encryption along with path-specific settings.
PolicyFormatVersion int: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

includedPaths List<ClientEncryptionIncludedPathResponse>: Paths of the item that need encryption along with path-specific settings.
policyFormatVersion Integer: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

includedPaths ClientEncryptionIncludedPathResponse[]: Paths of the item that need encryption along with path-specific settings.
policyFormatVersion number: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

included_paths Sequence[ClientEncryptionIncludedPathResponse]: Paths of the item that need encryption along with path-specific settings.
policy_format_version int: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

includedPaths List<Property Map>: Paths of the item that need encryption along with path-specific settings.
policyFormatVersion Number: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

CompositePathResponse

Order string: Sort order for composite paths.
Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Order string: Sort order for composite paths.
Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

order String: Sort order for composite paths.
path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

order string: Sort order for composite paths.
path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

order str: Sort order for composite paths.
path str: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

order String: Sort order for composite paths.
path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

ComputedPropertyResponse

Name string: The name of a computed property, for example - "cp_lowerName"
Query string: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

Name string: The name of a computed property, for example - "cp_lowerName"
Query string: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

name String: The name of a computed property, for example - "cp_lowerName"
query String: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

name string: The name of a computed property, for example - "cp_lowerName"
query string: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

name str: The name of a computed property, for example - "cp_lowerName"
query str: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

name String: The name of a computed property, for example - "cp_lowerName"
query String: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionPolicyResponse

ConflictResolutionPath string: The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionProcedure string: The procedure to resolve conflicts in the case of custom mode.
Mode string: Indicates the conflict resolution mode.

ConflictResolutionPath string: The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionProcedure string: The procedure to resolve conflicts in the case of custom mode.
Mode string: Indicates the conflict resolution mode.

conflictResolutionPath String: The conflict resolution path in the case of LastWriterWins mode.
conflictResolutionProcedure String: The procedure to resolve conflicts in the case of custom mode.
mode String: Indicates the conflict resolution mode.

conflictResolutionPath string: The conflict resolution path in the case of LastWriterWins mode.
conflictResolutionProcedure string: The procedure to resolve conflicts in the case of custom mode.
mode string: Indicates the conflict resolution mode.

conflict_resolution_path str: The conflict resolution path in the case of LastWriterWins mode.
conflict_resolution_procedure str: The procedure to resolve conflicts in the case of custom mode.
mode str: Indicates the conflict resolution mode.

conflictResolutionPath String: The conflict resolution path in the case of LastWriterWins mode.
conflictResolutionProcedure String: The procedure to resolve conflicts in the case of custom mode.
mode String: Indicates the conflict resolution mode.

ContainerPartitionKeyResponse

SystemKey bool: Indicates if the container is using a system generated partition key
Kind string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
Paths List<string>: List of paths using which data within the container can be partitioned
Version int: Indicates the version of the partition key definition

SystemKey bool: Indicates if the container is using a system generated partition key
Kind string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
Paths []string: List of paths using which data within the container can be partitioned
Version int: Indicates the version of the partition key definition

systemKey Boolean: Indicates if the container is using a system generated partition key
kind String: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths List<String>: List of paths using which data within the container can be partitioned
version Integer: Indicates the version of the partition key definition

systemKey boolean: Indicates if the container is using a system generated partition key
kind string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths string[]: List of paths using which data within the container can be partitioned
version number: Indicates the version of the partition key definition

system_key bool: Indicates if the container is using a system generated partition key
kind str: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths Sequence[str]: List of paths using which data within the container can be partitioned
version int: Indicates the version of the partition key definition

systemKey Boolean: Indicates if the container is using a system generated partition key
kind String: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths List<String>: List of paths using which data within the container can be partitioned
version Number: Indicates the version of the partition key definition

ExcludedPathResponse

Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

path str: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

IncludedPathResponse

Indexes List<Pulumi.AzureNative.CosmosDB.Inputs.IndexesResponse>: List of indexes for this path
Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Indexes []IndexesResponse: List of indexes for this path
Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

indexes List<IndexesResponse>: List of indexes for this path
path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

indexes IndexesResponse[]: List of indexes for this path
path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

indexes Sequence[IndexesResponse]: List of indexes for this path
path str: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

indexes List<Property Map>: List of indexes for this path
path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

IndexesResponse

DataType string: The datatype for which the indexing behavior is applied to.
Kind string: Indicates the type of index.
Precision int: The precision of the index. -1 is maximum precision.

DataType string: The datatype for which the indexing behavior is applied to.
Kind string: Indicates the type of index.
Precision int: The precision of the index. -1 is maximum precision.

dataType String: The datatype for which the indexing behavior is applied to.
kind String: Indicates the type of index.
precision Integer: The precision of the index. -1 is maximum precision.

dataType string: The datatype for which the indexing behavior is applied to.
kind string: Indicates the type of index.
precision number: The precision of the index. -1 is maximum precision.

data_type str: The datatype for which the indexing behavior is applied to.
kind str: Indicates the type of index.
precision int: The precision of the index. -1 is maximum precision.

dataType String: The datatype for which the indexing behavior is applied to.
kind String: Indicates the type of index.
precision Number: The precision of the index. -1 is maximum precision.

IndexingPolicyResponse

Automatic bool: Indicates if the indexing policy is automatic
CompositeIndexes List<ImmutableArray<Pulumi.AzureNative.CosmosDB.Inputs.CompositePathResponse>>: List of composite path list
ExcludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.ExcludedPathResponse>: List of paths to exclude from indexing
IncludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.IncludedPathResponse>: List of paths to include in the indexing
IndexingMode string: Indicates the indexing mode.
SpatialIndexes List<Pulumi.AzureNative.CosmosDB.Inputs.SpatialSpecResponse>: List of spatial specifics
VectorIndexes List<Pulumi.AzureNative.CosmosDB.Inputs.VectorIndexResponse>: List of paths to include in the vector indexing

Automatic bool: Indicates if the indexing policy is automatic
CompositeIndexes [][]CompositePathResponse: List of composite path list
ExcludedPaths []ExcludedPathResponse: List of paths to exclude from indexing
IncludedPaths []IncludedPathResponse: List of paths to include in the indexing
IndexingMode string: Indicates the indexing mode.
SpatialIndexes []SpatialSpecResponse: List of spatial specifics
VectorIndexes []VectorIndexResponse: List of paths to include in the vector indexing

automatic Boolean: Indicates if the indexing policy is automatic
compositeIndexes List<List<CompositePathResponse>>: List of composite path list
excludedPaths List<ExcludedPathResponse>: List of paths to exclude from indexing
includedPaths List<IncludedPathResponse>: List of paths to include in the indexing
indexingMode String: Indicates the indexing mode.
spatialIndexes List<SpatialSpecResponse>: List of spatial specifics
vectorIndexes List<VectorIndexResponse>: List of paths to include in the vector indexing

automatic boolean: Indicates if the indexing policy is automatic
compositeIndexes CompositePathResponse[][]: List of composite path list
excludedPaths ExcludedPathResponse[]: List of paths to exclude from indexing
includedPaths IncludedPathResponse[]: List of paths to include in the indexing
indexingMode string: Indicates the indexing mode.
spatialIndexes SpatialSpecResponse[]: List of spatial specifics
vectorIndexes VectorIndexResponse[]: List of paths to include in the vector indexing

automatic bool: Indicates if the indexing policy is automatic
composite_indexes Sequence[Sequence[CompositePathResponse]]: List of composite path list
excluded_paths Sequence[ExcludedPathResponse]: List of paths to exclude from indexing
included_paths Sequence[IncludedPathResponse]: List of paths to include in the indexing
indexing_mode str: Indicates the indexing mode.
spatial_indexes Sequence[SpatialSpecResponse]: List of spatial specifics
vector_indexes Sequence[VectorIndexResponse]: List of paths to include in the vector indexing

automatic Boolean: Indicates if the indexing policy is automatic
compositeIndexes List<List<Property Map>>: List of composite path list
excludedPaths List<Property Map>: List of paths to exclude from indexing
includedPaths List<Property Map>: List of paths to include in the indexing
indexingMode String: Indicates the indexing mode.
spatialIndexes List<Property Map>: List of spatial specifics
vectorIndexes List<Property Map>: List of paths to include in the vector indexing

ResourceRestoreParametersResponse

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.

SpatialSpecResponse

Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types List<string>: List of path's spatial type

Path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types []string: List of path's spatial type

path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<String>: List of path's spatial type

path string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types string[]: List of path's spatial type

path str: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types Sequence[str]: List of path's spatial type

path String: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<String>: List of path's spatial type

SqlContainerGetPropertiesResponseOptions

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.

SqlContainerGetPropertiesResponseResource

Etag string: A system generated property representing the resource etag required for optimistic concurrency control.
Id string: Name of the Cosmos DB SQL container
Rid string: A system generated property. A unique identifier.
Ts double: A system generated property that denotes the last updated timestamp of the resource.
AnalyticalStorageTtl double: Analytical TTL.
ClientEncryptionPolicy Pulumi.AzureNative.CosmosDB.Inputs.ClientEncryptionPolicyResponse: The client encryption policy for the container.
ComputedProperties List<Pulumi.AzureNative.CosmosDB.Inputs.ComputedPropertyResponse>: List of computed properties
ConflictResolutionPolicy Pulumi.AzureNative.CosmosDB.Inputs.ConflictResolutionPolicyResponse: The conflict resolution policy for the container.
CreateMode string: Enum to indicate the mode of resource creation.
DefaultTtl int: Default time to live
IndexingPolicy Pulumi.AzureNative.CosmosDB.Inputs.IndexingPolicyResponse: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
PartitionKey Pulumi.AzureNative.CosmosDB.Inputs.ContainerPartitionKeyResponse: The configuration of the partition key to be used for partitioning data into multiple partitions
RestoreParameters Pulumi.AzureNative.CosmosDB.Inputs.ResourceRestoreParametersResponse: Parameters to indicate the information about the restore
UniqueKeyPolicy Pulumi.AzureNative.CosmosDB.Inputs.UniqueKeyPolicyResponse: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
VectorEmbeddingPolicy Pulumi.AzureNative.CosmosDB.Inputs.VectorEmbeddingPolicyResponse: The vector embedding policy for the container.

Etag string: A system generated property representing the resource etag required for optimistic concurrency control.
Id string: Name of the Cosmos DB SQL container
Rid string: A system generated property. A unique identifier.
Ts float64: A system generated property that denotes the last updated timestamp of the resource.
AnalyticalStorageTtl float64: Analytical TTL.
ClientEncryptionPolicy ClientEncryptionPolicyResponse: The client encryption policy for the container.
ComputedProperties []ComputedPropertyResponse: List of computed properties
ConflictResolutionPolicy ConflictResolutionPolicyResponse: The conflict resolution policy for the container.
CreateMode string: Enum to indicate the mode of resource creation.
DefaultTtl int: Default time to live
IndexingPolicy IndexingPolicyResponse: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
PartitionKey ContainerPartitionKeyResponse: The configuration of the partition key to be used for partitioning data into multiple partitions
RestoreParameters ResourceRestoreParametersResponse: Parameters to indicate the information about the restore
UniqueKeyPolicy UniqueKeyPolicyResponse: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
VectorEmbeddingPolicy VectorEmbeddingPolicyResponse: The vector embedding policy for the container.

etag String: A system generated property representing the resource etag required for optimistic concurrency control.
id String: Name of the Cosmos DB SQL container
rid String: A system generated property. A unique identifier.
ts Double: A system generated property that denotes the last updated timestamp of the resource.
analyticalStorageTtl Double: Analytical TTL.
clientEncryptionPolicy ClientEncryptionPolicyResponse: The client encryption policy for the container.
computedProperties List<ComputedPropertyResponse>: List of computed properties
conflictResolutionPolicy ConflictResolutionPolicyResponse: The conflict resolution policy for the container.
createMode String: Enum to indicate the mode of resource creation.
defaultTtl Integer: Default time to live
indexingPolicy IndexingPolicyResponse: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey ContainerPartitionKeyResponse: The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters ResourceRestoreParametersResponse: Parameters to indicate the information about the restore
uniqueKeyPolicy UniqueKeyPolicyResponse: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy VectorEmbeddingPolicyResponse: The vector embedding policy for the container.

etag string: A system generated property representing the resource etag required for optimistic concurrency control.
id string: Name of the Cosmos DB SQL container
rid string: A system generated property. A unique identifier.
ts number: A system generated property that denotes the last updated timestamp of the resource.
analyticalStorageTtl number: Analytical TTL.
clientEncryptionPolicy ClientEncryptionPolicyResponse: The client encryption policy for the container.
computedProperties ComputedPropertyResponse[]: List of computed properties
conflictResolutionPolicy ConflictResolutionPolicyResponse: The conflict resolution policy for the container.
createMode string: Enum to indicate the mode of resource creation.
defaultTtl number: Default time to live
indexingPolicy IndexingPolicyResponse: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey ContainerPartitionKeyResponse: The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters ResourceRestoreParametersResponse: Parameters to indicate the information about the restore
uniqueKeyPolicy UniqueKeyPolicyResponse: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy VectorEmbeddingPolicyResponse: The vector embedding policy for the container.

etag str: A system generated property representing the resource etag required for optimistic concurrency control.
id str: Name of the Cosmos DB SQL container
rid str: A system generated property. A unique identifier.
ts float: A system generated property that denotes the last updated timestamp of the resource.
analytical_storage_ttl float: Analytical TTL.
client_encryption_policy ClientEncryptionPolicyResponse: The client encryption policy for the container.
computed_properties Sequence[ComputedPropertyResponse]: List of computed properties
conflict_resolution_policy ConflictResolutionPolicyResponse: The conflict resolution policy for the container.
create_mode str: Enum to indicate the mode of resource creation.
default_ttl int: Default time to live
indexing_policy IndexingPolicyResponse: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partition_key ContainerPartitionKeyResponse: The configuration of the partition key to be used for partitioning data into multiple partitions
restore_parameters ResourceRestoreParametersResponse: Parameters to indicate the information about the restore
unique_key_policy UniqueKeyPolicyResponse: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vector_embedding_policy VectorEmbeddingPolicyResponse: The vector embedding policy for the container.

etag String: A system generated property representing the resource etag required for optimistic concurrency control.
id String: Name of the Cosmos DB SQL container
rid String: A system generated property. A unique identifier.
ts Number: A system generated property that denotes the last updated timestamp of the resource.
analyticalStorageTtl Number: Analytical TTL.
clientEncryptionPolicy Property Map: The client encryption policy for the container.
computedProperties List<Property Map>: List of computed properties
conflictResolutionPolicy Property Map: The conflict resolution policy for the container.
createMode String: Enum to indicate the mode of resource creation.
defaultTtl Number: Default time to live
indexingPolicy Property Map: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey Property Map: The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters Property Map: Parameters to indicate the information about the restore
uniqueKeyPolicy Property Map: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy Property Map: The vector embedding policy for the container.

UniqueKeyPolicyResponse

UniqueKeys List<Pulumi.AzureNative.CosmosDB.Inputs.UniqueKeyResponse>: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

UniqueKeys []UniqueKeyResponse: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

uniqueKeys List<UniqueKeyResponse>: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

uniqueKeys UniqueKeyResponse[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

unique_keys Sequence[UniqueKeyResponse]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

uniqueKeys List<Property Map>: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

UniqueKeyResponse

Paths List<string>: List of paths must be unique for each document in the Azure Cosmos DB service

Paths []string: List of paths must be unique for each document in the Azure Cosmos DB service

paths List<String>: List of paths must be unique for each document in the Azure Cosmos DB service

paths string[]: List of paths must be unique for each document in the Azure Cosmos DB service

paths Sequence[str]: List of paths must be unique for each document in the Azure Cosmos DB service

paths List<String>: List of paths must be unique for each document in the Azure Cosmos DB service

VectorEmbeddingPolicyResponse

VectorEmbeddings List<Pulumi.AzureNative.CosmosDB.Inputs.VectorEmbeddingResponse>: List of vector embeddings

VectorEmbeddings []VectorEmbeddingResponse: List of vector embeddings

vectorEmbeddings List<VectorEmbeddingResponse>: List of vector embeddings

vectorEmbeddings VectorEmbeddingResponse[]: List of vector embeddings

vector_embeddings Sequence[VectorEmbeddingResponse]: List of vector embeddings

vectorEmbeddings List<Property Map>: List of vector embeddings

VectorEmbeddingResponse

DataType string: Indicates the data type of vector.
Dimensions int: The number of dimensions in the vector.
DistanceFunction string: The distance function to use for distance calculation in between vectors.
Path string: The path to the vector field in the document.

DataType string: Indicates the data type of vector.
Dimensions int: The number of dimensions in the vector.
DistanceFunction string: The distance function to use for distance calculation in between vectors.
Path string: The path to the vector field in the document.

dataType String: Indicates the data type of vector.
dimensions Integer: The number of dimensions in the vector.
distanceFunction String: The distance function to use for distance calculation in between vectors.
path String: The path to the vector field in the document.

dataType string: Indicates the data type of vector.
dimensions number: The number of dimensions in the vector.
distanceFunction string: The distance function to use for distance calculation in between vectors.
path string: The path to the vector field in the document.

data_type str: Indicates the data type of vector.
dimensions int: The number of dimensions in the vector.
distance_function str: The distance function to use for distance calculation in between vectors.
path str: The path to the vector field in the document.

dataType String: Indicates the data type of vector.
dimensions Number: The number of dimensions in the vector.
distanceFunction String: The distance function to use for distance calculation in between vectors.
path String: The path to the vector field in the document.

VectorIndexResponse

Path string: The path to the vector field in the document.
Type string: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

Path string: The path to the vector field in the document.
Type string: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

path String: The path to the vector field in the document.
type String: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

path string: The path to the vector field in the document.
type string: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

path str: The path to the vector field in the document.
type str: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

path String: The path to the vector field in the document.
type String: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

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

azure-native.cosmosdb.getSqlResourceSqlContainer

On this page

On this page

Using getSqlResourceSqlContainer

getSqlResourceSqlContainer Result

Supporting Types

AutoscaleSettingsResponse

ClientEncryptionIncludedPathResponse

ClientEncryptionPolicyResponse

CompositePathResponse

ComputedPropertyResponse

ConflictResolutionPolicyResponse

ContainerPartitionKeyResponse

ExcludedPathResponse

IncludedPathResponse

IndexesResponse

IndexingPolicyResponse

ResourceRestoreParametersResponse

SpatialSpecResponse

SqlContainerGetPropertiesResponseOptions

SqlContainerGetPropertiesResponseResource

UniqueKeyPolicyResponse

UniqueKeyResponse

VectorEmbeddingPolicyResponse

VectorEmbeddingResponse

VectorIndexResponse

Package Details

On this page

On this page