CommonDataServiceForAppsLinkedService Class

Common Data Service for Apps linked service.

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

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

CommonDataServiceForAppsLinkedService

Constructor

CommonDataServiceForAppsLinkedService(*, deployment_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsDeploymentType], authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsAuthenticationType], 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, host_name: Optional[object] = None, port: Optional[object] = None, service_uri: Optional[object] = None, organization_name: Optional[object] = None, username: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[object] = None, service_principal_credential_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsServicePrincipalCredentialType]] = None, service_principal_credential: 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.

deployment_type

str or DynamicsDeploymentType

Required

Required. The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string). Possible values include: "Online", "OnPremisesWithIfd".

host_name

object

Required

The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

port

object

Required

The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

service_uri

object

Required

The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

organization_name

object

Required

The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).

authentication_type

str or DynamicsAuthenticationType

Required

Required. The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). Possible values include: "Office365", "Ifd", "AADServicePrincipal".

username

object

Required

User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).

password

SecretBase

Required

Password to access the Common Data Service for Apps instance.

service_principal_id

object

Required

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 DynamicsServicePrincipalCredentialType

Required

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".

service_principal_credential

SecretBase

Required

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.

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).