Share via


CommonDataServiceForAppsLinkedService Class

Definition

Common Data Service for Apps linked service.

public class CommonDataServiceForAppsLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CommonDataServiceForAppsLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CommonDataServiceForAppsLinkedService>
public class CommonDataServiceForAppsLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties
type CommonDataServiceForAppsLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<CommonDataServiceForAppsLinkedService>
    interface IPersistableModel<CommonDataServiceForAppsLinkedService>
type CommonDataServiceForAppsLinkedService = class
    inherit DataFactoryLinkedServiceProperties
Public Class CommonDataServiceForAppsLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of CommonDataServiceForAppsLinkedService), IPersistableModel(Of CommonDataServiceForAppsLinkedService)
Public Class CommonDataServiceForAppsLinkedService
Inherits DataFactoryLinkedServiceProperties
Inheritance
CommonDataServiceForAppsLinkedService
Implements

Constructors

CommonDataServiceForAppsLinkedService(DataFactoryElement<String>, DataFactoryElement<String>)

Initializes a new instance of CommonDataServiceForAppsLinkedService.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
AuthenticationType

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

ConnectVia

The integration runtime reference.

(Inherited from DataFactoryLinkedServiceProperties)
DeploymentType

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

Description

Linked service description.

(Inherited from DataFactoryLinkedServiceProperties)
Domain

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

EncryptedCredential

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

HostName

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

LinkedServiceVersion

Version of the linked service.

(Inherited from DataFactoryLinkedServiceProperties)
OrganizationName

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

Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

Password to access the Common Data Service for Apps instance.

Port

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.

ServicePrincipalCredential

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.

ServicePrincipalCredentialType

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

ServicePrincipalId

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

ServiceUri

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

Username

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryLinkedServiceProperties)

Explicit Interface Implementations

IJsonModel<CommonDataServiceForAppsLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CommonDataServiceForAppsLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<CommonDataServiceForAppsLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CommonDataServiceForAppsLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CommonDataServiceForAppsLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryLinkedServiceProperties)

Applies to