CommonDataServiceForAppsLinkedService Class
Common Data Service for Apps linked service.
All required parameters must be populated in order to send to server.
Constructor
CommonDataServiceForAppsLinkedService(*, deployment_type: MutableMapping[str, Any], authentication_type: MutableMapping[str, Any], 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, host_name: MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None = None, service_uri: MutableMapping[str, Any] | None = None, organization_name: MutableMapping[str, Any] | None = None, ___domain: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, password: _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, encrypted_credential: str | 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
|
|
deployment_type
|
<xref:JSON>
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). Required. |
|
host_name
|
<xref:JSON>
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). Default value: None
|
|
port
|
<xref:JSON>
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. Default value: None
|
|
service_uri
|
<xref:JSON>
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). Default value: None
|
|
organization_name
|
<xref:JSON>
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). Default value: None
|
|
authentication_type
|
<xref:JSON>
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, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). Required. |
|
___domain
|
<xref:JSON>
The Active Directory ___domain that will verify user credentials. Type: string (or Expression with resultType string). Default value: None
|
|
username
|
<xref:JSON>
User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). Default value: None
|
|
password
|
Password to access the Common Data Service for Apps instance. 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 (or Expression with resultType 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
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. 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. |
|
deployment_type
|
<xref:JSON>
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). Required. |
|
host_name
|
<xref:JSON>
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
|
<xref:JSON>
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
|
<xref:JSON>
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
|
<xref:JSON>
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
|
<xref:JSON>
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, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). Required. |
|
___domain
|
<xref:JSON>
The Active Directory ___domain that will verify user credentials. Type: string (or Expression with resultType string). |
|
username
|
<xref:JSON>
User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). |
|
password
|
Password to access the Common Data Service for Apps instance. |
|
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 (or Expression with resultType 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. |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
