Class CosmosDbMongoDbApiLinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService
Linked service for CosmosDB (MongoDB API) data source.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the connectionString property: The CosmosDB (MongoDB API) connection string.Get the database property: The name of the CosmosDB (MongoDB API) database that you want to access.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.setConnectionString
(Object connectionString) Set the connectionString property: The CosmosDB (MongoDB API) connection string.setConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.setDatabase
(Object database) Set the database property: The name of the CosmosDB (MongoDB API) database that you want to access.setDescription
(String description) Set the description property: Linked service description.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
CosmosDbMongoDbApiLinkedService
public CosmosDbMongoDbApiLinkedService()
-
-
Method Details
-
getConnectionString
Get the connectionString property: The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.- Returns:
- the connectionString value.
-
setConnectionString
Set the connectionString property: The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.- Parameters:
connectionString
- the connectionString value to set.- Returns:
- the CosmosDbMongoDbApiLinkedService object itself.
-
getDatabase
Get the database property: The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).- Returns:
- the database value.
-
setDatabase
Set the database property: The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).- Parameters:
database
- the database value to set.- Returns:
- the CosmosDbMongoDbApiLinkedService object itself.
-
setConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
setConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
setDescription
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
Set the parameters property: Parameters for linked service.- Overrides:
setParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
setAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-