Package com.azure.resourcemanager.datafactory.models

Class ODataLinkedService

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

    • Constructor Detail

      • ODataLinkedService

        public ODataLinkedService()

    • Method Detail

      • withDescription

        public ODataLinkedService 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 ODataLinkedService 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 URL of the OData service endpoint. Type: string (or Expression with resultType string).
        Returns:
        the url value.

      • withUrl

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

      • authenticationType

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

      • withAuthenticationType

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

      • username

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

      • withUsername

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

      • password

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

      • withPassword

        public ODataLinkedService withPassword​(SecretBase password)
        Set the password property: Password of the OData service.
        Parameters:
        password - the password value to set.
        Returns:
        the ODataLinkedService 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 ODataLinkedService 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 ODataLinkedService object itself.

      • tenant

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

      • withTenant

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

      • servicePrincipalId

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

      • withServicePrincipalId

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

      • 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 ODataLinkedService 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 ODataLinkedService object itself.

      • aadResourceId

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

      • withAadResourceId

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

      • aadServicePrincipalCredentialType

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

      • withAadServicePrincipalCredentialType

        public ODataLinkedService withAadServicePrincipalCredentialType​(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.

      • servicePrincipalKey

        public SecretBase servicePrincipalKey()
        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.

      • withServicePrincipalKey

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

      • servicePrincipalEmbeddedCert

        public SecretBase servicePrincipalEmbeddedCert()
        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.

      • withServicePrincipalEmbeddedCert

        public ODataLinkedService withServicePrincipalEmbeddedCert​(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.

      • servicePrincipalEmbeddedCertPassword

        public SecretBase servicePrincipalEmbeddedCertPassword()
        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.

      • withServicePrincipalEmbeddedCertPassword

        public ODataLinkedService withServicePrincipalEmbeddedCertPassword​(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.

      • 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 ODataLinkedService 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 ODataLinkedService object itself.