pulumi-azure-native-kotlin/com.pulumi.azurenative.datafactory.kotlin.inputs/CosmosDbLinkedServiceArgs

CosmosDbLinkedServiceArgs

data class CosmosDbLinkedServiceArgs(val accountEndpoint: Output<Any>? = null, val accountKey: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, val annotations: Output<List<Any>>? = null, val azureCloudType: Output<Any>? = null, val connectVia: Output<IntegrationRuntimeReferenceArgs>? = null, val connectionMode: Output<Either<String, CosmosDbConnectionMode>>? = null, val connectionString: Output<Any>? = null, val credential: Output<CredentialReferenceArgs>? = null, val database: Output<Any>? = null, val description: Output<String>? = null, val encryptedCredential: Output<String>? = null, val parameters: Output<Map<String, ParameterSpecificationArgs>>? = null, val servicePrincipalCredential: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, val servicePrincipalCredentialType: Output<Any>? = null, val servicePrincipalId: Output<Any>? = null, val tenant: Output<Any>? = null, val type: Output<String>) : ConvertibleToJava<CosmosDbLinkedServiceArgs>

Microsoft Azure Cosmos Database (CosmosDB) linked service.

Constructors

Link copied to clipboard
fun CosmosDbLinkedServiceArgs(accountEndpoint: Output<Any>? = null, accountKey: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, annotations: Output<List<Any>>? = null, azureCloudType: Output<Any>? = null, connectVia: Output<IntegrationRuntimeReferenceArgs>? = null, connectionMode: Output<Either<String, CosmosDbConnectionMode>>? = null, connectionString: Output<Any>? = null, credential: Output<CredentialReferenceArgs>? = null, database: Output<Any>? = null, description: Output<String>? = null, encryptedCredential: Output<String>? = null, parameters: Output<Map<String, ParameterSpecificationArgs>>? = null, servicePrincipalCredential: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, servicePrincipalCredentialType: Output<Any>? = null, servicePrincipalId: Output<Any>? = null, tenant: Output<Any>? = null, type: Output<String>)

Functions

Link copied to clipboard
open override fun toJava(): CosmosDbLinkedServiceArgs

Properties

Link copied to clipboard
val accountEndpoint: Output<Any>? = null

The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)

Link copied to clipboard
val accountKey: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null

The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.

Link copied to clipboard
val annotations: Output<List<Any>>? = null

List of tags that can be used for describing the linked service.

Link copied to clipboard
val azureCloudType: Output<Any>? = null

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

Link copied to clipboard
val connectionMode: Output<Either<String, CosmosDbConnectionMode>>? = null

The connection mode used to access CosmosDB account. Type: string.

Link copied to clipboard
val connectionString: Output<Any>? = null

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Link copied to clipboard
val connectVia: Output<IntegrationRuntimeReferenceArgs>? = null

The integration runtime reference.

Link copied to clipboard
val credential: Output<CredentialReferenceArgs>? = null

The credential reference containing authentication information.

Link copied to clipboard
val database: Output<Any>? = null

The name of the database. Type: string (or Expression with resultType string)

Link copied to clipboard
val description: Output<String>? = null

Linked service description.

Link copied to clipboard
val encryptedCredential: Output<String>? = null

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Link copied to clipboard
val parameters: Output<Map<String, ParameterSpecificationArgs>>? = null

Parameters for linked service.

Link copied to clipboard
val servicePrincipalCredential: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.

Link copied to clipboard
val servicePrincipalCredentialType: Output<Any>? = null

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.

Link copied to clipboard
val servicePrincipalId: Output<Any>? = null

The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

Link copied to clipboard
val tenant: Output<Any>? = null

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Link copied to clipboard
val type: Output<String>

Type of linked service. Expected value is 'CosmosDb'.