Package com.azure.resourcemanager.datafactory.fluent.models

Class CosmosDbLinkedServiceTypeProperties

java.lang.Object
com.azure.resourcemanager.datafactory.fluent.models.CosmosDbLinkedServiceTypeProperties
public final class CosmosDbLinkedServiceTypeProperties extends Object
CosmosDB linked service properties.

  • Constructor Details

    • CosmosDbLinkedServiceTypeProperties

      public CosmosDbLinkedServiceTypeProperties()

  • Method Details

    • connectionString

      public Object connectionString()
      Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
      Returns:
      the connectionString value.

    • withConnectionString

      public CosmosDbLinkedServiceTypeProperties withConnectionString(Object connectionString)
      Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
      Parameters:
      connectionString - the connectionString value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • accountEndpoint

      public Object accountEndpoint()
      Get the accountEndpoint property: The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
      Returns:
      the accountEndpoint value.

    • withAccountEndpoint

      public CosmosDbLinkedServiceTypeProperties withAccountEndpoint(Object accountEndpoint)
      Set the accountEndpoint property: The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
      Parameters:
      accountEndpoint - the accountEndpoint value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • database

      public Object database()
      Get the database property: The name of the database. Type: string (or Expression with resultType string).
      Returns:
      the database value.

    • withDatabase

      public CosmosDbLinkedServiceTypeProperties withDatabase(Object database)
      Set the database property: The name of the database. Type: string (or Expression with resultType string).
      Parameters:
      database - the database value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • accountKey

      public SecretBase accountKey()
      Get the accountKey property: The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
      Returns:
      the accountKey value.

    • withAccountKey

      public CosmosDbLinkedServiceTypeProperties withAccountKey(SecretBase accountKey)
      Set the accountKey property: The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
      Parameters:
      accountKey - the accountKey value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • servicePrincipalId

      public Object servicePrincipalId()
      Get the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
      Returns:
      the servicePrincipalId value.

    • withServicePrincipalId

      public CosmosDbLinkedServiceTypeProperties withServicePrincipalId(Object servicePrincipalId)
      Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
      Parameters:
      servicePrincipalId - the servicePrincipalId value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • servicePrincipalCredentialType

      public CosmosDbServicePrincipalCredentialType servicePrincipalCredentialType()
      Get the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
      Returns:
      the servicePrincipalCredentialType value.

    • withServicePrincipalCredentialType

      public CosmosDbLinkedServiceTypeProperties withServicePrincipalCredentialType(CosmosDbServicePrincipalCredentialType servicePrincipalCredentialType)
      Set the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
      Parameters:
      servicePrincipalCredentialType - the servicePrincipalCredentialType value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • servicePrincipalCredential

      public SecretBase servicePrincipalCredential()
      Get the servicePrincipalCredential property: 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.
      Returns:
      the servicePrincipalCredential value.

    • withServicePrincipalCredential

      public CosmosDbLinkedServiceTypeProperties withServicePrincipalCredential(SecretBase servicePrincipalCredential)
      Set the servicePrincipalCredential property: 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.
      Parameters:
      servicePrincipalCredential - the servicePrincipalCredential value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • tenant

      public Object tenant()
      Get the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
      Returns:
      the tenant value.

    • withTenant

      public CosmosDbLinkedServiceTypeProperties withTenant(Object tenant)
      Set the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
      Parameters:
      tenant - the tenant value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • azureCloudType

      public Object azureCloudType()
      Get the azureCloudType property: 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).
      Returns:
      the azureCloudType value.

    • withAzureCloudType

      public CosmosDbLinkedServiceTypeProperties withAzureCloudType(Object azureCloudType)
      Set the azureCloudType property: 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).
      Parameters:
      azureCloudType - the azureCloudType value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • connectionMode

      public CosmosDbConnectionMode connectionMode()
      Get the connectionMode property: The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string).
      Returns:
      the connectionMode value.

    • withConnectionMode

      public CosmosDbLinkedServiceTypeProperties withConnectionMode(CosmosDbConnectionMode connectionMode)
      Set the connectionMode property: The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string).
      Parameters:
      connectionMode - the connectionMode value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • encryptedCredential

      public Object encryptedCredential()
      Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
      Returns:
      the encryptedCredential value.

    • withEncryptedCredential

      public CosmosDbLinkedServiceTypeProperties withEncryptedCredential(Object encryptedCredential)
      Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
      Parameters:
      encryptedCredential - the encryptedCredential value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • credential

      public CredentialReference credential()
      Get the credential property: The credential reference containing authentication information.
      Returns:
      the credential value.

    • withCredential

      public CosmosDbLinkedServiceTypeProperties withCredential(CredentialReference credential)
      Set the credential property: The credential reference containing authentication information.
      Parameters:
      credential - the credential value to set.
      Returns:
      the CosmosDbLinkedServiceTypeProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.