ServicePrincipalSecretAuthInfo interface

Package:

@azure/arm-servicelinker

The authentication info when authType is servicePrincipal secret

Extends

AuthInfoBase,DatabaseAadAuthInfo

Properties

authType	Polymorphic discriminator, which specifies the different types this object can be
clientId	ServicePrincipal application clientId for servicePrincipal auth.
deleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
principalId	Principal Id for servicePrincipal auth.
roles	Optional, this value specifies the Azure roles to be assigned. Automatically
secret	Secret for servicePrincipal auth.

Inherited Properties

authMode	Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.
userName	Username created in the database which is mapped to a user in AAD.

Property Details

authType

Polymorphic discriminator, which specifies the different types this object can be

authType: "servicePrincipalSecret"

Property Value

"servicePrincipalSecret"

clientId

ServicePrincipal application clientId for servicePrincipal auth.

clientId: string

Property Value

string

deleteOrUpdateBehavior

Indicates whether to clean up previous operation when Linker is updating or deleting

deleteOrUpdateBehavior?: string

Property Value

string

principalId

Principal Id for servicePrincipal auth.

principalId: string

Property Value

string

roles

Optional, this value specifies the Azure roles to be assigned. Automatically

roles?: string[]

Property Value

string[]

secret

Secret for servicePrincipal auth.

secret: string

Property Value

string

Inherited Property Details

authMode

Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.

authMode?: string

Property Value

string

Inherited From AuthInfoBase.authMode

userName

Username created in the database which is mapped to a user in AAD.

userName?: string

Property Value

string

Inherited From DatabaseAadAuthInfo.userName