Package com.azure.resourcemanager.datafactory.models

Class RestServiceLinkedService

  • public final class RestServiceLinkedService
extends LinkedService
    Rest Service linked service.

    • Constructor Detail

      • RestServiceLinkedService

        public RestServiceLinkedService()

    • Method Detail

      • withDescription

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

      • withAnnotations

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

      • url

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

      • withUrl

        public RestServiceLinkedService withUrl​(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.

      • enableServerCertificateValidation

        public Object enableServerCertificateValidation()
        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.

      • withEnableServerCertificateValidation

        public RestServiceLinkedService withEnableServerCertificateValidation​(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.

      • authenticationType

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

      • withAuthenticationType

        public RestServiceLinkedService withAuthenticationType​(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.

      • username

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

      • withUsername

        public RestServiceLinkedService withUsername​(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.

      • password

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

      • withPassword

        public RestServiceLinkedService withPassword​(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.

      • authHeaders

        public Object authHeaders()
        Get the authHeaders property: The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
        Returns:
        the authHeaders value.

      • withAuthHeaders

        public RestServiceLinkedService withAuthHeaders​(Object authHeaders)
        Set the authHeaders property: The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
        Parameters:
        authHeaders - the authHeaders value to set.
        Returns:
        the RestServiceLinkedService object itself.

      • servicePrincipalId

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

      • withServicePrincipalId

        public RestServiceLinkedService withServicePrincipalId​(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.

      • servicePrincipalKey

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

      • withServicePrincipalKey

        public RestServiceLinkedService withServicePrincipalKey​(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.

      • tenant

        public Object tenant()
        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.

      • withTenant

        public RestServiceLinkedService withTenant​(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.

      • azureCloudType

        public Object azureCloudType()
        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.

      • withAzureCloudType

        public RestServiceLinkedService withAzureCloudType​(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.

      • aadResourceId

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

      • withAadResourceId

        public RestServiceLinkedService withAadResourceId​(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.

      • encryptedCredential

        public Object encryptedCredential()
        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.

      • withEncryptedCredential

        public RestServiceLinkedService withEncryptedCredential​(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.

      • credential

        public CredentialReference credential()
        Get the credential property: The credential reference containing authentication information.
        Returns:
        the credential value.

      • withCredential

        public RestServiceLinkedService withCredential​(CredentialReference credential)
        Set the credential property: The credential reference containing authentication information.
        Parameters:
        credential - the credential value to set.
        Returns:
        the RestServiceLinkedService object itself.