RestServiceLinkedService Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

RestServiceLinkedService.cs

Rest Service linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestServiceLinkedService+RestServiceLinkedServiceConverter))]
public class RestServiceLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestServiceLinkedService+RestServiceLinkedServiceConverter))>]
type RestServiceLinkedService = class
    inherit LinkedService

Public Class RestServiceLinkedService
Inherits LinkedService

Inheritance

Object

LinkedService

RestServiceLinkedService

Attributes

JsonConverterAttribute

Constructors

RestServiceLinkedService(Object, RestServiceAuthenticationType)

Initializes a new instance of RestServiceLinkedService.

Properties

AadResourceId	The resource you are requesting authorization to use.
AdditionalProperties	Additional Properties. (Inherited from LinkedService)
Annotations	List of tags that can be used for describing the linked service. (Inherited from LinkedService)
AuthenticationType	Type of authentication used to connect to the REST service.
AuthHeaders	The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
AzureCloudType	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	The client ID associated with your application. Type: string (or Expression with resultType string).
ClientSecret	The client secret associated with your application. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.
ConnectVia	The integration runtime reference. (Inherited from LinkedService)
Credential	The credential reference containing authentication information.
Description	Linked service description. (Inherited from LinkedService)
EnableServerCertificateValidation	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	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Parameters	Parameters for linked service. (Inherited from LinkedService)
Password	The password used in Basic authentication type. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.
Resource	The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
Scope	The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
ServicePrincipalId	The application's client ID used in AadServicePrincipal authentication type.
ServicePrincipalKey	The application's key used in AadServicePrincipal authentication type. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.
Tenant	The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.
TokenEndpoint	The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
Url	The base URL of the REST service.
UserName	The user name used in Basic authentication type.