Share via


RestServiceLinkedService Class

Definition

Rest Service linked service.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("RestService")]
public class RestServiceLinkedService : Microsoft.Azure.Management.DataFactory.Models.LinkedService
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("RestService")>]
type RestServiceLinkedService = class
    inherit LinkedService
Public Class RestServiceLinkedService
Inherits LinkedService
Inheritance
RestServiceLinkedService
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

RestServiceLinkedService()

Initializes a new instance of the RestServiceLinkedService class.

RestServiceLinkedService(Object, String, IDictionary<String,Object>, IntegrationRuntimeReference, String, IDictionary<String,ParameterSpecification>, IList<Object>, Object, Object, SecretBase, Object, Object, SecretBase, Object, Object, Object, Object, CredentialReference, Object, SecretBase, Object, Object, Object)

Initializes a new instance of the RestServiceLinkedService class.

Properties

AadResourceId

Gets or sets the resource you are requesting authorization to use.

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from LinkedService)
Annotations

Gets or sets list of tags that can be used for describing the linked service.

(Inherited from LinkedService)
AuthenticationType

Gets or sets type of authentication used to connect to the REST service. Possible values include: 'Anonymous', 'Basic', 'AadServicePrincipal', 'ManagedServiceIdentity', 'OAuth2ClientCredential'

AuthHeaders

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

AzureCloudType

Gets or sets 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).

ClientId

Gets or sets the client ID associated with your application. Type: string (or Expression with resultType string).

ClientSecret

Gets or sets the client secret associated with your application.

ConnectVia

Gets or sets the integration runtime reference.

(Inherited from LinkedService)
Credential

Gets or sets the credential reference containing authentication information.

Description

Gets or sets linked service description.

(Inherited from LinkedService)
EnableServerCertificateValidation

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

EncryptedCredential

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

Parameters

Gets or sets parameters for linked service.

(Inherited from LinkedService)
Password

Gets or sets the password used in Basic authentication type.

Resource

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

Scope

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

ServicePrincipalId

Gets or sets the application's client ID used in AadServicePrincipal authentication type.

ServicePrincipalKey

Gets or sets the application's key used in AadServicePrincipal authentication type.

Tenant

Gets or sets the tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.

TokenEndpoint

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

Url

Gets or sets the base URL of the REST service.

UserName

Gets or sets the user name used in Basic authentication type.

Methods

Validate()

Validate the object.

Applies to