Adf Amazon Redshift Linked Service Element
Adf Amazon Redshift Linked Service Element
X-Ref:
- Ast Adf Amazon Redshift Linked Service Node
- Ast Adf Server Database Linked Service Base Node
- Ast Adf Server 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 |
|---|---|---|---|
| Database | String | Specifies the name of the database that the linked service will connect to. 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 | |
| Server | String | Specifies the name of the server that the linked service will connect to. This is a required property | |
| EncryptedCredential | String | Specifies the encrypted credential that will be used to authenticate the linked service. | |
| FabricConnectionId | String | Specifies the ID of the Microsoft Fabric connection that corresponds to this linked service. When the project is built for Microsoft Fabric, activities and dataset settings that reference this linked service emit this value as an external connection reference. | |
| FabricDatabase | String | Specifies the name of the database that is emitted alongside the Microsoft Fabric connection ID in dataset settings and stored procedure payloads when the project is built for Microsoft Fabric. | |
| 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 | Specifies the network port that the linked service will use to connect to the database. If omitted then port 5439 is used. | |
| SslInsecure | Boolean | False | Specifies whether the driver skips the authenticity check of the IdP server certificate. The default value is false. Only used for version 2.0. |
| SslMode | AdfAmazonRedshiftLinkedServiceSslMode | None | Specifies the SSL certificate verification mode the linked service uses to connect to Amazon Redshift. None emits nothing and the service default verify-full applies. Only used for version 2.0. |
| 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. |
| <RawJsonProperties /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <RawJsonTypeProperties /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <AdditionalConnectionProperties> <AdditionalConnectionProperty /> </AdditionalConnectionProperties> | AstAdfLinkedServiceAdditionalConnectionPropertyNode | This is the collection of additional connection properties that will be emitted as extra entries within typeProperties in the generated ADF JSON. |
| <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. |