pulumi-azure-native-kotlin/com.pulumi.azurenative.devices.kotlin.inputs/RoutingCosmosDBSqlApiPropertiesArgs

RoutingCosmosDBSqlApiPropertiesArgs

data class RoutingCosmosDBSqlApiPropertiesArgs(val authenticationType: Output<Either<String, AuthenticationType>>? = null, val collectionName: Output<String>, val databaseName: Output<String>, val endpointUri: Output<String>, val id: Output<String>? = null, val identity: Output<ManagedIdentityArgs>? = null, val name: Output<String>, val partitionKeyName: Output<String>? = null, val partitionKeyTemplate: Output<String>? = null, val primaryKey: Output<String>? = null, val resourceGroup: Output<String>? = null, val secondaryKey: Output<String>? = null, val subscriptionId: Output<String>? = null) : ConvertibleToJava<RoutingCosmosDBSqlApiPropertiesArgs>

The properties related to a cosmos DB sql collection endpoint.

Constructors

fun RoutingCosmosDBSqlApiPropertiesArgs(authenticationType: Output<Either<String, AuthenticationType>>? = null, collectionName: Output<String>, databaseName: Output<String>, endpointUri: Output<String>, id: Output<String>? = null, identity: Output<ManagedIdentityArgs>? = null, name: Output<String>, partitionKeyName: Output<String>? = null, partitionKeyTemplate: Output<String>? = null, primaryKey: Output<String>? = null, resourceGroup: Output<String>? = null, secondaryKey: Output<String>? = null, subscriptionId: Output<String>? = null)

Functions

toJava

open override fun toJava(): RoutingCosmosDBSqlApiPropertiesArgs

Properties

authenticationType

val authenticationType: Output<Either<String, AuthenticationType>>? = null

Method used to authenticate against the cosmos DB sql collection endpoint

collectionName

val collectionName: Output<String>

The name of the cosmos DB sql collection in the cosmos DB database.

databaseName

val databaseName: Output<String>

The name of the cosmos DB database in the cosmos DB account.

endpointUri

val endpointUri: Output<String>

The url of the cosmos DB account. It must include the protocol https://

val id: Output<String>? = null

Id of the cosmos DB sql collection endpoint

identity

val identity: Output<ManagedIdentityArgs>? = null

Managed identity properties of routing cosmos DB collection endpoint.

name

val name: Output<String>

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

partitionKeyName

val partitionKeyName: Output<String>? = null

The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.

partitionKeyTemplate

val partitionKeyTemplate: Output<String>? = null

The template for generating a synthetic partition key value for use with this cosmos DB sql collection. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.

primaryKey

val primaryKey: Output<String>? = null

The primary key of the cosmos DB account.

resourceGroup

val resourceGroup: Output<String>? = null

The name of the resource group of the cosmos DB account.

secondaryKey

val secondaryKey: Output<String>? = null

The secondary key of the cosmos DB account.

subscriptionId

val subscriptionId: Output<String>? = null

The subscription identifier of the cosmos DB account.