Package version:

Interface RestServiceLinkedService

Rest Service linked service.

interface RestServiceLinkedService {
    aadResourceId?: any;
    annotations?: any[];
    authenticationType: string;
    authHeaders?: any;
    azureCloudType?: any;
    clientId?: any;
    clientSecret?: SecretBaseUnion;
    connectVia?: IntegrationRuntimeReference;
    credential?: CredentialReference;
    description?: string;
    enableServerCertificateValidation?: any;
    encryptedCredential?: string;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    password?: SecretBaseUnion;
    resource?: any;
    scope?: any;
    servicePrincipalCredentialType?: any;
    servicePrincipalEmbeddedCert?: SecretBaseUnion;
    servicePrincipalEmbeddedCertPassword?: SecretBaseUnion;
    servicePrincipalId?: any;
    servicePrincipalKey?: SecretBaseUnion;
    tenant?: any;
    tokenEndpoint?: any;
    type: "RestService";
    url: any;
    userName?: any;
    version?: string;
}

Hierarchy (view full)

Properties

aadResourceId? annotations? authenticationType authHeaders? azureCloudType? clientId? clientSecret? connectVia? credential? description? enableServerCertificateValidation? encryptedCredential? parameters? password? resource? scope? servicePrincipalCredentialType? servicePrincipalEmbeddedCert? servicePrincipalEmbeddedCertPassword? servicePrincipalId? servicePrincipalKey? tenant? tokenEndpoint? type url userName? version?

Properties

OptionalaadResourceId

aadResourceId?: any

The resource you are requesting authorization to use. Type: string (or Expression with resultType string).

Optionalannotations

annotations?: any[]

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

authenticationType

authenticationType: string

Type of authentication used to connect to the REST service.

OptionalauthHeaders

authHeaders?: any

The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).

OptionalazureCloudType

azureCloudType?: any

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

OptionalclientId

clientId?: any

The client ID associated with your application. Type: string (or Expression with resultType string).

OptionalclientSecret

clientSecret?: SecretBaseUnion

The client secret associated with your application.

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionalcredential

credential?: CredentialReference

The credential reference containing authentication information.

Optionaldescription

description?: string

Linked service description.

OptionalenableServerCertificateValidation

enableServerCertificateValidation?: any

Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).

OptionalencryptedCredential

encryptedCredential?: string

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

Optionalparameters

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

Parameters for linked service.

Optionalpassword

password?: SecretBaseUnion

The password used in Basic authentication type.

Optionalresource

resource?: any

The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).

Optionalscope

scope?: any

The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).

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

OptionalservicePrincipalEmbeddedCert

servicePrincipalEmbeddedCert?: SecretBaseUnion

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

OptionalservicePrincipalEmbeddedCertPassword

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

OptionalservicePrincipalId

servicePrincipalId?: any

The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).

OptionalservicePrincipalKey

servicePrincipalKey?: SecretBaseUnion

The application's key used in AadServicePrincipal authentication type.

Optionaltenant

tenant?: any

The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).

OptionaltokenEndpoint

tokenEndpoint?: any

The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).

type

type

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

url

url: any

The base URL of the REST service. Type: string (or Expression with resultType string).

OptionaluserName

userName?: any

The user name used in Basic authentication type. Type: string (or Expression with resultType string).

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility