• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Adf Azure Cosmos Db Linked Service Element

API Type:
Varigence.Languages.Biml.DataFactory.AstAdfAzureCosmosDbLinkedServiceNode
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

AttributeAPI TypeDefaultDescription
NameString 
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
AccountEndpointString 
Specifies the Account Endpoint to connect to.
AccountKeyString 
Specifies the AccountKey for to connect to AzureCosmos Db.
AzureCloudTypeAdfAzureCloudTypeNone
Indicates the azure cloud type of the service principle auth.
ConnectionModeAdfCosmosDbConnectionModeDirect
The connection mode used to access CosmosDB account.
ConnectionStringString 
Specifies the connection string that contains information necessary to connect to the linked service.
DatabaseString 
Specifies the Database to connect to.
EncryptedCredentialString 
Specifies the encrypted credential that will be used to authenticate the linked service.
LogicalDisplayFolderString 
Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
ServicePrincipalCredentialString 
Specifies the service principal credential to be used during authentication.
ServicePrincipalCredentialTypeAdfDynamicsServicePrincipalCredentialTypeServicePrincipalKey
Specifies what type of service principal credential will be used for authentication.
ServicePrincipalIdString 
Specifies the service principal ID to be used during authentication.
TenantString 
Tenant associated with service principal account.

Singleton Children

ChildAPI TypeDescription
<AccountKeyKVS />AstAdfKeyVaultSecretNodeDefines 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 />AstAdfKeyVaultSecretNodeDefines 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 />AstAdfLinkedServiceConnectViaNodeSpecifies the integration runtime that should be used to connect to the selected linked service.
<ServicePrincipalCredentialKVS />AstAdfKeyVaultSecretNodeDefines 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

ChildAPI TypeDescription
<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.

© Varigence