Adf Rest Service Linked Service Element
X-Ref:
- Ast Adf Rest Service Linked Service Node
- Ast Adf Linked Service Base Node
- Ast Adf Root Object Node
- Ast Scope Boundary Node
Attributes
Attribute | API Type | Default | Description |
---|---|---|---|
AuthenticationType | AdfRestServiceAuthenticationType | Anonymous | Mode of authentication for connecting to the REST service. 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 | Rest service's base URL. This is a required property | |
AadResourceId | String | Id of the resource that user is requesting authorization. | |
AzureCloudType | AdfAzureCloudType | None | Indicates the azure cloud type of the service principle auth. |
EnableServerCertificateValidation | Boolean | true | Specify whether to validate the server's SSL certificate during connection. Default is true. |
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 | Password for Basic Auth. | |
ServicePrincipalId | String | Client ID for the application. | |
ServicePrincipalKey | String | Key for the application | |
Tenant | String | Specify either the domain name or tenant ID that houses your application. | |
Username | String | Username for Basic Auth. |
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. |
<ServicePrincipalKeyKVS /> | 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. |