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.
[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("CosmosDb")]
public class CosmosDbLinkedService : Microsoft.Azure.Management.DataFactory.Models.LinkedService
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("CosmosDb")>]
type CosmosDbLinkedService = class
inherit LinkedService
Public Class CosmosDbLinkedService
Inherits LinkedService
- Inheritance
- Attributes
-
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute
Constructors
CosmosDbLinkedService() |
Initializes a new instance of the CosmosDbLinkedService class. |
CosmosDbLinkedService(IDictionary<String,Object>, IntegrationRuntimeReference, String, IDictionary<String,ParameterSpecification>, IList<Object>, Object, Object, Object, SecretBase, Object, String, SecretBase, Object, Object, String, Object, CredentialReference) |
Initializes a new instance of the CosmosDbLinkedService class. |
Properties
AccountEndpoint |
Gets or sets the endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) |
AccountKey |
Gets or sets the account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. |
AdditionalProperties |
Gets or sets unmatched properties from the message are deserialized this collection (Inherited from LinkedService) |
Annotations |
Gets or sets list of tags that can be used for describing the linked service. (Inherited from LinkedService) |
AzureCloudType |
Gets or sets indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). |
ConnectionMode |
Gets or sets the connection mode used to access CosmosDB account. Type: string (or Expression with resultType string). Possible values include: 'Gateway', 'Direct' |
ConnectionString |
Gets or sets the connection string. Type: string, SecureString or AzureKeyVaultSecretReference. |
ConnectVia |
Gets or sets the integration runtime reference. (Inherited from LinkedService) |
Credential |
Gets or sets the credential reference containing authentication information. |
Database |
Gets or sets the name of the database. Type: string (or Expression with resultType string) |
Description |
Gets or sets linked service description. (Inherited from LinkedService) |
EncryptedCredential |
Gets or sets the encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). |
Parameters |
Gets or sets parameters for linked service. (Inherited from LinkedService) |
ServicePrincipalCredential |
Gets or sets the credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. |
ServicePrincipalCredentialType |
Gets or sets the service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). Possible values include: 'ServicePrincipalKey', 'ServicePrincipalCert' |
ServicePrincipalId |
Gets or sets the client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). |
Tenant |
Gets or sets the name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). |
Methods
Validate() |
Validate the object. |
Applies to
Azure SDK for .NET