CosmosDbLinkedService Class
Microsoft Azure Cosmos Database (CosmosDB) linked service.
All required parameters must be populated in order to send to server.
Constructor
CosmosDbLinkedService(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, connection_string: MutableMapping[str, Any] | None = None, account_endpoint: MutableMapping[str, Any] | None = None, database: MutableMapping[str, Any] | None = None, account_key: _models.SecretBase | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_credential_type: MutableMapping[str, Any] | None = None, service_principal_credential: _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None, azure_cloud_type: MutableMapping[str, Any] | None = None, connection_mode: str | _models.CosmosDbConnectionMode | None = None, encrypted_credential: str | None = None, credential: _models.CredentialReference | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
version
|
Version of the linked service. Default value: None
|
|
connect_via
|
The integration runtime reference. Default value: None
|
|
description
|
Linked service description. Default value: None
|
|
parameters
|
Parameters for linked service. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. Default value: None
|
|
connection_string
|
<xref:JSON>
The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Default value: None
|
|
account_endpoint
|
<xref:JSON>
The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string). Default value: None
|
|
database
|
<xref:JSON>
The name of the database. Type: string (or Expression with resultType string). Default value: None
|
|
account_key
|
The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. Default value: None
|
|
service_principal_id
|
<xref:JSON>
The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_credential_type
|
<xref:JSON>
The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. Default value: None
|
|
service_principal_credential
|
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. Default value: None
|
|
tenant
|
<xref:JSON>
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). Default value: None
|
|
azure_cloud_type
|
<xref:JSON>
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). Default value: None
|
|
connection_mode
|
The connection mode used to access CosmosDB account. Type: string. Known values are: "Gateway" and "Direct". Default value: None
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
|
credential
|
The credential reference containing authentication information. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
connection_string
|
<xref:JSON>
The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. |
|
account_endpoint
|
<xref:JSON>
The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string). |
|
database
|
<xref:JSON>
The name of the database. Type: string (or Expression with resultType string). |
|
account_key
|
The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. |
|
service_principal_id
|
<xref:JSON>
The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). |
|
service_principal_credential_type
|
<xref:JSON>
The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. |
|
service_principal_credential
|
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. |
|
tenant
|
<xref:JSON>
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). |
|
azure_cloud_type
|
<xref:JSON>
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). |
|
connection_mode
|
The connection mode used to access CosmosDB account. Type: string. Known values are: "Gateway" and "Direct". |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
|
credential
|
The credential reference containing authentication information. |
