AzureBlobFSLinkedService Class
Azure Data Lake Storage Gen2 linked service.
All required parameters must be populated in order to send to server.
Constructor
AzureBlobFSLinkedService(*, 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, url: MutableMapping[str, Any] | None = None, account_key: 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, azure_cloud_type: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, credential: _models.CredentialReference | None = None, service_principal_credential_type: MutableMapping[str, Any] | None = None, service_principal_credential: _models.SecretBase | None = None, sas_uri: MutableMapping[str, Any] | None = None, sas_token: _models.SecretBase | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
version
|
Version of the linked service. Default value: None
|
connect_via
|
The integration runtime reference. Default value: None
|
description
|
Linked service description. Default value: None
|
parameters
|
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
|
url
|
<xref:JSON>
Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). Default value: None
|
account_key
|
<xref:JSON>
Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). Default value: None
|
service_principal_id
|
<xref:JSON>
The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). Default value: None
|
service_principal_key
|
The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. 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
|
azure_cloud_type
|
<xref:JSON>
Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions' cloud type. Type: string (or Expression with resultType string). Default value: None
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
credential
|
The credential reference containing authentication information. 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
|
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
|
sas_uri
|
<xref:JSON>
SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. Default value: None
|
sas_token
|
The Azure key vault secret reference of sasToken in sas uri. Default value: None
|
Variables
Name | Description |
---|---|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
type
|
Type of linked service. Required. |
version
|
Version of the linked service. |
connect_via
|
The integration runtime reference. |
description
|
Linked service description. |
parameters
|
Parameters for linked service. |
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
url
|
<xref:JSON>
Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). |
account_key
|
<xref:JSON>
Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). |
service_principal_id
|
<xref:JSON>
The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). |
service_principal_key
|
The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. |
tenant
|
<xref:JSON>
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). |
azure_cloud_type
|
<xref:JSON>
Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions' cloud type. Type: string (or Expression with resultType string). |
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
credential
|
The credential reference containing authentication information. |
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
|
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. |
sas_uri
|
<xref:JSON>
SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. |
sas_token
|
The Azure key vault secret reference of sasToken in sas uri. |