RetrieveDataEncryptionKeyRequest Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Messages

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to retrieve the data encryption key value.

public ref class RetrieveDataEncryptionKeyRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveDataEncryptionKeyRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type RetrieveDataEncryptionKeyRequest = class
    inherit OrganizationRequest

Public NotInheritable Class RetrieveDataEncryptionKeyRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RetrieveDataEncryptionKeyRequest

Attributes: DataContractAttribute

Examples

/// <summary>
/// Returns the Data encryption key value.
/// </summary>
/// <param name="service">Authenticated IOrganizationService instance</param>
/// <returns>The Data encryption key value.</returns>
static string RetrieveDataEncryptionKey(IOrganizationService service) {

    RetrieveDataEncryptionKeyRequest request = new();
    var response = (RetrieveDataEncryptionKeyResponse)service.Execute(request);

    return response.EncryptionKey;
}

Remarks

For the Web API use the RetrieveDataEncryptionKey function.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of RetrieveDataEncryptionKeyResponse.

Constructors

RetrieveDataEncryptionKeyRequest()

Initializes a new instance of the RetrieveDataEncryptionKeyRequest class.

Properties

ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
Item[String]	Gets or sets the indexer for the `Parameters` collection. (Inherited from OrganizationRequest)
Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
RequestId	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)

Applies to

Partager via