AssetPutProperties – Media API – MediaKind

AssetPutProperties

object

alternateId

stringOptional 0-64 characters

An alternate ID of the asset.

container

stringOptional 3-63 characters pattern: ^(?!.--)(?=[a-z0-9-]{3,63}$)(?!-)[a-z0-9]+(?:-[a-z0-9]+)$

The name of the container if this asset is stored in an Azure storage account.

containerDeletionPolicy

enumOptional

This field defines the deletion policy for the underlying storage. This determines the behavior when an asset record is deleted. There are two options, 'Delete', and 'Retain'.

A deletion policy of 'Delete' will result in the associated storage container or folder and all its contents being removed. A deletion policy of 'Retain' will leave the content in place. If left blank, the default behavior of the system will be to retain content.

Once set by the user, this value can be modified, but not un-set.

Allowed values: Delete, Retain

description

stringOptional 0-4096 characters

The Asset description.

encryptionScope

string or nullOptional

Accepted, not supported. The name of the encryption scope to use within your storage container. Errors may be cryptic.

storageAccountName

stringRequired 0-255 characters

The name of the storage in MK.IO.

storageEncryptionFormat

enumOptional

This field was deprecated in the v3 API. Accepted, not supported. Use an encryption scope instead.

Allowed values: None, Media, Storage, Client, Encryption

subPath

stringOptional 1-256 characters

pattern: ^(?!/)(?!.(//|\?|%|&)).[^/]$

Optional subpath for instances where your asset is not in the root of the container. This needs to be an absolute directory path and can't be an empty string or start with '.', './' or '/' or end with '/'.

Valid examples: 'path', 'path2', 'path/to/asset'