SapTableLinkedService Class

SAP Table Linked Service.

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

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
SapTableLinkedService

Constructor

SapTableLinkedService(*, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None = None, server: object | None = None, system_number: object | None = None, client_id: object | None = None, language: object | None = None, system_id: object | None = None, user_name: object | None = None, password: SecretBase | None = None, message_server: object | None = None, message_server_service: object | None = None, snc_mode: object | None = None, snc_my_name: object | None = None, snc_partner_name: object | None = None, snc_library_path: object | None = None, snc_qop: object | None = None, logon_group: object | None = None, encrypted_credential: object | None = 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.

server
object
Required

Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).

system_number
object
Required

System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

client_id
object
Required

Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

language
object
Required

Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).

system_id
object
Required

SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).

user_name
object
Required

Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).

password
SecretBase
Required

Password to access the SAP server where the table is located.

message_server
object
Required

The hostname of the SAP Message Server. Type: string (or Expression with resultType string).

message_server_service
object
Required

The service name or port number of the Message Server. Type: string (or Expression with resultType string).

snc_mode
object
Required

SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).

snc_my_name
object
Required

Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

snc_partner_name
object
Required

Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

snc_library_path
object
Required

External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).

snc_qop
object
Required

SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).

logon_group
object
Required

The Logon Group for the SAP System. Type: string (or Expression with resultType string).

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).

Keyword-Only Parameters

additional_properties
Required
connect_via
Required
description
Required
parameters
Required
annotations
Required
server
Required
system_number
Required
client_id
Required
language
Required
system_id
Required
user_name
Required
password
Required
message_server
Required
message_server_service
Required
snc_mode
Required
snc_my_name
Required
snc_partner_name
Required
snc_library_path
Required
snc_qop
Required
logon_group
Required
encrypted_credential
Required

Methods

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

deserialize

Parse a str using the RestAPI syntax and return a model.

enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

validate

Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

key_transformer
<xref:function>

A key transformer function.

keep_readonly
default value: True

Returns

A dict JSON compatible object

Return type

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

data
str
Required

A str using RestAPI structure. JSON by default.

content_type
str
default value: None

JSON by default, set application/xml if XML.

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

data
dict
Required

A dict using RestAPI structure

content_type
str
default value: None

JSON by default, set application/xml if XML.

key_extractors
default value: None

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly
bool
default value: False

If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

A list of validation error

Return type