Class AzureFileStorageLinkedService

Azure File Storage linked service.

Inheritance
System.Object
LinkedService
AzureFileStorageLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureFileStorageLinkedService/AzureFileStorageLinkedServiceConverter))]
public class AzureFileStorageLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

AzureFileStorageLinkedService(Object)

Initializes a new instance of AzureFileStorageLinkedService.

Declaration
public AzureFileStorageLinkedService (object host);
Parameters
System.Object host

Host name of the server. Type: string (or Expression with resultType string).
Exceptions
System.ArgumentNullException

host is null.

Properties

AccountKey

The Azure key vault secret reference of accountKey in connection string.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.AzureKeyVaultSecretReference AccountKey { get; set; }
Property Value
AzureKeyVaultSecretReference

ConnectionString

The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

Declaration
public object ConnectionString { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

FileShare

The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).

Declaration
public object FileShare { get; set; }
Property Value
System.Object

Host

Host name of the server. Type: string (or Expression with resultType string).

Declaration
public object Host { get; set; }
Property Value
System.Object

Password

Password to logon the server. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

SasToken

The Azure key vault secret reference of sasToken in sas uri.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.AzureKeyVaultSecretReference SasToken { get; set; }
Property Value
AzureKeyVaultSecretReference

SasUri

SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

Declaration
public object SasUri { get; set; }
Property Value
System.Object

ServiceEndpoint

File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property.

Declaration
public object ServiceEndpoint { get; set; }
Property Value
System.Object

Snapshot

The azure file share snapshot version. Type: string (or Expression with resultType string).

Declaration
public object Snapshot { get; set; }
Property Value
System.Object

UserId

User ID to logon the server. Type: string (or Expression with resultType string).

Declaration
public object UserId { get; set; }
Property Value
System.Object