PhoenixLinkedService Class

Phoenix server linked service.

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

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

PhoenixLinkedService

Constructor

PhoenixLinkedService(*, host: object, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PhoenixAuthenticationType], additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, port: Optional[object] = None, http_path: Optional[object] = None, username: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, enable_ssl: Optional[object] = None, trusted_cert_path: Optional[object] = None, use_system_trust_store: Optional[object] = None, allow_host_name_cn_mismatch: Optional[object] = None, allow_self_signed_server_cert: Optional[object] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

type

str

Required

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

Required

The integration runtime reference.

description

str

Required

Linked service description.

parameters

dict[str, ParameterSpecification]

Required

Parameters for linked service.

annotations

list[object]

Required

List of tags that can be used for describing the linked service.

host

object

Required

Required. The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).

port

object

Required

The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.

http_path

object

Required

The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.

authentication_type

str or PhoenixAuthenticationType

Required

Required. The authentication mechanism used to connect to the Phoenix server. Possible values include: "Anonymous", "UsernameAndPassword", "WindowsAzureHDInsightService".

username

object

Required

The user name used to connect to the Phoenix server.

password

SecretBase

Required

The password corresponding to the user name.

enable_ssl

object

Required

Specifies whether the connections to the server are encrypted using SSL. The default value is false.

trusted_cert_path

object

Required

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.

use_system_trust_store

object

Required

Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

allow_host_name_cn_mismatch

object

Required

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.

allow_self_signed_server_cert

object

Required

Specifies whether to allow self-signed certificates from the server. The default value is false.

encrypted_credential

object

Required

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