CosmosDbLinkedService 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.
Microsoft Azure Cosmos Database (CosmosDB) linked service.
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbLinkedService+CosmosDbLinkedServiceConverter))]
public class CosmosDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbLinkedService+CosmosDbLinkedServiceConverter))>]
type CosmosDbLinkedService = class
inherit LinkedService
Public Class CosmosDbLinkedService
Inherits LinkedService
- Inheritance
- Attributes
Constructors
CosmosDbLinkedService() |
Initializes a new instance of CosmosDbLinkedService. |
Properties
AccountEndpoint |
The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string). |
AccountKey |
The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString. |
AdditionalProperties |
Additional Properties. (Inherited from LinkedService) |
Annotations |
List of tags that can be used for describing the linked service. (Inherited from LinkedService) |
ConnectionString |
The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. |
ConnectVia |
The integration runtime reference. (Inherited from LinkedService) |
Credential |
The credential reference containing authentication information. |
Database |
The name of the database. Type: string (or Expression with resultType string). |
Description |
Linked service description. (Inherited from LinkedService) |
EncryptedCredential |
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). |
Parameters |
Parameters for linked service. (Inherited from LinkedService) |