AzureFunctionLinkedService Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class AzureFunctionLinkedService
extends LinkedService

Azure Function linked service.

Constructor Summary

Constructor Description
AzureFunctionLinkedService()

Creates an instance of AzureFunctionLinkedService class.

Method Summary

Modifier and Type Method and Description
static AzureFunctionLinkedService fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionLinkedService from the JsonReader.
Object getAuthentication()

Get the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction.
CredentialReference getCredential()

Get the credential property: The credential reference containing authentication information.
Object getEncryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication.
Object getFunctionAppUrl()

Get the functionAppUrl property: The endpoint of the Azure Function App.
SecretBase getFunctionKey()

Get the functionKey property: Function or Host key for Azure Function App.
Object getResourceId()

Get the resourceId property: Allowed token audiences for azure function.
String getType()

Get the type property: Type of linked service.
AzureFunctionLinkedService setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.
AzureFunctionLinkedService setAuthentication(Object authentication)

Set the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction.
AzureFunctionLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.
AzureFunctionLinkedService setCredential(CredentialReference credential)

Set the credential property: The credential reference containing authentication information.
AzureFunctionLinkedService setDescription(String description)

Set the description property: Linked service description.
AzureFunctionLinkedService setEncryptedCredential(Object encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication.
AzureFunctionLinkedService setFunctionAppUrl(Object functionAppUrl)

Set the functionAppUrl property: The endpoint of the Azure Function App.
AzureFunctionLinkedService setFunctionKey(SecretBase functionKey)

Set the functionKey property: Function or Host key for Azure Function App.
AzureFunctionLinkedService setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.
AzureFunctionLinkedService setResourceId(Object resourceId)

Set the resourceId property: Allowed token audiences for azure function.
AzureFunctionLinkedService setVersion(String version)

Set the version property: Version of the linked service.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from LinkedService

fromJson getAdditionalProperties getAnnotations getConnectVia getDescription getParameters getType getVersion setAdditionalProperties setAnnotations setConnectVia setDescription setParameters setVersion toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureFunctionLinkedService

public AzureFunctionLinkedService()

Creates an instance of AzureFunctionLinkedService class.

Method Details

fromJson

public static AzureFunctionLinkedService fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionLinkedService from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureFunctionLinkedService if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAuthentication

public Object getAuthentication()

Get the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).

Returns:

the authentication value.

getCredential

public CredentialReference getCredential()

Get the credential property: The credential reference containing authentication information.

Returns:

the credential value.

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.

getFunctionAppUrl

public Object getFunctionAppUrl()

Get the functionAppUrl property: The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net.

Returns:

the functionAppUrl value.

getFunctionKey

public SecretBase getFunctionKey()

Get the functionKey property: Function or Host key for Azure Function App.

Returns:

the functionKey value.

getResourceId

public Object getResourceId()

Get the resourceId property: Allowed token audiences for azure function.

Returns:

the resourceId value.

getType

public String getType()

Get the type property: Type of linked service.

Overrides:

AzureFunctionLinkedService.getType()

Returns:

the type value.

setAnnotations

public AzureFunctionLinkedService setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

AzureFunctionLinkedService.setAnnotations(List<Object> annotations)

Parameters:

annotations

setAuthentication

public AzureFunctionLinkedService setAuthentication(Object authentication)

Set the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).

Parameters:

authentication - the authentication value to set.

Returns:

the AzureFunctionLinkedService object itself.

setConnectVia

public AzureFunctionLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureFunctionLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

setCredential

public AzureFunctionLinkedService setCredential(CredentialReference credential)

Set the credential property: The credential reference containing authentication information.

Parameters:

credential - the credential value to set.

Returns:

the AzureFunctionLinkedService object itself.

setDescription

public AzureFunctionLinkedService setDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureFunctionLinkedService.setDescription(String description)

Parameters:

description

setEncryptedCredential

public AzureFunctionLinkedService 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 AzureFunctionLinkedService object itself.

setFunctionAppUrl

public AzureFunctionLinkedService setFunctionAppUrl(Object functionAppUrl)

Set the functionAppUrl property: The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net.

Parameters:

functionAppUrl - the functionAppUrl value to set.

Returns:

the AzureFunctionLinkedService object itself.

setFunctionKey

public AzureFunctionLinkedService setFunctionKey(SecretBase functionKey)

Set the functionKey property: Function or Host key for Azure Function App.

Parameters:

functionKey - the functionKey value to set.

Returns:

the AzureFunctionLinkedService object itself.

setParameters

public AzureFunctionLinkedService setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

Overrides:

AzureFunctionLinkedService.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

setResourceId

public AzureFunctionLinkedService setResourceId(Object resourceId)

Set the resourceId property: Allowed token audiences for azure function.

Parameters:

resourceId - the resourceId value to set.

Returns:

the AzureFunctionLinkedService object itself.

setVersion

public AzureFunctionLinkedService setVersion(String version)

Set the version property: Version of the linked service.

Overrides:

AzureFunctionLinkedService.setVersion(String version)

Parameters:

version

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionLinkedService.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to