Gets the SQL container under an existing Azure Cosmos DB database account.
Uses Azure REST API version 2025-10-15.
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-11-15, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview, 2025-11-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 dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
- Container
Name string - Cosmos DB container name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - Cosmos DB database account name.
- Container
Name string - Cosmos DB container name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- container
Name String - Cosmos DB container name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - Cosmos DB database account name.
- container
Name string - Cosmos DB container name.
- database
Name string - Cosmos DB database name.
- resource
Group stringName - 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_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- container
Name String - Cosmos DB container name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getSqlResourceSqlContainer Result
The following output properties are available:
- Azure
Api stringVersion - 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.
Azure Native. Cosmos DB. Outputs. Sql Container Get Properties Response Options - Resource
Pulumi.
Azure Native. Cosmos DB. Outputs. Sql Container Get Properties Response Resource - 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".
- Azure
Api stringVersion - 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
Sql
Container Get Properties Response Options - Resource
Sql
Container Get Properties Response Resource - 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".
- azure
Api StringVersion - 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
Sql
Container Get Properties Response Options - resource
Sql
Container Get Properties Response Resource - 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".
- azure
Api stringVersion - 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
Sql
Container Get Properties Response Options - resource
Sql
Container Get Properties Response Resource - {[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_ strversion - 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
Sql
Container Get Properties Response Options - resource
Sql
Container Get Properties Response Resource - 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".
- azure
Api StringVersion - 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
- 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
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
ClientEncryptionIncludedPathResponse
- Client
Encryption stringKey Id - The identifier of the Client Encryption Key to be used to encrypt the path.
- Encryption
Algorithm string - The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
- Encryption
Type string - The type of encryption to be performed. Eg - Deterministic, Randomized.
- Path string
- Path that needs to be encrypted.
- Client
Encryption stringKey Id - The identifier of the Client Encryption Key to be used to encrypt the path.
- Encryption
Algorithm string - The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
- Encryption
Type string - The type of encryption to be performed. Eg - Deterministic, Randomized.
- Path string
- Path that needs to be encrypted.
- client
Encryption StringKey Id - The identifier of the Client Encryption Key to be used to encrypt the path.
- encryption
Algorithm String - The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
- encryption
Type String - The type of encryption to be performed. Eg - Deterministic, Randomized.
- path String
- Path that needs to be encrypted.
- client
Encryption stringKey Id - The identifier of the Client Encryption Key to be used to encrypt the path.
- encryption
Algorithm string - The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
- encryption
Type string - The type of encryption to be performed. Eg - Deterministic, Randomized.
- path string
- Path that needs to be encrypted.
- client_
encryption_ strkey_ id - 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.
- client
Encryption StringKey Id - The identifier of the Client Encryption Key to be used to encrypt the path.
- encryption
Algorithm String - The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
- encryption
Type String - The type of encryption to be performed. Eg - Deterministic, Randomized.
- path String
- Path that needs to be encrypted.
ClientEncryptionPolicyResponse
- Included
Paths List<Pulumi.Azure Native. Cosmos DB. Inputs. Client Encryption Included Path Response> - Paths of the item that need encryption along with path-specific settings.
- Policy
Format intVersion - Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
- Included
Paths []ClientEncryption Included Path Response - Paths of the item that need encryption along with path-specific settings.
- Policy
Format intVersion - Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
- included
Paths List<ClientEncryption Included Path Response> - Paths of the item that need encryption along with path-specific settings.
- policy
Format IntegerVersion - Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
- included
Paths ClientEncryption Included Path Response[] - Paths of the item that need encryption along with path-specific settings.
- policy
Format numberVersion - 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[ClientEncryption Included Path Response] - Paths of the item that need encryption along with path-specific settings.
- policy_
format_ intversion - Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
- included
Paths List<Property Map> - Paths of the item that need encryption along with path-specific settings.
- policy
Format NumberVersion - Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
CompositePathResponse
ComputedPropertyResponse
ConflictResolutionPolicyResponse
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode string
- Indicates the conflict resolution mode.
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode string
- Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode String
- Indicates the conflict resolution mode.
- conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode string
- Indicates the conflict resolution mode.
- conflict_
resolution_ strpath - The conflict resolution path in the case of LastWriterWins mode.
- conflict_
resolution_ strprocedure - The procedure to resolve conflicts in the case of custom mode.
- mode str
- Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode String
- Indicates the conflict resolution mode.
ContainerPartitionKeyResponse
- System
Key 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
- System
Key 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
- system
Key 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
- system
Key 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
- system
Key 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/*)
FullTextIndexPathResponse
- Path string
- The path to the full text field in the document.
- Path string
- The path to the full text field in the document.
- path String
- The path to the full text field in the document.
- path string
- The path to the full text field in the document.
- path str
- The path to the full text field in the document.
- path String
- The path to the full text field in the document.
FullTextPathResponse
FullTextPolicyResponse
- Default
Language string - The default language for a full text paths.
- Full
Text List<Pulumi.Paths Azure Native. Cosmos DB. Inputs. Full Text Path Response> - List of FullText Paths
- Default
Language string - The default language for a full text paths.
- Full
Text []FullPaths Text Path Response - List of FullText Paths
- default
Language String - The default language for a full text paths.
- full
Text List<FullPaths Text Path Response> - List of FullText Paths
- default
Language string - The default language for a full text paths.
- full
Text FullPaths Text Path Response[] - List of FullText Paths
- default_
language str - The default language for a full text paths.
- full_
text_ Sequence[Fullpaths Text Path Response] - List of FullText Paths
- default
Language String - The default language for a full text paths.
- full
Text List<Property Map>Paths - List of FullText Paths
IncludedPathResponse
- Indexes
List<Pulumi.
Azure Native. Cosmos DB. Inputs. Indexes Response> - 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
[]Indexes
Response - 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<Indexes
Response> - 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
Indexes
Response[] - 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[Indexes
Response] - 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
IndexingPolicyResponse
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes List<ImmutableArray<Pulumi. Azure Native. Cosmos DB. Inputs. Composite Path Response>> - List of composite path list
- Excluded
Paths List<Pulumi.Azure Native. Cosmos DB. Inputs. Excluded Path Response> - List of paths to exclude from indexing
- Full
Text List<Pulumi.Indexes Azure Native. Cosmos DB. Inputs. Full Text Index Path Response> - List of paths to include in the full text indexing
- Included
Paths List<Pulumi.Azure Native. Cosmos DB. Inputs. Included Path Response> - List of paths to include in the indexing
- Indexing
Mode string - Indicates the indexing mode.
- Spatial
Indexes List<Pulumi.Azure Native. Cosmos DB. Inputs. Spatial Spec Response> - List of spatial specifics
- Vector
Indexes List<Pulumi.Azure Native. Cosmos DB. Inputs. Vector Index Response> - List of paths to include in the vector indexing
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes [][]CompositePath Response - List of composite path list
- Excluded
Paths []ExcludedPath Response - List of paths to exclude from indexing
- Full
Text []FullIndexes Text Index Path Response - List of paths to include in the full text indexing
- Included
Paths []IncludedPath Response - List of paths to include in the indexing
- Indexing
Mode string - Indicates the indexing mode.
- Spatial
Indexes []SpatialSpec Response - List of spatial specifics
- Vector
Indexes []VectorIndex Response - List of paths to include in the vector indexing
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<CompositePath Response>> - List of composite path list
- excluded
Paths List<ExcludedPath Response> - List of paths to exclude from indexing
- full
Text List<FullIndexes Text Index Path Response> - List of paths to include in the full text indexing
- included
Paths List<IncludedPath Response> - List of paths to include in the indexing
- indexing
Mode String - Indicates the indexing mode.
- spatial
Indexes List<SpatialSpec Response> - List of spatial specifics
- vector
Indexes List<VectorIndex Response> - List of paths to include in the vector indexing
- automatic boolean
- Indicates if the indexing policy is automatic
- composite
Indexes CompositePath Response[][] - List of composite path list
- excluded
Paths ExcludedPath Response[] - List of paths to exclude from indexing
- full
Text FullIndexes Text Index Path Response[] - List of paths to include in the full text indexing
- included
Paths IncludedPath Response[] - List of paths to include in the indexing
- indexing
Mode string - Indicates the indexing mode.
- spatial
Indexes SpatialSpec Response[] - List of spatial specifics
- vector
Indexes VectorIndex Response[] - List of paths to include in the vector indexing
- automatic bool
- Indicates if the indexing policy is automatic
- composite_
indexes Sequence[Sequence[CompositePath Response]] - List of composite path list
- excluded_
paths Sequence[ExcludedPath Response] - List of paths to exclude from indexing
- full_
text_ Sequence[Fullindexes Text Index Path Response] - List of paths to include in the full text indexing
- included_
paths Sequence[IncludedPath Response] - List of paths to include in the indexing
- indexing_
mode str - Indicates the indexing mode.
- spatial_
indexes Sequence[SpatialSpec Response] - List of spatial specifics
- vector_
indexes Sequence[VectorIndex Response] - List of paths to include in the vector indexing
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<Property Map>> - List of composite path list
- excluded
Paths List<Property Map> - List of paths to exclude from indexing
- full
Text List<Property Map>Indexes - List of paths to include in the full text indexing
- included
Paths List<Property Map> - List of paths to include in the indexing
- indexing
Mode String - Indicates the indexing mode.
- spatial
Indexes List<Property Map> - List of spatial specifics
- vector
Indexes List<Property Map> - List of paths to include in the vector indexing
ResourceRestoreParametersResponse
- Restore
Source 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}
- Restore
Timestamp stringIn Utc - Time to which the account has to be restored (ISO-8601 format).
- Restore
With boolTtl Disabled - Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
- Restore
Source 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}
- Restore
Timestamp stringIn Utc - Time to which the account has to be restored (ISO-8601 format).
- Restore
With boolTtl Disabled - Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
- restore
Source 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}
- restore
Timestamp StringIn Utc - Time to which the account has to be restored (ISO-8601 format).
- restore
With BooleanTtl Disabled - Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
- restore
Source 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}
- restore
Timestamp stringIn Utc - Time to which the account has to be restored (ISO-8601 format).
- restore
With booleanTtl Disabled - 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_ strin_ utc - Time to which the account has to be restored (ISO-8601 format).
- restore_
with_ boolttl_ disabled - Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
- restore
Source 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}
- restore
Timestamp StringIn Utc - Time to which the account has to be restored (ISO-8601 format).
- restore
With BooleanTtl Disabled - Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
SpatialSpecResponse
SqlContainerGetPropertiesResponseOptions
- Autoscale
Settings Pulumi.Azure Native. Cosmos DB. Inputs. Autoscale Settings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput Integer
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - 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 AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings 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.
- Analytical
Storage doubleTtl - Analytical TTL.
- Client
Encryption Pulumi.Policy Azure Native. Cosmos DB. Inputs. Client Encryption Policy Response - The client encryption policy for the container.
- Computed
Properties List<Pulumi.Azure Native. Cosmos DB. Inputs. Computed Property Response> - List of computed properties
- Conflict
Resolution Pulumi.Policy Azure Native. Cosmos DB. Inputs. Conflict Resolution Policy Response - The conflict resolution policy for the container.
- Create
Mode string - Enum to indicate the mode of resource creation.
- Default
Ttl int - Default time to live
- Full
Text Pulumi.Policy Azure Native. Cosmos DB. Inputs. Full Text Policy Response - The FullText policy for the container.
- Indexing
Policy Pulumi.Azure Native. Cosmos DB. Inputs. Indexing Policy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- Partition
Key Pulumi.Azure Native. Cosmos DB. Inputs. Container Partition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- Restore
Parameters Pulumi.Azure Native. Cosmos DB. Inputs. Resource Restore Parameters Response - Parameters to indicate the information about the restore
- Unique
Key Pulumi.Policy Azure Native. Cosmos DB. Inputs. Unique Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- Vector
Embedding Pulumi.Policy Azure Native. Cosmos DB. Inputs. Vector Embedding Policy Response - 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.
- Analytical
Storage float64Ttl - Analytical TTL.
- Client
Encryption ClientPolicy Encryption Policy Response - The client encryption policy for the container.
- Computed
Properties []ComputedProperty Response - List of computed properties
- Conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the container.
- Create
Mode string - Enum to indicate the mode of resource creation.
- Default
Ttl int - Default time to live
- Full
Text FullPolicy Text Policy Response - The FullText policy for the container.
- Indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- Partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- Restore
Parameters ResourceRestore Parameters Response - Parameters to indicate the information about the restore
- Unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- Vector
Embedding VectorPolicy Embedding Policy Response - 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.
- analytical
Storage DoubleTtl - Analytical TTL.
- client
Encryption ClientPolicy Encryption Policy Response - The client encryption policy for the container.
- computed
Properties List<ComputedProperty Response> - List of computed properties
- conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the container.
- create
Mode String - Enum to indicate the mode of resource creation.
- default
Ttl Integer - Default time to live
- full
Text FullPolicy Text Policy Response - The FullText policy for the container.
- indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- restore
Parameters ResourceRestore Parameters Response - Parameters to indicate the information about the restore
- unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- vector
Embedding VectorPolicy Embedding Policy Response - 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.
- analytical
Storage numberTtl - Analytical TTL.
- client
Encryption ClientPolicy Encryption Policy Response - The client encryption policy for the container.
- computed
Properties ComputedProperty Response[] - List of computed properties
- conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the container.
- create
Mode string - Enum to indicate the mode of resource creation.
- default
Ttl number - Default time to live
- full
Text FullPolicy Text Policy Response - The FullText policy for the container.
- indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- restore
Parameters ResourceRestore Parameters Response - Parameters to indicate the information about the restore
- unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- vector
Embedding VectorPolicy Embedding Policy Response - 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_ floatttl - Analytical TTL.
- client_
encryption_ Clientpolicy Encryption Policy Response - The client encryption policy for the container.
- computed_
properties Sequence[ComputedProperty Response] - List of computed properties
- conflict_
resolution_ Conflictpolicy Resolution Policy Response - 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
- full_
text_ Fullpolicy Text Policy Response - The FullText policy for the container.
- indexing_
policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- partition_
key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- restore_
parameters ResourceRestore Parameters Response - Parameters to indicate the information about the restore
- unique_
key_ Uniquepolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- vector_
embedding_ Vectorpolicy Embedding Policy Response - 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.
- analytical
Storage NumberTtl - Analytical TTL.
- client
Encryption Property MapPolicy - The client encryption policy for the container.
- computed
Properties List<Property Map> - List of computed properties
- conflict
Resolution Property MapPolicy - The conflict resolution policy for the container.
- create
Mode String - Enum to indicate the mode of resource creation.
- default
Ttl Number - Default time to live
- full
Text Property MapPolicy - The FullText policy for the container.
- indexing
Policy Property Map - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
- partition
Key Property Map - The configuration of the partition key to be used for partitioning data into multiple partitions
- restore
Parameters Property Map - Parameters to indicate the information about the restore
- unique
Key Property MapPolicy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- vector
Embedding Property MapPolicy - The vector embedding policy for the container.
UniqueKeyPolicyResponse
- Unique
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Unique Key Response> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- Unique
Keys []UniqueKey Response - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys List<UniqueKey Response> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys UniqueKey Response[] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique_
keys Sequence[UniqueKey Response] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys 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
- Vector
Embeddings List<Pulumi.Azure Native. Cosmos DB. Inputs. Vector Embedding Response> - List of vector embeddings
- Vector
Embeddings []VectorEmbedding Response - List of vector embeddings
- vector
Embeddings List<VectorEmbedding Response> - List of vector embeddings
- vector
Embeddings VectorEmbedding Response[] - List of vector embeddings
- vector_
embeddings Sequence[VectorEmbedding Response] - List of vector embeddings
- vector
Embeddings List<Property Map> - List of vector embeddings
VectorEmbeddingResponse
- Data
Type string - Indicates the data type of vector.
- Dimensions int
- The number of dimensions in the vector.
- Distance
Function 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 string - Indicates the data type of vector.
- Dimensions int
- The number of dimensions in the vector.
- Distance
Function 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 String - Indicates the data type of vector.
- dimensions Integer
- The number of dimensions in the vector.
- distance
Function 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 string - Indicates the data type of vector.
- dimensions number
- The number of dimensions in the vector.
- distance
Function 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.
- data
Type String - Indicates the data type of vector.
- dimensions Number
- The number of dimensions in the vector.
- distance
Function 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.
- Indexing
Search doubleList Size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- Quantization
Byte doubleSize - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- Vector
Index List<string>Shard Key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
- 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.
- Indexing
Search float64List Size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- Quantization
Byte float64Size - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- Vector
Index []stringShard Key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
- 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.
- indexing
Search DoubleList Size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- quantization
Byte DoubleSize - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- vector
Index List<String>Shard Key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
- 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.
- indexing
Search numberList Size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- quantization
Byte numberSize - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- vector
Index string[]Shard Key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
- 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.
- indexing_
search_ floatlist_ size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- quantization_
byte_ floatsize - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- vector_
index_ Sequence[str]shard_ key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
- 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.
- indexing
Search NumberList Size - This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
- quantization
Byte NumberSize - The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
- vector
Index List<String>Shard Key - Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
