RoutingCosmosDBSqlApiProperties Class

Reference

Definition

Namespace:: Azure.ResourceManager.IotHub.Models

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Package:: Azure.ResourceManager.IotHub v1.2.0-beta.1

Source:: RoutingCosmosDBSqlApiProperties.cs

Source:: RoutingCosmosDBSqlApiProperties.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The properties related to a cosmos DB sql container endpoint.

public class RoutingCosmosDBSqlApiProperties

public class RoutingCosmosDBSqlApiProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotHub.Models.RoutingCosmosDBSqlApiProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotHub.Models.RoutingCosmosDBSqlApiProperties>

type RoutingCosmosDBSqlApiProperties = class

type RoutingCosmosDBSqlApiProperties = class
    interface IJsonModel<RoutingCosmosDBSqlApiProperties>
    interface IPersistableModel<RoutingCosmosDBSqlApiProperties>

Public Class RoutingCosmosDBSqlApiProperties

Public Class RoutingCosmosDBSqlApiProperties
Implements IJsonModel(Of RoutingCosmosDBSqlApiProperties), IPersistableModel(Of RoutingCosmosDBSqlApiProperties)

Inheritance: Object
RoutingCosmosDBSqlApiProperties

Implements: IJsonModel<RoutingCosmosDBSqlApiProperties> IPersistableModel<RoutingCosmosDBSqlApiProperties> IPersistableModel<T>

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<RoutingCosmosDBSqlApiProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<RoutingCosmosDBSqlApiProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<RoutingCosmosDBSqlApiProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<RoutingCosmosDBSqlApiProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<RoutingCosmosDBSqlApiProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via