Share via

AzureFunctionLinkedService Class

Azure Function linked service.

All required parameters must be populated in order to send to server.

Constructor

AzureFunctionLinkedService(*, function_app_url: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, function_key: _models.SecretBase | None = None, encrypted_credential: str | None = None, credential: _models.CredentialReference | None = None, resource_id: MutableMapping[str, Any] | None = None, authentication: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.

Default value: None
function_app_url
<xref:JSON>

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

Function or Host key for Azure Function App.

Default value: None
encrypted_credential
str

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

Default value: None
credential
CredentialReference

The credential reference containing authentication information.

Default value: None
resource_id
<xref:JSON>

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

Default value: None
authentication
<xref:JSON>

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

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Type of linked service. Required.
version
str

Version of the linked service.
connect_via
IntegrationRuntimeReference

The integration runtime reference.
description
str

Linked service description.
parameters
dict[str, ParameterSpecification]

Parameters for linked service.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.
function_app_url
<xref:JSON>

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

Function or Host key for Azure Function App.
encrypted_credential
str

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

The credential reference containing authentication information.
resource_id
<xref:JSON>

Allowed token audiences for azure function. Type: string (or Expression with resultType string).
authentication
<xref:JSON>

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