Class: Azure::DataFactory::Mgmt::V2017_09_01_preview::Models::SftpServerLinkedService

Inherits:
LinkedService
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb

Overview

A linked service for an SSH File Transfer Protocol (SFTP) server.

Instance Attribute Summary collapse

Attributes inherited from LinkedService

#additional_properties, #annotations, #connect_via, #description, #parameters

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SftpServerLinkedService

Returns a new instance of SftpServerLinkedService.



16
17
18
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 16

def initialize
  @type = "Sftp"
end

Instance Attribute Details

#authentication_type ⇒ SftpAuthenticationType

connect to the FTP server. Possible values include: ‘Basic’, ‘SshPublicKey’

Returns:



34
35
36
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 34

def authentication_type
  @authentication_type
end

#encrypted_credential ⇒ Object

are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Returns:

  • The encrypted credential used for authentication. Credentials



47
48
49
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 47

def encrypted_credential
  @encrypted_credential
end

#host ⇒ Object

resultType string).

Returns:

  • The SFTP server host name. Type: string (or Expression with



24
25
26
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 24

def host
  @host
end

#host_key_fingerprint ⇒ Object

SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

Returns:

  • The host key finger-print of the SFTP server. When



73
74
75
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 73

def host_key_fingerprint
  @host_key_fingerprint
end

#pass_phrase ⇒ SecretBase

SSH private key is encrypted.

Returns:

  • (SecretBase) —

    The password to decrypt the SSH private key if the



64
65
66
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 64

def pass_phrase
  @pass_phrase
end

#password ⇒ SecretBase

authentication.

Returns:

  • (SecretBase) —

    Password to logon the SFTP server for Basic



42
43
44
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 42

def password
  @password
end

#port ⇒ Object

client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.

Returns:

  • The TCP port number that the SFTP server uses to listen for



29
30
31
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 29

def port
  @port
end

#private_key_content ⇒ SecretBase

SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.

Returns:

  • (SecretBase) —

    Base64 encoded SSH private key content for



60
61
62
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 60

def private_key_content
  @private_key_content
end

#private_key_path ⇒ Object

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

Returns:

  • The SSH private key file path for SshPublicKey authentication.



54
55
56
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 54

def private_key_path
  @private_key_path
end

#skip_host_key_validation ⇒ Object

false. Type: boolean (or Expression with resultType boolean).

Returns:

  • If true, skip the SSH host key validation. Default value is



68
69
70
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 68

def skip_host_key_validation
  @skip_host_key_validation
end

#type ⇒ Object

Returns the value of attribute type.



20
21
22
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 20

def type
  @type
end

#user_name ⇒ Object

(or Expression with resultType string).

Returns:

  • The username used to log on to the SFTP server. Type: string



38
39
40
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 38

def user_name
  @user_name
end

Class Method Details

.mapper ⇒ Object

Mapper for SftpServerLinkedService class as Ruby Hash. This will be used for serialization/deserialization.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/sftp_server_linked_service.rb', line 80

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Sftp',
    type: {
      name: 'Composite',
      class_name: 'SftpServerLinkedService',
      model_properties: {
        additional_properties: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        connect_via: {
          client_side_validation: true,
          required: false,
          serialized_name: 'connectVia',
          type: {
            name: 'Composite',
            class_name: 'IntegrationRuntimeReference'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'parameters',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParameterSpecificationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ParameterSpecification'
                }
            }
          }
        },
        annotations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'annotations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        host: {
          client_side_validation: true,
          required: true,
          serialized_name: 'typeProperties.host',
          type: {
            name: 'Object'
          }
        },
        port: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.port',
          type: {
            name: 'Object'
          }
        },
        authentication_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.authenticationType',
          type: {
            name: 'String'
          }
        },
        user_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.userName',
          type: {
            name: 'Object'
          }
        },
        password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.password',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'type',
            uber_parent: 'SecretBase',
            class_name: 'SecretBase'
          }
        },
        encrypted_credential: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.encryptedCredential',
          type: {
            name: 'Object'
          }
        },
        private_key_path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.privateKeyPath',
          type: {
            name: 'Object'
          }
        },
        private_key_content: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.privateKeyContent',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'type',
            uber_parent: 'SecretBase',
            class_name: 'SecretBase'
          }
        },
        pass_phrase: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.passPhrase',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'type',
            uber_parent: 'SecretBase',
            class_name: 'SecretBase'
          }
        },
        skip_host_key_validation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.skipHostKeyValidation',
          type: {
            name: 'Object'
          }
        },
        host_key_fingerprint: {
          client_side_validation: true,
          required: false,
          serialized_name: 'typeProperties.hostKeyFingerprint',
          type: {
            name: 'Object'
          }
        }
      }
    }
  }
end