Package com.azure.analytics.synapse.artifacts.models

Class RestServiceLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.RestServiceLinkedService
public class RestServiceLinkedService extends LinkedService
Rest Service linked service.

  • Constructor Details

    • RestServiceLinkedService

      public RestServiceLinkedService()

  • Method Details

    • getUrl

      public Object getUrl()
      Get the url property: The base URL of the REST service.
      Returns:
      the url value.

    • setUrl

      public RestServiceLinkedService setUrl(Object url)
      Set the url property: The base URL of the REST service.
      Parameters:
      url - the url value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getEnableServerCertificateValidation

      public Object getEnableServerCertificateValidation()
      Get the enableServerCertificateValidation property: Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
      Returns:
      the enableServerCertificateValidation value.

    • setEnableServerCertificateValidation

      public RestServiceLinkedService setEnableServerCertificateValidation(Object enableServerCertificateValidation)
      Set the enableServerCertificateValidation property: Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
      Parameters:
      enableServerCertificateValidation - the enableServerCertificateValidation value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getAuthenticationType

      public RestServiceAuthenticationType getAuthenticationType()
      Get the authenticationType property: Type of authentication used to connect to the REST service.
      Returns:
      the authenticationType value.

    • setAuthenticationType

      public RestServiceLinkedService setAuthenticationType(RestServiceAuthenticationType authenticationType)
      Set the authenticationType property: Type of authentication used to connect to the REST service.
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getUserName

      public Object getUserName()
      Get the userName property: The user name used in Basic authentication type.
      Returns:
      the userName value.

    • setUserName

      public RestServiceLinkedService setUserName(Object userName)
      Set the userName property: The user name used in Basic authentication type.
      Parameters:
      userName - the userName value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getPassword

      public SecretBase getPassword()
      Get the password property: The password used in Basic authentication type.
      Returns:
      the password value.

    • setPassword

      public RestServiceLinkedService setPassword(SecretBase password)
      Set the password property: The password used in Basic authentication type.
      Parameters:
      password - the password value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getServicePrincipalId

      public Object getServicePrincipalId()
      Get the servicePrincipalId property: The application's client ID used in AadServicePrincipal authentication type.
      Returns:
      the servicePrincipalId value.

    • setServicePrincipalId

      public RestServiceLinkedService setServicePrincipalId(Object servicePrincipalId)
      Set the servicePrincipalId property: The application's client ID used in AadServicePrincipal authentication type.
      Parameters:
      servicePrincipalId - the servicePrincipalId value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getServicePrincipalKey

      public SecretBase getServicePrincipalKey()
      Get the servicePrincipalKey property: The application's key used in AadServicePrincipal authentication type.
      Returns:
      the servicePrincipalKey value.

    • setServicePrincipalKey

      public RestServiceLinkedService setServicePrincipalKey(SecretBase servicePrincipalKey)
      Set the servicePrincipalKey property: The application's key used in AadServicePrincipal authentication type.
      Parameters:
      servicePrincipalKey - the servicePrincipalKey value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getTenant

      public Object getTenant()
      Get the tenant property: The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.
      Returns:
      the tenant value.

    • setTenant

      public RestServiceLinkedService setTenant(Object tenant)
      Set the tenant property: The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.
      Parameters:
      tenant - the tenant value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getAzureCloudType

      public Object getAzureCloudType()
      Get the azureCloudType property: 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).
      Returns:
      the azureCloudType value.

    • setAzureCloudType

      public RestServiceLinkedService setAzureCloudType(Object azureCloudType)
      Set the azureCloudType property: 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).
      Parameters:
      azureCloudType - the azureCloudType value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getAadResourceId

      public Object getAadResourceId()
      Get the aadResourceId property: The resource you are requesting authorization to use.
      Returns:
      the aadResourceId value.

    • setAadResourceId

      public RestServiceLinkedService setAadResourceId(Object aadResourceId)
      Set the aadResourceId property: The resource you are requesting authorization to use.
      Parameters:
      aadResourceId - the aadResourceId value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getEncryptedCredential

      public Object 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

      public RestServiceLinkedService setEncryptedCredential(Object encryptedCredential)
      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 RestServiceLinkedService object itself.

    • getClientId

      public Object getClientId()
      Get the clientId property: The client ID associated with your application. Type: string (or Expression with resultType string).
      Returns:
      the clientId value.

    • setClientId

      public RestServiceLinkedService setClientId(Object clientId)
      Set the clientId property: The client ID associated with your application. Type: string (or Expression with resultType string).
      Parameters:
      clientId - the clientId value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getClientSecret

      public SecretBase getClientSecret()
      Get the clientSecret property: The client secret associated with your application.
      Returns:
      the clientSecret value.

    • setClientSecret

      public RestServiceLinkedService setClientSecret(SecretBase clientSecret)
      Set the clientSecret property: The client secret associated with your application.
      Parameters:
      clientSecret - the clientSecret value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getTokenEndpoint

      public Object getTokenEndpoint()
      Get the tokenEndpoint property: The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
      Returns:
      the tokenEndpoint value.

    • setTokenEndpoint

      public RestServiceLinkedService setTokenEndpoint(Object tokenEndpoint)
      Set the tokenEndpoint property: The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
      Parameters:
      tokenEndpoint - the tokenEndpoint value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getResource

      public Object getResource()
      Get the resource property: The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
      Returns:
      the resource value.

    • setResource

      public RestServiceLinkedService setResource(Object resource)
      Set the resource property: The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
      Parameters:
      resource - the resource value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • getScope

      public Object getScope()
      Get the scope property: The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
      Returns:
      the scope value.

    • setScope

      public RestServiceLinkedService setScope(Object scope)
      Set the scope property: The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
      Parameters:
      scope - the scope value to set.
      Returns:
      the RestServiceLinkedService object itself.

    • setConnectVia

      public RestServiceLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
      Set the connectVia property: The integration runtime reference.
      Overrides:
      setConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.

    • setDescription

      public RestServiceLinkedService setDescription(String description)
      Set the description property: Linked service description.
      Overrides:
      setDescription in class LinkedService
      Parameters:
      description - the description value to set.
      Returns:
      the LinkedService object itself.

    • setParameters

      public RestServiceLinkedService setParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for linked service.
      Overrides:
      setParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.

    • setAnnotations

      public RestServiceLinkedService setAnnotations(List<Object> annotations)
      Set the annotations property: List of tags that can be used for describing the linked service.
      Overrides:
      setAnnotations in class LinkedService
      Parameters:
      annotations - the annotations value to set.
      Returns:
      the LinkedService object itself.