Adf Azure Cosmos Db Linked Service Element
X-Ref:
- Ast Adf Azure Cosmos Db Linked Service Node
- Ast Adf Connection String 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 |
---|---|---|---|
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 | |
AccountEndpoint | String | Specifies the Account Endpoint to connect to. | |
AccountKey | String | Specifies the AccountKey for to connect to AzureCosmos Db. | |
AzureCloudType | AdfAzureCloudType | None | Indicates the azure cloud type of the service principle auth. |
ConnectionMode | AdfCosmosDbConnectionMode | Direct | The connection mode used to access CosmosDB account. |
ConnectionString | String | Specifies the connection string that contains information necessary to connect to the linked service. | |
Database | String | Specifies the Database to connect to. | |
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. | |
ServicePrincipalCredential | String | Specifies the service principal credential to be used during authentication. | |
ServicePrincipalCredentialType | AdfDynamicsServicePrincipalCredentialType | ServicePrincipalKey | Specifies what type of service principal credential will be used for authentication. |
ServicePrincipalId | String | Specifies the service principal ID to be used during authentication. | |
Tenant | String | Tenant associated with service principal account. |
Singleton Children
Child | API Type | Description |
---|---|---|
<AccountKeyKVS /> | 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. |
<ConnectionStringKVS /> | 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. |
<ConnectVia /> | AstAdfLinkedServiceConnectViaNode | Specifies the integration runtime that should be used to connect to the selected linked service. |
<ServicePrincipalCredentialKVS /> | 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. |