ArmIotHubModelFactory.RoutingCosmosDBSqlApiProperties Method

Definition

Namespace:

Azure.ResourceManager.IotHub.Models

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

ArmIotHubModelFactory.cs

Initializes a new instance of RoutingCosmosDBSqlApiProperties.

public static Azure.ResourceManager.IotHub.Models.RoutingCosmosDBSqlApiProperties RoutingCosmosDBSqlApiProperties (string name = default, string id = default, string subscriptionId = default, string resourceGroup = default, Uri endpointUri = default, Azure.ResourceManager.IotHub.Models.IotHubAuthenticationType? authenticationType = default, Azure.Core.ResourceIdentifier userAssignedIdentity = default, string primaryKey = default, string secondaryKey = default, string databaseName = default, string containerName = default, string partitionKeyName = default, string partitionKeyTemplate = default);

static member RoutingCosmosDBSqlApiProperties : string * string * string * string * Uri * Nullable<Azure.ResourceManager.IotHub.Models.IotHubAuthenticationType> * Azure.Core.ResourceIdentifier * string * string * string * string * string * string -> Azure.ResourceManager.IotHub.Models.RoutingCosmosDBSqlApiProperties

Public Shared Function RoutingCosmosDBSqlApiProperties (Optional name As String = Nothing, Optional id As String = Nothing, Optional subscriptionId As String = Nothing, Optional resourceGroup As String = Nothing, Optional endpointUri As Uri = Nothing, Optional authenticationType As Nullable(Of IotHubAuthenticationType) = Nothing, Optional userAssignedIdentity As ResourceIdentifier = Nothing, Optional primaryKey As String = Nothing, Optional secondaryKey As String = Nothing, Optional databaseName As String = Nothing, Optional containerName As String = Nothing, Optional partitionKeyName As String = Nothing, Optional partitionKeyTemplate As String = Nothing) As RoutingCosmosDBSqlApiProperties

Parameters

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.

id

String

Id of the cosmos DB sql container endpoint.

subscriptionId

String

The subscription identifier of the cosmos DB account.

resourceGroup

String

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

endpointUri

Uri

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

authenticationType

Nullable<IotHubAuthenticationType>

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

userAssignedIdentity

ResourceIdentifier

Managed identity properties of routing cosmos DB container endpoint.

primaryKey

String

The primary key of the cosmos DB account.

secondaryKey

String

The secondary key of the cosmos DB account.

databaseName

String

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

containerName

String

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

partitionKeyName

String

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

partitionKeyTemplate

String

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.

Returns

RoutingCosmosDBSqlApiProperties

A new RoutingCosmosDBSqlApiProperties instance for mocking.