pulumi-azure-native-kotlin/com.pulumi.azurenative.devices.kotlin.outputs/RoutingCosmosDBSqlApiPropertiesResponse

RoutingCosmosDBSqlApiPropertiesResponse

data class RoutingCosmosDBSqlApiPropertiesResponse(val authenticationType: String? = null, val collectionName: String, val databaseName: String, val endpointUri: String, val id: String? = null, val identity: ManagedIdentityResponse? = null, val name: String, val partitionKeyName: String? = null, val partitionKeyTemplate: String? = null, val primaryKey: String? = null, val resourceGroup: String? = null, val secondaryKey: String? = null, val subscriptionId: String? = null)

The properties related to a cosmos DB sql collection endpoint.

Constructors

constructor(authenticationType: String? = null, collectionName: String, databaseName: String, endpointUri: String, id: String? = null, identity: ManagedIdentityResponse? = null, name: String, partitionKeyName: String? = null, partitionKeyTemplate: String? = null, primaryKey: String? = null, resourceGroup: String? = null, secondaryKey: String? = null, subscriptionId: String? = null)

Types

Companion

object Companion

Properties

authenticationType

val authenticationType: String? = null

Method used to authenticate against the cosmos DB sql collection endpoint

collectionName

val collectionName: String

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

databaseName

val databaseName: String

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

endpointUri

val endpointUri: String

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

val id: String? = null

Id of the cosmos DB sql collection endpoint

identity

val identity: ManagedIdentityResponse? = null

Managed identity properties of routing cosmos DB collection endpoint.

name

val name: 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: 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: 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: String? = null

The primary key of the cosmos DB account.

resourceGroup

val resourceGroup: String? = null

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

secondaryKey

val secondaryKey: String? = null

The secondary key of the cosmos DB account.

subscriptionId

val subscriptionId: String? = null

The subscription identifier of the cosmos DB account.