PhoenixLinkedService Class

Phoenix server linked service.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

PhoenixLinkedService

Constructor

PhoenixLinkedService(*, host: MutableMapping[str, Any], authentication_type: str | _models.PhoenixAuthenticationType, 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, port: MutableMapping[str, Any] | None = None, http_path: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, enable_ssl: MutableMapping[str, Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str, Any] | None = None, allow_host_name_cn_mismatch: MutableMapping[str, Any] | None = None, allow_self_signed_server_cert: MutableMapping[str, Any] | None = None, encrypted_credential: str | 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> The IP address or host name of the Phoenix server. (i.e. 192.168.222.160). Required.
port	<xref:JSON> The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.
http_path	<xref:JSON> 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 The authentication mechanism used to connect to the Phoenix server. Required. Known values are: "Anonymous", "UsernameAndPassword", and "WindowsAzureHDInsightService".
username	<xref:JSON> The user name used to connect to the Phoenix server.
password	SecretBase The password corresponding to the user name.
enable_ssl	<xref:JSON> Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> Specifies whether to allow self-signed certificates from the server. The default value is false.
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

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> The IP address or host name of the Phoenix server. (i.e. 192.168.222.160). Required.
port	<xref:JSON> The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.
http_path	<xref:JSON> 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 The authentication mechanism used to connect to the Phoenix server. Required. Known values are: "Anonymous", "UsernameAndPassword", and "WindowsAzureHDInsightService".
username	<xref:JSON> The user name used to connect to the Phoenix server.
password	SecretBase The password corresponding to the user name.
enable_ssl	<xref:JSON> Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> Specifies whether to allow self-signed certificates from the server. The default value is false.
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.