CosmosDbLinkedService Class

Microsoft Azure Cosmos Database (CosmosDB) linked service.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

CosmosDbLinkedService

Constructor

CosmosDbLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[_models.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, account_endpoint: Optional[Any] = None, database: Optional[Any] = None, account_key: Optional[_models.SecretBase] = None, service_principal_id: Optional[Any] = None, service_principal_credential_type: Optional[Union[str, _models.CosmosDbServicePrincipalCredentialType]] = None, service_principal_credential: Optional[_models.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, connection_mode: Optional[Union[str, _models.CosmosDbConnectionMode]] = None, encrypted_credential: Optional[Any] = None, credential: Optional[_models.CredentialReference] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

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

connect_via

IntegrationRuntimeReference

The integration runtime reference.

description

str

Linked service description.

parameters

dict[str, ParameterSpecification]

Parameters for linked service.

annotations

list[any]

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

connection_string

any

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

account_endpoint

any

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

database

any

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

account_key

SecretBase

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

service_principal_id

any

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

str or CosmosDbServicePrincipalCredentialType

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). Known values are: "ServicePrincipalKey", "ServicePrincipalCert".

service_principal_credential

SecretBase

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

any

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

azure_cloud_type

any

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

str or CosmosDbConnectionMode

The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string). Known values are: "Gateway", "Direct".

encrypted_credential

any

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

credential

CredentialReference

The credential reference containing authentication information.