AzureFileStorageLinkedService Class

Reference

Azure File Storage linked service.

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

Inheritance: azure.mgmt.datafactory.models._models_py3.LinkedService

AzureFileStorageLinkedService

Constructor

AzureFileStorageLinkedService(*, 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, host: MutableMapping[str, Any] | None = None, user_id: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, connection_string: MutableMapping[str, Any] | None = None, account_key: _models.AzureKeyVaultSecretReference | None = None, sas_uri: MutableMapping[str, Any] | None = None, sas_token: _models.AzureKeyVaultSecretReference | None = None, file_share: MutableMapping[str, Any] | None = None, snapshot: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, service_endpoint: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference | 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.
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.
host	<xref:JSON> Host name of the server. Type: string (or Expression with resultType string).
user_id	<xref:JSON> User ID to logon the server. Type: string (or Expression with resultType string).
password	SecretBase Password to logon the server.
connection_string	<xref:JSON> The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
account_key	AzureKeyVaultSecretReference The Azure key vault secret reference of accountKey in connection string.
sas_uri	<xref:JSON> SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
sas_token	AzureKeyVaultSecretReference The Azure key vault secret reference of sasToken in sas uri.
file_share	<xref:JSON> The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
snapshot	<xref:JSON> The azure file share snapshot version. 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_endpoint	<xref:JSON> File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property.
credential	CredentialReference The credential reference containing authentication information.

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.
host	<xref:JSON> Host name of the server. Type: string (or Expression with resultType string).
user_id	<xref:JSON> User ID to logon the server. Type: string (or Expression with resultType string).
password	SecretBase Password to logon the server.
connection_string	<xref:JSON> The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
account_key	AzureKeyVaultSecretReference The Azure key vault secret reference of accountKey in connection string.
sas_uri	<xref:JSON> SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
sas_token	AzureKeyVaultSecretReference The Azure key vault secret reference of sasToken in sas uri.
file_share	<xref:JSON> The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
snapshot	<xref:JSON> The azure file share snapshot version. 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_endpoint	<xref:JSON> File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property.
credential	CredentialReference The credential reference containing authentication information.

Share via

AzureFileStorageLinkedService Class

Constructor

Keyword-Only Parameters

Variables

Additional resources