Share via


CosmosDbDataConnectionProperties Class

Definition

Class representing the Kusto CosmosDb data connection properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.CosmosDbDataConnectionPropertiesTypeConverter))]
public class CosmosDbDataConnectionProperties : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ICosmosDbDataConnectionProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.CosmosDbDataConnectionPropertiesTypeConverter))>]
type CosmosDbDataConnectionProperties = class
    interface ICosmosDbDataConnectionProperties
    interface IJsonSerializable
Public Class CosmosDbDataConnectionProperties
Implements ICosmosDbDataConnectionProperties
Inheritance
CosmosDbDataConnectionProperties
Attributes
Implements

Constructors

CosmosDbDataConnectionProperties()

Creates an new CosmosDbDataConnectionProperties instance.

Properties

CosmosDbAccountResourceId

The resource ID of the Cosmos DB account used to create the data connection.

CosmosDbContainer

The name of an existing container in the Cosmos DB database.

CosmosDbDatabase

The name of an existing database in the Cosmos DB account.

ManagedIdentityObjectId

The object ID of the managed identity resource.

ManagedIdentityResourceId

The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.

MappingRuleName

The name of an existing mapping rule to use when ingesting the retrieved data.

ProvisioningState

The provisioned state of the resource.

RetrievalStartDate

Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.

TableName

The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of CosmosDbDataConnectionProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of CosmosDbDataConnectionProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ICosmosDbDataConnectionProperties.

FromJsonString(String)

Creates a new instance of CosmosDbDataConnectionProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of CosmosDbDataConnectionProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to