Feedback Edit

CosmosDbLinkedService Class

  • Reference

Microsoft Azure Cosmos Database (CosmosDB) linked service.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
CosmosDbLinkedService

Constructor

CosmosDbLinkedService(*, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, connection_string: Optional[object] = None, account_endpoint: Optional[object] = None, database: Optional[object] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of linked service.Constant filled by server.

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

List of tags that can be used for describing the linked service.

connection_string
object
Required

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

account_endpoint
object
Required

The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).

database
object
Required

The name of the database. Type: string (or Expression with resultType string).

account_key
SecretBase
Required

The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.

encrypted_credential
object
Required

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).