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

Class AzureMLLinkedService

  • public class AzureMLLinkedService
extends LinkedService
    Azure ML Studio Web Service linked service.

    • Constructor Detail

      • AzureMLLinkedService

        public AzureMLLinkedService()

    • Method Detail

      • getMlEndpoint

        public Object getMlEndpoint()
        Get the mlEndpoint property: The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
        Returns:
        the mlEndpoint value.

      • setMlEndpoint

        public AzureMLLinkedService setMlEndpoint​(Object mlEndpoint)
        Set the mlEndpoint property: The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
        Parameters:
        mlEndpoint - the mlEndpoint value to set.
        Returns:
        the AzureMLLinkedService object itself.

      • getApiKey

        public SecretBase getApiKey()
        Get the apiKey property: The API key for accessing the Azure ML model endpoint.
        Returns:
        the apiKey value.

      • setApiKey

        public AzureMLLinkedService setApiKey​(SecretBase apiKey)
        Set the apiKey property: The API key for accessing the Azure ML model endpoint.
        Parameters:
        apiKey - the apiKey value to set.
        Returns:
        the AzureMLLinkedService object itself.

      • getUpdateResourceEndpoint

        public Object getUpdateResourceEndpoint()
        Get the updateResourceEndpoint property: The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
        Returns:
        the updateResourceEndpoint value.

      • setUpdateResourceEndpoint

        public AzureMLLinkedService setUpdateResourceEndpoint​(Object updateResourceEndpoint)
        Set the updateResourceEndpoint property: The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
        Parameters:
        updateResourceEndpoint - the updateResourceEndpoint value to set.
        Returns:
        the AzureMLLinkedService object itself.

      • getServicePrincipalId

        public Object getServicePrincipalId()
        Get the servicePrincipalId property: The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.

      • setServicePrincipalId

        public AzureMLLinkedService setServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the AzureMLLinkedService object itself.

      • getServicePrincipalKey

        public SecretBase getServicePrincipalKey()
        Get the servicePrincipalKey property: The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.
        Returns:
        the servicePrincipalKey value.

      • setServicePrincipalKey

        public AzureMLLinkedService setServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the AzureMLLinkedService object itself.

      • getTenant

        public Object getTenant()
        Get the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Returns:
        the tenant value.

      • setTenant

        public AzureMLLinkedService setTenant​(Object tenant)
        Set the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Parameters:
        tenant - the tenant value to set.
        Returns:
        the AzureMLLinkedService 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 AzureMLLinkedService 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 AzureMLLinkedService object itself.

      • setDescription

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