Class RestServiceLinkedService

Rest Service linked service.

Inheritance
System.Object
LinkedService
RestServiceLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestServiceLinkedService/RestServiceLinkedServiceConverter))]
public class RestServiceLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

RestServiceLinkedService(Object, RestServiceAuthenticationType)

Initializes a new instance of RestServiceLinkedService.

Declaration
public RestServiceLinkedService (object url, Azure.Analytics.Synapse.Artifacts.Models.RestServiceAuthenticationType authenticationType);
Parameters
System.Object url

The base URL of the REST service.
RestServiceAuthenticationType authenticationType

Type of authentication used to connect to the REST service.
Exceptions
System.ArgumentNullException

url is null.

Properties

AadResourceId

The resource you are requesting authorization to use.

Declaration
public object AadResourceId { get; set; }
Property Value
System.Object

AuthenticationType

Type of authentication used to connect to the REST service.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.RestServiceAuthenticationType AuthenticationType { get; set; }
Property Value
RestServiceAuthenticationType

AuthHeaders

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

Declaration
public object AuthHeaders { get; set; }
Property Value
System.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).

Declaration
public object AzureCloudType { get; set; }
Property Value
System.Object

ClientId

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

Declaration
public object ClientId { get; set; }
Property Value
System.Object

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.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ClientSecret { get; set; }
Property Value
SecretBase

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

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

Declaration
public object EnableServerCertificateValidation { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

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.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

Resource

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

Declaration
public object Resource { get; set; }
Property Value
System.Object

Scope

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

Declaration
public object Scope { get; set; }
Property Value
System.Object

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

Declaration
public object ServicePrincipalCredentialType { get; set; }
Property Value
System.Object

ServicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). 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.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCert { get; set; }
Property Value
SecretBase

ServicePrincipalEmbeddedCertPassword

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

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCertPassword { get; set; }
Property Value
SecretBase

ServicePrincipalId

The application's client ID used in AadServicePrincipal authentication type.

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

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.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }
Property Value
SecretBase

Tenant

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

Declaration
public object Tenant { get; set; }
Property Value
System.Object

TokenEndpoint

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

Declaration
public object TokenEndpoint { get; set; }
Property Value
System.Object

Url

The base URL of the REST service.

Declaration
public object Url { get; set; }
Property Value
System.Object

UserName

The user name used in Basic authentication type.

Declaration
public object UserName { get; set; }
Property Value
System.Object