Class PhoenixLinkedService
Phoenix server linked service.
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.PhoenixLinkedService/PhoenixLinkedServiceConverter))]
public class PhoenixLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
Constructors
PhoenixLinkedService(Object, PhoenixAuthenticationType)
Initializes a new instance of PhoenixLinkedService.
Declaration
public PhoenixLinkedService (object host, Azure.Analytics.Synapse.Artifacts.Models.PhoenixAuthenticationType authenticationType);
Parameters
|
System.Object
host
The IP address or host name of the Phoenix server. (i.e. 192.168.222.160). |
|
PhoenixAuthenticationType
authenticationType
The authentication mechanism used to connect to the Phoenix server. |
Exceptions
|
System.ArgumentNullException
|
Properties
AllowHostNameCNMismatch
Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
Declaration
public object AllowHostNameCNMismatch { get; set; }
Property Value
|
System.Object
|
AllowSelfSignedServerCert
Specifies whether to allow self-signed certificates from the server. The default value is false.
Declaration
public object AllowSelfSignedServerCert { get; set; }
Property Value
|
System.Object
|
AuthenticationType
The authentication mechanism used to connect to the Phoenix server.
Declaration
public Azure.Analytics.Synapse.Artifacts.Models.PhoenixAuthenticationType AuthenticationType { get; set; }
Property Value
|
PhoenixAuthenticationType
|
EnableSsl
Specifies whether the connections to the server are encrypted using SSL. The default value is false.
Declaration
public object EnableSsl { get; set; }
Property Value
|
System.Object
|
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
|
Host
The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).
Declaration
public object Host { get; set; }
Property Value
|
System.Object
|
HttpPath
The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.
Declaration
public object HttpPath { get; set; }
Property Value
|
System.Object
|
Password
The password corresponding to the user name. 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
|
Port
The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.
Declaration
public object Port { get; set; }
Property Value
|
System.Object
|
TrustedCertPath
The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
Declaration
public object TrustedCertPath { get; set; }
Property Value
|
System.Object
|
Username
The user name used to connect to the Phoenix server.
Declaration
public object Username { get; set; }
Property Value
|
System.Object
|
UseSystemTrustStore
Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
Declaration
public object UseSystemTrustStore { get; set; }
Property Value
|
System.Object
|