Share via

HiveLinkedService Class

Hive Server linked service.

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

Constructor

HiveLinkedService(*, host: MutableMapping[str, Any], authentication_type: str | _models.HiveAuthenticationType, 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, server_type: str | _models.HiveServerType | None = None, thrift_transport_protocol: str | _models.HiveThriftTransportProtocol | None = None, service_discovery_mode: MutableMapping[str, Any] | None = None, zoo_keeper_name_space: MutableMapping[str, Any] | None = None, use_native_query: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, http_path: MutableMapping[str, Any] | 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.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

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

Default value: None
host
<xref:JSON>

IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). Required.
port
<xref:JSON>

The TCP port that the Hive server uses to listen for client connections.

Default value: None
server_type
str or HiveServerType

The type of Hive server. Known values are: "HiveServer1", "HiveServer2", and "HiveThriftServer".

Default value: None
thrift_transport_protocol
str or HiveThriftTransportProtocol

The transport protocol to use in the Thrift layer. Known values are: "Binary", "SASL", and "HTTP ".

Default value: None
authentication_type
str or HiveAuthenticationType

The authentication method used to access the Hive server. Required. Known values are: "Anonymous", "Username", "UsernameAndPassword", and "WindowsAzureHDInsightService".
service_discovery_mode
<xref:JSON>

true to indicate using the ZooKeeper service, false not.

Default value: None
zoo_keeper_name_space
<xref:JSON>

The namespace on ZooKeeper under which Hive Server 2 nodes are added.

Default value: None
use_native_query
<xref:JSON>

Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.

Default value: None
username
<xref:JSON>

The user name that you use to access Hive Server.

Default value: None
password
SecretBase

The password corresponding to the user name that you provided in the Username field.

Default value: None
http_path
<xref:JSON>

The partial URL corresponding to the Hive server.

Default value: None
enable_ssl
<xref:JSON>

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

Default value: None
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.

Default value: None
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.

Default value: None
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.

Default value: None
allow_self_signed_server_cert
<xref:JSON>

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

Default value: None
encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Default value: None

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>

IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). Required.
port
<xref:JSON>

The TCP port that the Hive server uses to listen for client connections.
server_type
str or HiveServerType

The type of Hive server. Known values are: "HiveServer1", "HiveServer2", and "HiveThriftServer".
thrift_transport_protocol
str or HiveThriftTransportProtocol

The transport protocol to use in the Thrift layer. Known values are: "Binary", "SASL", and "HTTP ".
authentication_type
str or HiveAuthenticationType

The authentication method used to access the Hive server. Required. Known values are: "Anonymous", "Username", "UsernameAndPassword", and "WindowsAzureHDInsightService".
service_discovery_mode
<xref:JSON>

true to indicate using the ZooKeeper service, false not.
zoo_keeper_name_space
<xref:JSON>

The namespace on ZooKeeper under which Hive Server 2 nodes are added.
use_native_query
<xref:JSON>

Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
username
<xref:JSON>

The user name that you use to access Hive Server.
password
SecretBase

The password corresponding to the user name that you provided in the Username field.
http_path
<xref:JSON>

The partial URL corresponding to the Hive server.
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.