Adf Http Linked Service Element
X-Ref:
- Ast Adf Http 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 Anonymous, Basic, Digest, Windows, and ClientCertificate. 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 | |
Url | String | Specifies the root URL of the HTTP web server. This is a required property | |
CertThumbprint | String | When using ClientCertificate authentication, specifies the thumprint of the certificate. This is should be specified if EmbeddedCertData is not provided. | |
EmbeddedCertData | String | When using ClientCertificate authentication, specifies the certificate data as a base64 encoded string. This is should be specified if CertThumbprint is not provided. | |
EnableServerCertificateValidation | Boolean | True | Specifies whether the server certificate should be validated when using SSL/TLS. |
EncryptedCredential | String | Specifies the encrypted credential that will be used to authenticate the linked service. | |
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. | |
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. |
<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. |