Adf Sftp Linked Service Element
X-Ref:
- Ast Adf Sftp Linked Service Node
- Ast Adf Authenticated Linked Service Base Node
- Ast Adf Linked Service Base Node
- Ast Adf Root Object Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| AuthenticationType | AdfLinkedServiceAuthenticationType | Anonymous | Specifies the authentication mechanism that the linked service will use to connect to the database. Permitted values are Basic and SshPublicKey. This is a required property |
| Host | String | Specifies the IP address or host name of the SFTP server. This is a required property | |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| EncryptedCredential | String | Specifies the encrypted credential that will be used to authenticate the linked service. | |
| HostKeyFingerprint | String | Specifies the thumbprint of the host key for the SFTP server. This property should only be provided if SkipHostKeyValidation is set to false. | |
| LogicalDisplayFolder | String | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. | |
| PassPhrase | String | Specifies the password for the private key, if it is password-protected. | |
| Password | String | Specifies the password that the linked service will use connect to the server. | |
| Port | Int32 | 0 | Specifies the network port that the linked service will use to connect to the SFTP server. The default value is 22. |
| PrivateKeyContent | String | Specifies a base64 encoded string with the contents of the private key file. This property should only be provided if PrivateKeyPath is not specified. | |
| PrivateKeyPath | String | When using a self-hosted integration runtime (as configured through the ConnectVia property), specifies the absolute path to the private key file. This property should only be provided if PrivateKeyContent is not specified. | |
| SkipHostKeyValidation | Boolean | False | Specifies whether host key validation should be skipped when connecting to the server. The default value is false. |
| Username | String | Specifies the username that the linked service will use connect to the server. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <ConnectVia /> | AstAdfLinkedServiceConnectViaNode | Specifies the integration runtime that should be used to connect to the selected linked service. |
| <PassPhraseKVS /> | AstAdfKeyVaultSecretNode | Defines a field in a Linked Service that references a key vault secret. This allows users to reference a password without putting it explicitly in the Azure Data Factory json. |
| <PasswordKVS /> | AstAdfKeyVaultSecretNode | Defines a field in a Linked Service that references a key vault secret. This allows users to reference a password without putting it explicitly in the Azure Data Factory json. |
| <PrivateKeyContentKVS /> | AstAdfKeyVaultSecretNode | Defines a field in a Linked Service that references a key vault secret. This allows users to reference a password without putting it explicitly in the Azure Data Factory json. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <AdfAnnotations> <AdfAnnotation /> </AdfAnnotations> | String | This is the collection of annotations that will be emitted in the json. |
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |