AzureFunctionLinkedService Class

Package:: com.azure.resourcemanager.datafactory.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

java.lang.Object
- com.azure.resourcemanager.datafactory.models.LinkedService
- - com.azure.resourcemanager.datafactory.models.AzureFunctionLinkedService

public final 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
Object	authentication() Get the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction.
CredentialReference	credential() Get the credential property: The credential reference containing authentication information.
String	encryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
static AzureFunctionLinkedService	fromJson(JsonReader jsonReader) Reads an instance of AzureFunctionLinkedService from the JsonReader.
Object	functionAppUrl() Get the functionAppUrl property: The endpoint of the Azure Function App.
SecretBase	functionKey() Get the functionKey property: Function or Host key for Azure Function App.
Object	resourceId() Get the resourceId property: Allowed token audiences for azure function.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of linked service.
void	validate() Validates the instance.
AzureFunctionLinkedService	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
AzureFunctionLinkedService	withAuthentication(Object authentication) Set the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureFunction.
AzureFunctionLinkedService	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
AzureFunctionLinkedService	withCredential(CredentialReference credential) Set the credential property: The credential reference containing authentication information.
AzureFunctionLinkedService	withDescription(String description) Set the description property: Linked service description.
AzureFunctionLinkedService	withEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
AzureFunctionLinkedService	withFunctionAppUrl(Object functionAppUrl) Set the functionAppUrl property: The endpoint of the Azure Function App.
AzureFunctionLinkedService	withFunctionKey(SecretBase functionKey) Set the functionKey property: Function or Host key for Azure Function App.
AzureFunctionLinkedService	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
AzureFunctionLinkedService	withResourceId(Object resourceId) Set the resourceId property: Allowed token audiences for azure function.
AzureFunctionLinkedService	withVersion(String version) Set the version property: Version of the linked service.

Methods inherited from LinkedService

additionalProperties annotations connectVia description fromJson parameters toJson type validate version withAdditionalProperties withAnnotations withConnectVia withDescription withParameters withVersion

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

authentication

public Object authentication()

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.

credential

public CredentialReference credential()

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

Returns:

the credential value.

encryptedCredential

public String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Returns:

the encryptedCredential value.

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.

functionAppUrl

public Object functionAppUrl()

Get the functionAppUrl property: The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string).

Returns:

the functionAppUrl value.

functionKey

public SecretBase functionKey()

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

Returns:

the functionKey value.

resourceId

public Object resourceId()

Get the resourceId property: Allowed token audiences for azure function. Type: string (or Expression with resultType string).

Returns:

the resourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionLinkedService.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of linked service.

Overrides:

AzureFunctionLinkedService.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureFunctionLinkedService.validate()

withAnnotations

public AzureFunctionLinkedService withAnnotations(List<Object> annotations)

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

Overrides:

AzureFunctionLinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withAuthentication

public AzureFunctionLinkedService withAuthentication(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.

withConnectVia

public AzureFunctionLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureFunctionLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withCredential

public AzureFunctionLinkedService withCredential(CredentialReference credential)

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

Parameters:

credential - the credential value to set.

Returns:

the AzureFunctionLinkedService object itself.

withDescription

public AzureFunctionLinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureFunctionLinkedService.withDescription(String description)

Parameters:

description

withEncryptedCredential

public AzureFunctionLinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the AzureFunctionLinkedService object itself.

withFunctionAppUrl

public AzureFunctionLinkedService withFunctionAppUrl(Object functionAppUrl)

Set the functionAppUrl property: The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string).

Parameters:

functionAppUrl - the functionAppUrl value to set.

Returns:

the AzureFunctionLinkedService object itself.

withFunctionKey

public AzureFunctionLinkedService withFunctionKey(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.

withParameters

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

Set the parameters property: Parameters for linked service.

Overrides:

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

Parameters:

parameters

withResourceId

public AzureFunctionLinkedService withResourceId(Object resourceId)

Set the resourceId property: Allowed token audiences for azure function. Type: string (or Expression with resultType string).

Parameters:

resourceId - the resourceId value to set.

Returns:

the AzureFunctionLinkedService object itself.

withVersion

public AzureFunctionLinkedService withVersion(String version)

Set the version property: Version of the linked service.

Overrides:

AzureFunctionLinkedService.withVersion(String version)

Parameters:

version

Applies to

Feedback

Was this page helpful?