Share via

LakeHouseLinkedService Class

Microsoft Fabric Lakehouse linked service.

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

Constructor

LakeHouseLinkedService(*, 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, workspace_id: MutableMapping[str, Any] | None = None, artifact_id: MutableMapping[str, Any] | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, service_principal_credential_type: MutableMapping[str, Any] | None = None, service_principal_credential: _models.SecretBase | 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
workspace_id
<xref:JSON>

The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).

Default value: None
artifact_id
<xref:JSON>

The ID of Microsoft Fabric Lakehouse artifact. Type: string (or Expression with resultType string).

Default value: None
service_principal_id
<xref:JSON>

The ID of the application used to authenticate against Microsoft Fabric Lakehouse. Type: string (or Expression with resultType string).

Default value: None
service_principal_key
SecretBase

The Key of the application used to authenticate against Microsoft Fabric Lakehouse.

Default value: None
tenant
<xref:JSON>

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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
service_principal_credential_type
<xref:JSON>

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

Default value: None
service_principal_credential
SecretBase

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.

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.
workspace_id
<xref:JSON>

The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).
artifact_id
<xref:JSON>

The ID of Microsoft Fabric Lakehouse artifact. Type: string (or Expression with resultType string).
service_principal_id
<xref:JSON>

The ID of the application used to authenticate against Microsoft Fabric Lakehouse. Type: string (or Expression with resultType string).
service_principal_key
SecretBase

The Key of the application used to authenticate against Microsoft Fabric Lakehouse.
tenant
<xref:JSON>

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
service_principal_credential_type
<xref:JSON>

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
service_principal_credential
SecretBase

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.