Share via


KustoCosmosDBDataConnection Class

Definition

Class representing a CosmosDb data connection.

public class KustoCosmosDBDataConnection : Azure.ResourceManager.Kusto.KustoDataConnectionData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Kusto.Models.KustoCosmosDBDataConnection>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Kusto.Models.KustoCosmosDBDataConnection>
type KustoCosmosDBDataConnection = class
    inherit KustoDataConnectionData
    interface IJsonModel<KustoCosmosDBDataConnection>
    interface IPersistableModel<KustoCosmosDBDataConnection>
Public Class KustoCosmosDBDataConnection
Inherits KustoDataConnectionData
Implements IJsonModel(Of KustoCosmosDBDataConnection), IPersistableModel(Of KustoCosmosDBDataConnection)
Inheritance
KustoCosmosDBDataConnection
Implements

Constructors

KustoCosmosDBDataConnection()

Initializes a new instance of KustoCosmosDBDataConnection.

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.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Location

Resource location.

(Inherited from KustoDataConnectionData)
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.

Name

The name of the resource.

(Inherited from ResourceData)
ProvisioningState

The provisioned state of the resource.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
RetrievalStartOn

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

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TableName

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<KustoCosmosDBDataConnection>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<KustoCosmosDBDataConnection>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<KustoDataConnectionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from KustoDataConnectionData)
IJsonModel<KustoDataConnectionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoCosmosDBDataConnection>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<KustoCosmosDBDataConnection>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<KustoCosmosDBDataConnection>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<KustoDataConnectionData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoDataConnectionData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoDataConnectionData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KustoDataConnectionData)

Applies to