QuickBooksLinkedService interface

Package:

@azure/synapse-artifacts

QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

Extends

LinkedService

Properties

accessToken	The access token for OAuth 2.0 authentication.
accessTokenSecret	The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0.
companyId	The company ID of the QuickBooks company to authorize.
connectionProperties	Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.
consumerKey	The consumer key for OAuth 2.0 authentication.
consumerSecret	The consumer secret for OAuth 2.0 authentication.
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
endpoint	The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)
refreshToken	The refresh token for OAuth 2.0 authentication.
type	Polymorphic discriminator, which specifies the different types this object can be
useEncryptedEndpoints	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Inherited Properties

annotations	List of tags that can be used for describing the linked service.
connectVia	The integration runtime reference.
description	Linked service description.
parameters	Parameters for linked service.
version	Version of the linked service.

Property Details

accessToken

The access token for OAuth 2.0 authentication.

accessToken?: SecretBaseUnion

Property Value

SecretBaseUnion

accessTokenSecret

The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0.

accessTokenSecret?: SecretBaseUnion

Property Value

SecretBaseUnion

companyId

The company ID of the QuickBooks company to authorize.

companyId: any

Property Value

any

connectionProperties

Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.

connectionProperties?: any

Property Value

any

consumerKey

The consumer key for OAuth 2.0 authentication.

consumerKey: any

Property Value

any

consumerSecret

The consumer secret for OAuth 2.0 authentication.

consumerSecret: SecretBaseUnion

Property Value

SecretBaseUnion

encryptedCredential

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

encryptedCredential?: any

Property Value

any

endpoint

The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)

endpoint: any

Property Value

any

refreshToken

The refresh token for OAuth 2.0 authentication.

refreshToken?: SecretBaseUnion

Property Value

SecretBaseUnion

type

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

type: "QuickBooks"

Property Value

"QuickBooks"

useEncryptedEndpoints

Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

useEncryptedEndpoints?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

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

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version