Package com.azure.ai.metricsadvisor.administration.models

Class DataSourceServicePrincipalInKeyVault

java.lang.Object
com.azure.ai.metricsadvisor.administration.models.DataSourceCredentialEntity
com.azure.ai.metricsadvisor.administration.models.DataSourceServicePrincipalInKeyVault
public final class DataSourceServicePrincipalInKeyVault extends DataSourceCredentialEntity
The service principal stored in a key vault representing the credential entity for a data source.

  • Constructor Details

    • DataSourceServicePrincipalInKeyVault

      public DataSourceServicePrincipalInKeyVault()

  • Method Details

    • getId

      public String getId()
      Description copied from class: DataSourceCredentialEntity
      Gets the credential id.
      Specified by:
      getId in class DataSourceCredentialEntity
      Returns:
      The credential id.

    • getName

      public String getName()
      Description copied from class: DataSourceCredentialEntity
      Gets the credential name.
      Specified by:
      getName in class DataSourceCredentialEntity
      Returns:
      The credential name.

    • getDescription

      public String getDescription()
      Description copied from class: DataSourceCredentialEntity
      Gets the credential description.
      Specified by:
      getDescription in class DataSourceCredentialEntity
      Returns:
      The credential description.

    • getKeyVaultEndpoint

      public String getKeyVaultEndpoint()
      Gets the endpoint to the KeyVault storing service principal.
      Returns:
      The KeyVault endpoint.

    • getKeyVaultClientId

      public String getKeyVaultClientId()
      Gets the client id to access the KeyVault storing service principal.
      Returns:
      The client id to access the KeyVault.

    • getTenantId

      public String getTenantId()
      Gets the tenant id of the service principal.
      Returns:
      The tenant id.

    • getSecretNameForDataSourceClientId

      public String getSecretNameForDataSourceClientId()
      Gets the name of the KeyVault secret holding client secret.
      Returns:
      The name of the KeyVault secret holding client secret

    • getSecretNameForDataSourceClientSecret

      public String getSecretNameForDataSourceClientSecret()
      Gets the name of the KeyVault secret holding client secret.
      Returns:
      The name of the KeyVault secret holding client secret

    • setName

      public DataSourceServicePrincipalInKeyVault setName(String name)
      Sets the name.
      Parameters:
      name - The name
      Returns:
      an updated object with name set

    • setKeyVaultForDataSourceSecrets

      public DataSourceServicePrincipalInKeyVault setKeyVaultForDataSourceSecrets(String keyVaultEndpoint, String keyVaultClientId, String keyVaultClientSecret)
      Sets the keyVault containing the data source secrets.
      Parameters:
      keyVaultEndpoint - The keyVault endpoint
      keyVaultClientId - The client id to access the keyVault
      keyVaultClientSecret - The client secret to access the keyVault
      Returns:
      an updated object

    • setSecretNameForDataSourceClientId

      public DataSourceServicePrincipalInKeyVault setSecretNameForDataSourceClientId(String clientIdSecretName)
      Sets the name of the keyvault secret holding client id.
      Parameters:
      clientIdSecretName - The secret name
      Returns:
      an updated object with client id secret name set

    • setSecretNameForDataSourceClientSecret

      public DataSourceServicePrincipalInKeyVault setSecretNameForDataSourceClientSecret(String clientSecretName)
      Sets the name of the keyvault secret holding client secret.
      Parameters:
      clientSecretName - The secret name
      Returns:
      an updated object with client secret name set

    • setTenantId

      public DataSourceServicePrincipalInKeyVault setTenantId(String tenantId)
      Sets the tenant id.
      Parameters:
      tenantId - The tenant id
      Returns:
      an updated object with client tenant id set

    • setDescription

      public DataSourceServicePrincipalInKeyVault setDescription(String description)
      Sets the description.
      Parameters:
      description - The description
      Returns:
      an updated object with description set