Class HttpLinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.HttpLinkedService
Linked service for an HTTP source.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the authenticationType property: The authentication type to be used to connect to the HTTP server.Get the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication.Get the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication.Get the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate.Get the encryptedCredential property: The encrypted credential used for authentication.Get the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.getUrl()
Get the url property: The base URL of the HTTP endpoint, e.g.Get the userName property: User name for Basic, Digest, or Windows authentication.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.setAuthenticationType
(HttpAuthenticationType authenticationType) Set the authenticationType property: The authentication type to be used to connect to the HTTP server.setCertThumbprint
(Object certThumbprint) Set the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication.setConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.setDescription
(String description) Set the description property: Linked service description.setEmbeddedCertData
(Object embeddedCertData) Set the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication.setEnableServerCertificateValidation
(Object enableServerCertificateValidation) Set the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate.setEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.setPassword
(SecretBase password) Set the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.Set the url property: The base URL of the HTTP endpoint, e.g.setUserName
(Object userName) Set the userName property: User name for Basic, Digest, or Windows authentication.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
HttpLinkedService
public HttpLinkedService()Creates an instance of HttpLinkedService class.
-
-
Method Details
-
getUrl
Get the url property: The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).- Returns:
- the url value.
-
setUrl
Set the url property: The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).- Parameters:
url
- the url value to set.- Returns:
- the HttpLinkedService object itself.
-
getAuthenticationType
Get the authenticationType property: The authentication type to be used to connect to the HTTP server.- Returns:
- the authenticationType value.
-
setAuthenticationType
Set the authenticationType property: The authentication type to be used to connect to the HTTP server.- Parameters:
authenticationType
- the authenticationType value to set.- Returns:
- the HttpLinkedService object itself.
-
getUserName
Get the userName property: User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).- Returns:
- the userName value.
-
setUserName
Set the userName property: User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).- Parameters:
userName
- the userName value to set.- Returns:
- the HttpLinkedService object itself.
-
getPassword
Get the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.- Returns:
- the password value.
-
setPassword
Set the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.- Parameters:
password
- the password value to set.- Returns:
- the HttpLinkedService object itself.
-
getEmbeddedCertData
Get the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).- Returns:
- the embeddedCertData value.
-
setEmbeddedCertData
Set the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).- Parameters:
embeddedCertData
- the embeddedCertData value to set.- Returns:
- the HttpLinkedService object itself.
-
getCertThumbprint
Get the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).- Returns:
- the certThumbprint value.
-
setCertThumbprint
Set the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).- Parameters:
certThumbprint
- the certThumbprint value to set.- Returns:
- the HttpLinkedService object itself.
-
getEncryptedCredential
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).- Returns:
- the encryptedCredential value.
-
setEncryptedCredential
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).- Parameters:
encryptedCredential
- the encryptedCredential value to set.- Returns:
- the HttpLinkedService object itself.
-
getEnableServerCertificateValidation
Get the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).- Returns:
- the enableServerCertificateValidation value.
-
setEnableServerCertificateValidation
public HttpLinkedService setEnableServerCertificateValidation(Object enableServerCertificateValidation) Set the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).- Parameters:
enableServerCertificateValidation
- the enableServerCertificateValidation value to set.- Returns:
- the HttpLinkedService object itself.
-
setConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
setConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
setDescription
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
Set the parameters property: Parameters for linked service.- Overrides:
setParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
setAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-