KeyVaultReference table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Contains data that refers to an Azure Key Vault containing credentials used to connect to secure web-hosted resources.

Added by: ManagedIdentityExtensions Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /keyvaultreferences(keyvaultreferenceid)
Update ownerid property.
AssignRequest
Create POST /keyvaultreferences
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /keyvaultreferences(keyvaultreferenceid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
Retrieve GET /keyvaultreferences(keyvaultreferenceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /keyvaultreferences
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
SetState PATCH /keyvaultreferences(keyvaultreferenceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /keyvaultreferences(keyvaultreferenceid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName KeyVaultReferences
DisplayCollectionName KeyVault References
DisplayName Key Vault Reference
EntitySetName keyvaultreferences
IsBPFEntity False
LogicalCollectionName keyvaultreferences
LogicalName keyvaultreference
OwnershipType UserOwned
PrimaryIdAttribute keyvaultreferenceid
PrimaryNameAttribute keyvaulturi
SchemaName KeyVaultReference

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber

Added by: Basic Solution Solution

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsCustomizable

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsValidated

Property Value
Description For internal use only.
DisplayName Is Validated
IsValidForForm True
IsValidForRead False
IsValidForUpdate False
LogicalName isvalidated
RequiredLevel None
Type Boolean

IsValidated Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

KeyName

Property Value
Description Name of the KeyVault Secret or Certificate
DisplayName Key Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName keyname
MaxLength 100
RequiredLevel None
Type String

KeyType

Property Value
Description The type of key to use.
DisplayName Key Type
IsValidForForm True
IsValidForRead True
LogicalName keytype
RequiredLevel SystemRequired
Type Picklist

KeyType Choices/Options

Value Label Description
0 Secret
1 Certificate
2 CertificateWithX5c

KeyVaultReferenceId

Property Value
Description Unique identifier for entity instances
DisplayName KeyVaultReference Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName keyvaultreferenceid
RequiredLevel SystemRequired
Type Uniqueidentifier

KeyVaultUri

Property Value
Description The Uri for the Key Vault.
DisplayName Key Vault Uri
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName keyvaulturi
MaxLength 100
RequiredLevel SystemRequired
Type String

ManagedIdentityId

Property Value
Description Unique identifier for managedidentity which if preauthorized for the keyvault.
DisplayName PreauthorizedManagedIdentityId
IsValidForForm True
IsValidForRead True
LogicalName managedidentityid
RequiredLevel None
Targets managedidentity
Type Lookup

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Added by: Active Solution Solution

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PreAuthorizedApplicationType

Property Value
Description The type of pre-authorized application.
DisplayName Pre-Authorized Application Type
IsValidForForm True
IsValidForRead True
LogicalName preauthorizedapplicationtype
RequiredLevel SystemRequired
Type Picklist

PreAuthorizedApplicationType Choices/Options

Value Label Description
0 MicrosoftDataverseFirstParty
1 Other

statecode

Property Value
Description Status of the Key Vault Reference
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Key Vault Reference
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ComponentIdUnique

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Choices/Options

Value Label Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

IsManaged

Added by: Basic Solution Solution

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

managedidentityidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName managedidentityidname
MaxLength 100
RequiredLevel None
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Added by: Basic Solution Solution

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel SystemRequired
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

SolutionId

Added by: Basic Solution Solution

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

keyvaultreference_SyncErrors

Added by: System Solution Solution

Same as the keyvaultreference_SyncErrors many-to-one relationship for the syncerror table/entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_DuplicateMatchingRecord

Added by: System Solution Solution

Same as the keyvaultreference_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_DuplicateBaseRecord

Added by: System Solution Solution

Same as the keyvaultreference_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_AsyncOperations

Added by: System Solution Solution

Same as the keyvaultreference_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_MailboxTrackingFolders

Added by: System Solution Solution

Same as the keyvaultreference_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_ProcessSession

Added by: System Solution Solution

Same as the keyvaultreference_ProcessSession many-to-one relationship for the processsession table/entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_BulkDeleteFailures

Added by: System Solution Solution

Same as the keyvaultreference_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the keyvaultreference_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName keyvaultreference_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_ManagedIdentity

Same as the keyvaultreference_ManagedIdentity many-to-one relationship for the managedidentity table/entity.

Property Value
ReferencingEntity managedidentity
ReferencingAttribute keyvaultreferenceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName keyvaultreference_ManagedIdentity
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_ServiceEndpoint

Added by: msft_ServiceEndpointExtensions Solution

Same as the keyvaultreference_ServiceEndpoint many-to-one relationship for the serviceendpoint table/entity.

Property Value
ReferencingEntity serviceendpoint
ReferencingAttribute keyvaultreferenceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName keyvaultreference_ServiceEndpoint
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

keyvaultreference_emailserverprofile_keyvaultreferenceid

Added by: msft_ServerSideSync_Extensions Solution

Same as the keyvaultreference_emailserverprofile_keyvaultreferenceid many-to-one relationship for the emailserverprofile table/entity.

Property Value
ReferencingEntity emailserverprofile
ReferencingAttribute keyvaultreferenceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName keyvaultreference_emailserverprofile_keyvaultreferenceid
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

lk_keyvaultreference_createdby

Added by: System Solution Solution

See the lk_keyvaultreference_createdby one-to-many relationship for the systemuser table/entity.

lk_keyvaultreference_createdonbehalfby

Added by: System Solution Solution

See the lk_keyvaultreference_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_keyvaultreference_modifiedby

Added by: System Solution Solution

See the lk_keyvaultreference_modifiedby one-to-many relationship for the systemuser table/entity.

lk_keyvaultreference_modifiedonbehalfby

Added by: System Solution Solution

See the lk_keyvaultreference_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

user_keyvaultreference

Added by: System Solution Solution

See the user_keyvaultreference one-to-many relationship for the systemuser table/entity.

team_keyvaultreference

Added by: System Solution Solution

See the team_keyvaultreference one-to-many relationship for the team table/entity.

business_unit_keyvaultreference

Added by: System Solution Solution

See the business_unit_keyvaultreference one-to-many relationship for the businessunit table/entity.

managedidentity_KeyVaultReference

See the managedidentity_KeyVaultReference one-to-many relationship for the managedidentity table/entity.

See also

Dataverse table/entity reference
Web API Reference
keyvaultreference EntityType