Package version:

Interface CommonDataServiceForAppsLinkedService

Common Data Service for Apps linked service.

Hierarchy

Properties

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

Properties

Optional annotations

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. Type: string (or Expression with resultType string).

Optional connectVia

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

Optional description

description?: string

Linked service description.

Optional encryptedCredential

encryptedCredential?: any

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

Optional hostName

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

Optional organizationName

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

Optional parameters

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

Parameters for linked service.

Type declaration

Optional password

password?: SecretBaseUnion

Password to access the Common Data Service for Apps instance.

Optional port

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.

Optional servicePrincipalCredential

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.

Optional servicePrincipalCredentialType

servicePrincipalCredentialType?: any

A string from ServicePrincipalCredentialEnum or an expression

Optional servicePrincipalId

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

Optional serviceUri

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: "CommonDataServiceForApps"

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

Optional username

username?: any

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

Settings

Member Visibility

Theme

Generated using TypeDoc