DataSourceServicePrincipalInKeyVault interface

Package:

@azure/ai-metrics-advisor

Service Principal in KeyVault DataSource Credential User is required to specify keyVaultClientSecret for Create. keyVaultClientSecret being a secret is not returned by service.

Extends

DataSourceCredentialEntity

Properties

keyVaultClientId	The Client Id to access the Key Vault.
keyVaultClientSecret	The Client Secret to access the Key Vault. Required by user for Create. Not returned by service.
keyVaultEndpoint	The Key Vault endpoint that storing the service principal.
servicePrincipalIdNameInKV	The secret name of the service principal's client Id in the Key Vault.
servicePrincipalSecretNameInKV	The secret name of the service principal's client secret in the Key Vault.
tenantId	The tenant id of your service principal.
type	Service Principal in KeyVault DataSource Credential

Inherited Properties

description	Description of data source credential
id	Unique id of data source credential NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of data source credential

Property Details

keyVaultClientId

The Client Id to access the Key Vault.

keyVaultClientId: string

Property Value

string

keyVaultClientSecret

The Client Secret to access the Key Vault. Required by user for Create. Not returned by service.

keyVaultClientSecret?: string

Property Value

string

keyVaultEndpoint

The Key Vault endpoint that storing the service principal.

keyVaultEndpoint: string

Property Value

string

servicePrincipalIdNameInKV

The secret name of the service principal's client Id in the Key Vault.

servicePrincipalIdNameInKV: string

Property Value

string

servicePrincipalSecretNameInKV

The secret name of the service principal's client secret in the Key Vault.

servicePrincipalSecretNameInKV: string

Property Value

string

tenantId

The tenant id of your service principal.

tenantId: string

Property Value

string

type

Service Principal in KeyVault DataSource Credential

type: "ServicePrincipalInKV"

Property Value

"ServicePrincipalInKV"

Inherited Property Details

description

Description of data source credential

description?: string

Property Value

string

Inherited From DataSourceCredentialEntity.description

id

Unique id of data source credential NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From DataSourceCredentialEntity.id

name

Name of data source credential

name: string

Property Value

string

Inherited From DataSourceCredentialEntity.name