RoutingCosmosDBSqlApiProperties Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.IotHub.Models
Assembly:
Azure.ResourceManager.IotHub.dll
Package:
Azure.ResourceManager.IotHub v1.1.1
Source:
RoutingCosmosDBSqlApiProperties.cs

The properties related to a cosmos DB sql container endpoint.

public class RoutingCosmosDBSqlApiProperties
type RoutingCosmosDBSqlApiProperties = class
Public Class RoutingCosmosDBSqlApiProperties
Inheritance
Object
RoutingCosmosDBSqlApiProperties

Constructors

RoutingCosmosDBSqlApiProperties(String, Uri, String, String)

Initializes a new instance of RoutingCosmosDBSqlApiProperties.

Properties

AuthenticationType

Method used to authenticate against the cosmos DB sql container endpoint.
ContainerName

The name of the cosmos DB sql container in the cosmos DB database.
DatabaseName

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

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

Id of the cosmos DB sql container endpoint.
Name

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

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

The template for generating a synthetic partition key value for use with this cosmos DB sql container. 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

The primary key of the cosmos DB account.
ResourceGroup

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

The secondary key of the cosmos DB account.
SubscriptionId

The subscription identifier of the cosmos DB account.
UserAssignedIdentity

The user assigned identity.

Applies to