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

Class ODataLinkedService

  • public class ODataLinkedService
extends LinkedService
    Open Data Protocol (OData) linked service.

    • Constructor Detail

      • ODataLinkedService

        public ODataLinkedService()

    • Method Detail

      • getUrl

        public Object getUrl()
        Get the url property: The URL of the OData service endpoint. Type: string (or Expression with resultType string).
        Returns:
        the url value.

      • setUrl

        public ODataLinkedService setUrl​(Object url)
        Set the url property: The URL of the OData service endpoint. Type: string (or Expression with resultType string).
        Parameters:
        url - the url value to set.
        Returns:
        the ODataLinkedService object itself.

      • getAuthenticationType

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

      • setAuthenticationType

        public ODataLinkedService setAuthenticationType​(ODataAuthenticationType authenticationType)
        Set the authenticationType property: Type of authentication used to connect to the OData service.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the ODataLinkedService object itself.

      • getUserName

        public Object getUserName()
        Get the userName property: User name of the OData service. Type: string (or Expression with resultType string).
        Returns:
        the userName value.

      • setUserName

        public ODataLinkedService setUserName​(Object userName)
        Set the userName property: User name of the OData service. Type: string (or Expression with resultType string).
        Parameters:
        userName - the userName value to set.
        Returns:
        the ODataLinkedService object itself.

      • getPassword

        public SecretBase getPassword()
        Get the password property: Password of the OData service.
        Returns:
        the password value.

      • setPassword

        public ODataLinkedService setPassword​(SecretBase password)
        Set the password property: Password of the OData service.
        Parameters:
        password - the password value to set.
        Returns:
        the ODataLinkedService object itself.

      • getTenant

        public Object getTenant()
        Get the tenant property: Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
        Returns:
        the tenant value.

      • setTenant

        public ODataLinkedService setTenant​(Object tenant)
        Set the tenant property: Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
        Parameters:
        tenant - the tenant value to set.
        Returns:
        the ODataLinkedService object itself.

      • getServicePrincipalId

        public Object getServicePrincipalId()
        Get the servicePrincipalId property: Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.

      • setServicePrincipalId

        public ODataLinkedService setServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the ODataLinkedService 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 ODataLinkedService 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 ODataLinkedService object itself.

      • getAadResourceId

        public Object getAadResourceId()
        Get the aadResourceId property: Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
        Returns:
        the aadResourceId value.

      • setAadResourceId

        public ODataLinkedService setAadResourceId​(Object aadResourceId)
        Set the aadResourceId property: Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
        Parameters:
        aadResourceId - the aadResourceId value to set.
        Returns:
        the ODataLinkedService object itself.

      • getAadServicePrincipalCredentialType

        public ODataAadServicePrincipalCredentialType getAadServicePrincipalCredentialType()
        Get the aadServicePrincipalCredentialType property: Specify the credential type (key or cert) is used for service principal.
        Returns:
        the aadServicePrincipalCredentialType value.

      • setAadServicePrincipalCredentialType

        public ODataLinkedService setAadServicePrincipalCredentialType​(ODataAadServicePrincipalCredentialType aadServicePrincipalCredentialType)
        Set the aadServicePrincipalCredentialType property: Specify the credential type (key or cert) is used for service principal.
        Parameters:
        aadServicePrincipalCredentialType - the aadServicePrincipalCredentialType value to set.
        Returns:
        the ODataLinkedService object itself.

      • getServicePrincipalKey

        public SecretBase getServicePrincipalKey()
        Get the servicePrincipalKey property: Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalKey value.

      • setServicePrincipalKey

        public ODataLinkedService setServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the ODataLinkedService object itself.

      • getServicePrincipalEmbeddedCert

        public SecretBase getServicePrincipalEmbeddedCert()
        Get the servicePrincipalEmbeddedCert property: Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalEmbeddedCert value.

      • setServicePrincipalEmbeddedCert

        public ODataLinkedService setServicePrincipalEmbeddedCert​(SecretBase servicePrincipalEmbeddedCert)
        Set the servicePrincipalEmbeddedCert property: Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalEmbeddedCert - the servicePrincipalEmbeddedCert value to set.
        Returns:
        the ODataLinkedService object itself.

      • getServicePrincipalEmbeddedCertPassword

        public SecretBase getServicePrincipalEmbeddedCertPassword()
        Get the servicePrincipalEmbeddedCertPassword property: 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).
        Returns:
        the servicePrincipalEmbeddedCertPassword value.

      • setServicePrincipalEmbeddedCertPassword

        public ODataLinkedService setServicePrincipalEmbeddedCertPassword​(SecretBase servicePrincipalEmbeddedCertPassword)
        Set the servicePrincipalEmbeddedCertPassword property: 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).
        Parameters:
        servicePrincipalEmbeddedCertPassword - the servicePrincipalEmbeddedCertPassword value to set.
        Returns:
        the ODataLinkedService 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 ODataLinkedService 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 ODataLinkedService object itself.

      • setDescription

        public ODataLinkedService 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.

      • setAnnotations

        public ODataLinkedService 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.