keyvaultreference EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/keyvaultreferences
Base Type
crmbaseentity
Display Name
Key Vault Reference
Primary Key
keyvaultreferenceid
Primary Key Attribute
keyvaulturi
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
isvalidated Edm.Boolean

For internal use only.

Display Name: Is Validated

Default Options
Value Label
1 Yes
0 No
keyname Edm.String

Name of the KeyVault Secret or Certificate

Display Name: Key Name

keytype Edm.Int32

The type of key to use.

Display Name: Key Type

Default Options
Value Label
0 Secret
1 Certificate
2 CertificateWithX5c
keyvaultreferenceid Edm.Guid

Unique identifier for entity instances

Display Name: KeyVaultReference Id

keyvaulturi Edm.String

The Uri for the Key Vault.

Display Name: Key Vault Uri

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
preauthorizedapplicationtype Edm.Int32

The type of pre-authorized application.

Display Name: Pre-Authorized Application Type

Default Options
Value Label
0 MicrosoftDataverseFirstParty
1 Other
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Key Vault Reference

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Key Vault Reference

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_managedidentityid_value managedidentityid

Unique identifier for managedidentity which if preauthorized for the keyvault.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_keyvaultreference_createdby
createdonbehalfby systemuser lk_keyvaultreference_createdonbehalfby
managedidentityid managedidentity managedidentity_KeyVaultReference
modifiedby systemuser lk_keyvaultreference_modifiedby
modifiedonbehalfby systemuser lk_keyvaultreference_modifiedonbehalfby
ownerid principal owner_keyvaultreference
owningbusinessunit businessunit business_unit_keyvaultreference
owningteam team team_keyvaultreference
owninguser systemuser user_keyvaultreference

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
keyvaultreference_AsyncOperations asyncoperation regardingobjectid_keyvaultreference
keyvaultreference_BulkDeleteFailures bulkdeletefailure regardingobjectid_keyvaultreference
keyvaultreference_DuplicateBaseRecord duplicaterecord baserecordid_keyvaultreference
keyvaultreference_DuplicateMatchingRecord duplicaterecord duplicaterecordid_keyvaultreference
keyvaultreference_emailserverprofile_keyvaultreferenceid emailserverprofile keyvaultreferenceid
keyvaultreference_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_keyvaultreference
keyvaultreference_ManagedIdentity managedidentity keyvaultreferenceid
keyvaultreference_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_keyvaultreference
keyvaultreference_ProcessSession processsession regardingobjectid_keyvaultreference
keyvaultreference_ServiceEndpoint serviceendpoint keyvaultreferenceid
keyvaultreference_SyncErrors syncerror regardingobjectid_keyvaultreference

Operations

The following operations can be used with the keyvaultreference entity type.

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the keyvaultreference entity type.

Name Description
ManagedIdentityExtensions

See also