Package version:

Interface CommonDataServiceForAppsLinkedService

Common Data Service for Apps linked service.

interface CommonDataServiceForAppsLinkedService {
    annotations?: any[];
    authenticationType: any;
    connectVia?: IntegrationRuntimeReference;
    deploymentType: any;
    description?: string;
    domain?: any;
    encryptedCredential?: string;
    hostName?: any;
    organizationName?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    password?: SecretBaseUnion;
    port?: any;
    servicePrincipalCredential?: SecretBaseUnion;
    servicePrincipalCredentialType?: any;
    servicePrincipalId?: any;
    serviceUri?: any;
    type: "CommonDataServiceForApps";
    username?: any;
    version?: string;
}

Hierarchy (view full)

Properties

annotations? authenticationType connectVia? deploymentType description? domain? encryptedCredential? hostName? organizationName? parameters? password? port? servicePrincipalCredential? servicePrincipalCredentialType? servicePrincipalId? serviceUri? type username? version?

Properties

Optionalannotations

annotations?: any[]

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

authenticationType

authenticationType: any

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

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

deploymentType

deploymentType: any

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

Optionaldescription

description?: string

Linked service description.

Optionaldomain

domain?: any

The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string).

OptionalencryptedCredential

encryptedCredential?: string

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

OptionalhostName

hostName?: any

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

OptionalorganizationName

organizationName?: any

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

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for linked service.

Optionalpassword

password?: SecretBaseUnion

Password to access the Common Data Service for Apps instance.

Optionalport

port?: any

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.

OptionalservicePrincipalCredential

servicePrincipalCredential?: SecretBaseUnion

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.

OptionalservicePrincipalCredentialType

servicePrincipalCredentialType?: any

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

OptionalservicePrincipalId

servicePrincipalId?: any

The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

OptionalserviceUri

serviceUri?: any

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

type

type

Polymorphic discriminator, which specifies the different types this object can be

Optionalusername

username?: any

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

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility