Adf Phoenix Linked Service Element
X-Ref:
- Ast Adf Phoenix Linked Service Node
- Ast Adf Apache Linked Service Base 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 | AdfApacheAuthenticationType | Anonymous | Specifies type of apache authentication to use to connect. This is a required property |
| Host | String | IP address or name of the 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 | |
| AllowHostNameCNMistmatch | Boolean | False | If connection over SSL, this determines whether to allow CA-issued SSL certificate names to differ from the host name of the server. Default is false. |
| AllowSelfSignedServerCert | Boolean | False | Specifies whether self-signed server certificates are permitted. Default is false. |
| EnableSsl | Boolean | False | Specifies whethre SSL is used to encrpt connectiosn to the server. Default is false. |
| EncryptedCredential | String | Specifies the encrypted credential that will be used to authenticate the linked service. | |
| HttpPath | String | Relative URL to the Phoenix server. Default value is 'hbasephoenix' for 'WindowsAzureHDInsightService' authentication type. | |
| LogicalDisplayFolder | String | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. | |
| Password | String | Specifies the password that the linked service will use connect to the server. | |
| Port | String | TCP port that will be used to listen for client connectors. | |
| TrustedCertPath | String | The complete filepath of the .pem file containing trusted CA certificates to verify the server during SSL connections. The default value is the cacerts.pem file installed with the IR. | |
| Username | String | Specifies the username that the linked service will use connect to the server. | |
| UseSystemTrustStore | Boolean | False | Specifies if the CA certificate from the system trust store can be used for SSL connections. If false the CA certificate from the PEM file is used. Default is false. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <ConnectVia /> | AstAdfLinkedServiceConnectViaNode | Specifies the integration runtime that should be used to connect to the selected linked service. |
| <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. |
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. |