CosmosDbDataConnection Class
Definition
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.
Class representing a CosmosDb data connection.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.CosmosDbDataConnectionTypeConverter))]
public class CosmosDbDataConnection : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ICosmosDbDataConnection, Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.CosmosDbDataConnectionTypeConverter))>]
type CosmosDbDataConnection = class
interface ICosmosDbDataConnection
interface IJsonSerializable
interface IDataConnection
interface IResource
interface IValidates
Public Class CosmosDbDataConnection
Implements ICosmosDbDataConnection, IValidates
- Inheritance
-
CosmosDbDataConnection
- Attributes
- Implements
Constructors
CosmosDbDataConnection() |
Creates an new CosmosDbDataConnection 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. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
Kind |
Kind of the endpoint for the data connection |
Location |
Resource location. |
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 |
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. |
Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of CosmosDbDataConnection. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of CosmosDbDataConnection. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.ICosmosDbDataConnection. |
FromJsonString(String) |
Creates a new instance of CosmosDbDataConnection, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of CosmosDbDataConnection into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |