POST api/OfflineEnvironments

Creates a new offline environment.

Request Information

URI Parameters

None.

Body Parameters

Data to use for the new offline environment.

NewOfflineEnvironment
NameDescriptionTypeAdditional information
TpmSupported

Indicate whether the environment supports TPM hardware. Default is false.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "TpmSupported": true
}

Response Information

Resource Description

OfflineEnvironment
NameDescriptionTypeAdditional information
Id

The ID of the offline environment.

 globally unique identifier

Required
TpmSupported

Indicates if offline environment is for a TPM supported environment.

 boolean

Required
EncryptedMasterEncryptionKey

If TpmSupported is true, then this field is present and has a constant value of [EXPORTABLE] which indicates a master encryption key can be exported.

 string

None.
EncryptedMasterEncryptionIv

If TpmSupported is true, then this field is present and has a constant value of [EXPORTABLE] which indicates a master encryption IV can be exported.

 string

Required
EncryptedEncryptionKey

The encrypted offline environment encryption key.

 Collection of byte

Required
Created

The date when the offline environment was created (in the ISO 8601 format).

 date

Required

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • Created (201) - The offline environment is successfully added.
  • BadRequest (400) - The data for a new offline environment is invalid.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "3d3a1c61-b233-4982-96f3-cd39e80e0067",
  "TpmSupported": true,
  "EncryptedMasterEncryptionKey": "sample string 3",
  "EncryptedMasterEncryptionIv": "sample string 4",
  "EncryptedEncryptionKey": "QEA=",
  "Created": "2024-09-24T02:17:35.3882596+00:00"
}