SftpServerLinkedService Class
A linked service for an SSH File Transfer Protocol (SFTP) server.
All required parameters must be populated in order to send to Azure.
- Inheritance
-
azure.synapse.artifacts.models._models_py3.LinkedServiceSftpServerLinkedService
Constructor
SftpServerLinkedService(*, host: object, 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, port: object | None = None, authentication_type: str | SftpAuthenticationType | None = None, user_name: object | None = None, password: SecretBase | None = None, encrypted_credential: object | None = None, private_key_path: object | None = None, private_key_content: SecretBase | None = None, pass_phrase: SecretBase | None = None, skip_host_key_validation: object | None = None, host_key_fingerprint: object | None = None, **kwargs)
Parameters
Name | Description |
---|---|
additional_properties
Required
|
Unmatched properties from the message are deserialized to this collection. |
type
Required
|
Required. Type of linked service.Constant filled by server. |
connect_via
Required
|
The integration runtime reference. |
description
Required
|
Linked service description. |
parameters
Required
|
Parameters for linked service. |
annotations
Required
|
List of tags that can be used for describing the linked service. |
host
Required
|
Required. The SFTP server host name. Type: string (or Expression with resultType string). |
port
Required
|
The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0. |
authentication_type
Required
|
The authentication type to be used to connect to the FTP server. Possible values include: "Basic", "SshPublicKey". |
user_name
Required
|
The username used to log on to the SFTP server. Type: string (or Expression with resultType string). |
password
Required
|
Password to logon the SFTP server for Basic authentication. |
encrypted_credential
Required
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). |
private_key_path
Required
|
The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string). |
private_key_content
Required
|
Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. |
pass_phrase
Required
|
The password to decrypt the SSH private key if the SSH private key is encrypted. |
skip_host_key_validation
Required
|
If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). |
host_key_fingerprint
Required
|
The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). |
Keyword-Only Parameters
Name | Description |
---|---|
host
Required
|
|
additional_properties
Required
|
|
connect_via
Required
|
|
description
Required
|
|
parameters
Required
|
|
annotations
Required
|
|
port
Required
|
|
authentication_type
Required
|
|
user_name
Required
|
|
password
Required
|
|
encrypted_credential
Required
|
|
private_key_path
Required
|
|
private_key_content
Required
|
|
pass_phrase
Required
|
|
skip_host_key_validation
Required
|
|
host_key_fingerprint
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:
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
Name | Description |
---|---|
key_transformer
|
<xref:function>
A key transformer function. |
keep_readonly
|
default value: True
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a model.
deserialize(data, content_type=None)
Parameters
Name | Description |
---|---|
data
Required
|
A str using RestAPI structure. JSON by default. |
content_type
|
JSON by default, set application/xml if XML. default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
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
Name | Description |
---|---|
data
Required
|
A dict using RestAPI structure |
content_type
|
JSON by default, set application/xml if XML. default value: None
|
key_extractors
|
default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
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
Name | Description |
---|---|
keep_readonly
|
If you want to serialize the readonly attributes default value: False
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
validate
Validate this model recursively and return a list of ValidationError.
validate()
Returns
Type | Description |
---|---|
A list of validation error |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for