Update Azure Storage Profile

Update Azure Storage Profile

Update Azure storage profile

Request
URI
PATCH
https://{api_host}/iaas/api/storage-profiles-azure/{id}
COPY
Path Parameters
string
id
Required

The ID of the storage profile.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body
StorageProfileAzureSpecification of type(s) application/json
Optional
{
    "name": "string",
    "description": "string",
    "defaultItem": true,
    "supportsEncryption": false,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "diskType": "Standard_LRS / Premium_LRS",
    "osDiskCaching": "None / ReadOnly / ReadWrite",
    "dataDiskCaching": "None / ReadOnly / ReadWrite",
    "storageAccountId": "aaa82",
    "regionId": "31186"
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

boolean
defaultItem
Optional

Indicates if a storage policy contains default storage properties.

boolean
supportsEncryption
Optional

Indicates whether this storage policy should support encryption or not.

array of Tag
tags
Optional

A set of tag keys and optional values for a storage policy which define set of specifications for creating a disk.

string
diskType
Optional

Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.

string
osDiskCaching
Optional

Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.

string
dataDiskCaching
Optional

Indicates the caching mechanism for additional disk.

string
storageAccountId
Optional

Id of a storage account where in the disk is placed.

string
regionId
Required

The If of the region that is associated with the storage profile.

Responses
200

successful operation

Returns AzureStorageProfile of type(s) application/json
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "defaultItem": false,
    "supportsEncryption": false,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "diskType": "Standard_LRS / Premium_LRS",
    "osDiskCaching": "None / ReadOnly / ReadWrite",
    "dataDiskCaching": "None / ReadOnly / ReadWrite",
    "externalRegionId": "uswest"
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

boolean
defaultItem
Required

Indicates if a storage profile contains default storage properties.

boolean
supportsEncryption
Optional

Indicates whether this storage profile should support encryption or not.

array of Tag
tags
Optional

A list of tags that represent the capabilities of this storage profile

string
diskType
Optional

Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.

string
osDiskCaching
Optional

Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.

string
dataDiskCaching
Optional

Indicates the caching mechanism for additional disk.

string
externalRegionId
Optional

The id of the region for which this profile is defined


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure