Microsoft.StorSimple (stable:2017-06-01)

2025/09/29 • 92 deleted methods

Operations_List (removed)
Description :  Lists all of the available REST API operations of the Microsoft.StorSimple provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorSimple/operations
{
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation being performed on a particular object. Name format: "{resourceProviderNamespace}/{resourceType}/{read|write|delete|action}". Eg. Microsoft.StorSimple/managers/devices/volumeContainers/read, Microsoft.StorSimple/managers/devices/alerts/clearAlerts/action ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation/action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with 'Microsoft' for 1st party services. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing - for examples, please refer to the 'name' section. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing and include the entity/resource to which it applies. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system" ,
Required: False ,
}
string ,
properties:
{
Description: Reserved for future use. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}
Managers_List (removed)
Description :  Retrieves all the managers in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorSimple/managers
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of StorSimple managers. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
,
]
,
}
Managers_ListByResourceGroup (removed)
Description :  Retrieves all the managers in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of StorSimple managers. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
,
]
,
}
Managers_Get (removed)
Description :  Returns the properties of the specified manager name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
Managers_CreateOrUpdate (removed)
Description :  Creates or updates the manager.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}
{
parameters:
{
Description: The manager. ,
Required: True ,
}
{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
Managers_Delete (removed)
Description :  Deletes the manager.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Managers_Update (removed)
Description :  Updates the StorSimple Manager.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}
{
parameters:
{
Description: The manager update parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags attached to the Manager. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the StorSimple Manager. ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Represents the type of StorSimple Manager. ,
Required: False ,
}
{
type:
{
Description: The type of StorSimple Manager. ,
Enum:
{
GardaV1: No description available. ,
HelsinkiV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
sku:
{
Description: Specifies the Sku. ,
Required: False ,
}
{
name:
{
Description: Refers to the sku name which should be "Standard" ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
provisioningState:
{
Description: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the manager. ,
Required: False ,
}
string ,
}
AccessControlRecords_ListByManager (removed)
Description :  Retrieves all the access control records in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/accessControlRecords
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of access control record. ,
Required: True ,
}
{
initiatorName:
{
Description: The iSCSI initiator name (IQN). ,
Required: True ,
}
string ,
volumeCount:
{
Description: The number of volumes using the access control record. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
AccessControlRecords_Get (removed)
Description :  Returns the properties of the specified access control record name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/accessControlRecords/{accessControlRecordName}
{
accessControlRecordName:
{
Description: Name of access control record to be fetched. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of access control record. ,
Required: True ,
}
{
initiatorName:
{
Description: The iSCSI initiator name (IQN). ,
Required: True ,
}
string ,
volumeCount:
{
Description: The number of volumes using the access control record. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
AccessControlRecords_CreateOrUpdate (removed)
Description :  Creates or Updates an access control record.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/accessControlRecords/{accessControlRecordName}
{
accessControlRecordName:
{
Description: The name of the access control record. ,
Required: True ,
}
string ,
parameters:
{
Description: The access control record to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of access control record. ,
Required: True ,
}
{
initiatorName:
{
Description: The iSCSI initiator name (IQN). ,
Required: True ,
}
string ,
volumeCount:
{
Description: The number of volumes using the access control record. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of access control record. ,
Required: True ,
}
{
initiatorName:
{
Description: The iSCSI initiator name (IQN). ,
Required: True ,
}
string ,
volumeCount:
{
Description: The number of volumes using the access control record. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}
AccessControlRecords_Delete (removed)
Description :  Deletes the access control record.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/accessControlRecords/{accessControlRecordName}
{
accessControlRecordName:
{
Description: The name of the access control record to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Alerts_ListByManager (removed)
Description :  Retrieves all the alerts in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/alerts
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the alert. ,
Required: True ,
}
{
title:
{
Description: The title of the alert ,
Required: True ,
}
string ,
scope:
{
Description: The scope of the alert ,
Enum:
{
Resource: No description available. ,
Device: No description available. ,
}
,
Required: True ,
}
enum ,
alertType:
{
Description: The type of the alert ,
Required: True ,
}
string ,
appearedAtTime:
{
Description: The UTC time at which the alert was raised ,
Format: date-time ,
Required: True ,
}
string ,
appearedAtSourceTime:
{
Description: The source time at which the alert was raised ,
Format: date-time ,
Required: True ,
}
string ,
clearedAtTime:
{
Description: The UTC time at which the alert was cleared ,
Format: date-time ,
Required: False ,
}
string ,
clearedAtSourceTime:
{
Description: The source time at which the alert was cleared ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source at which the alert was raised ,
Required: True ,
}
{
name:
{
Description: The name of the source ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the source ,
Required: False ,
}
string ,
alertSourceType:
{
Description: The source type of the alert ,
Enum:
{
Resource: No description available. ,
Device: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
recommendation:
{
Description: The recommended action for the issue raised in the alert ,
Required: False ,
}
string ,
resolutionReason:
{
Description: The reason for resolving the alert ,
Required: False ,
}
string ,
severity:
{
Description: The severity of the alert ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current status of the alert ,
Enum:
{
Active: No description available. ,
Cleared: No description available. ,
}
,
Required: True ,
}
enum ,
errorDetails:
{
Description: The details of the error for which the alert was raised ,
Required: False ,
}
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message ,
Required: False ,
}
string ,
occurences:
{
Description: The number of occurrences ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: More details about the alert ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI of the next page of alerts. ,
Required: False ,
}
string ,
}
BandwidthSettings_ListByManager (removed)
Description :  Retrieves all the bandwidth setting in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/bandwidthSettings
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the bandwidth setting. ,
Required: True ,
}
{
schedules:
{
Description: The schedules. ,
Required: True ,
}
[
{
start:
{
Description: The start time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
stop:
{
Description: The stop time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rateInMbps:
{
Description: The rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
volumeCount:
{
Description: The number of volumes that uses the bandwidth setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
BandwidthSettings_Get (removed)
Description :  Returns the properties of the specified bandwidth setting name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/bandwidthSettings/{bandwidthSettingName}
{
bandwidthSettingName:
{
Description: The name of bandwidth setting to be fetched. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth setting. ,
Required: True ,
}
{
schedules:
{
Description: The schedules. ,
Required: True ,
}
[
{
start:
{
Description: The start time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
stop:
{
Description: The stop time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rateInMbps:
{
Description: The rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
volumeCount:
{
Description: The number of volumes that uses the bandwidth setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
BandwidthSettings_CreateOrUpdate (removed)
Description :  Creates or updates the bandwidth setting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/bandwidthSettings/{bandwidthSettingName}
{
bandwidthSettingName:
{
Description: The bandwidth setting name. ,
Required: True ,
}
string ,
parameters:
{
Description: The bandwidth setting to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the bandwidth setting. ,
Required: True ,
}
{
schedules:
{
Description: The schedules. ,
Required: True ,
}
[
{
start:
{
Description: The start time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
stop:
{
Description: The stop time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rateInMbps:
{
Description: The rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
volumeCount:
{
Description: The number of volumes that uses the bandwidth setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the bandwidth setting. ,
Required: True ,
}
{
schedules:
{
Description: The schedules. ,
Required: True ,
}
[
{
start:
{
Description: The start time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
stop:
{
Description: The stop time of the schedule. ,
Required: True ,
}
{
hours:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minutes:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
seconds:
{
Description: The second. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rateInMbps:
{
Description: The rate in Mbps. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: The days of the week when this schedule is applicable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
volumeCount:
{
Description: The number of volumes that uses the bandwidth setting. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}
BandwidthSettings_Delete (removed)
Description :  Deletes the bandwidth setting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/bandwidthSettings/{bandwidthSettingName}
{
bandwidthSettingName:
{
Description: The name of the bandwidth setting. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Alerts_Clear (removed)
Description :  Clear the alerts.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/clearAlerts
{
parameters:
{
Description: The clear alert request. ,
Required: True ,
}
{
resolutionMessage:
{
Description: The resolution message while clearing the alert ,
Required: False ,
}
string ,
alerts:
{
Description: The list of alert IDs to be cleared ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
CloudAppliances_ListSupportedConfigurations (removed)
Description :  Lists supported cloud appliance models and supported configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/cloudApplianceConfigurations
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
modelNumber:
{
Description: The model number. ,
Required: True ,
}
string ,
cloudPlatform:
{
Description: The cloud platform. ,
Required: True ,
}
string ,
acsConfiguration:
{
Description: The ACS configuration. ,
Required: True ,
}
{
namespace:
{
Description: The namespace. ,
Required: True ,
}
string ,
realm:
{
Description: The realm. ,
Required: True ,
}
string ,
serviceUrl:
{
Description: The service URL. ,
Required: True ,
}
string ,
}
,
supportedStorageAccountTypes:
{
Description: The supported storage account types. ,
Required: True ,
}
[
string ,
]
,
supportedRegions:
{
Description: The supported regions. ,
Required: True ,
}
[
string ,
]
,
supportedVmTypes:
{
Description: The supported virtual machine types. ,
Required: True ,
}
[
string ,
]
,
supportedVmImages:
{
Description: The supported virtual machine images. ,
Required: True ,
}
[
{
name:
{
Description: The name. ,
Required: True ,
}
string ,
version:
{
Description: The version. ,
Required: True ,
}
string ,
offer:
{
Description: The offer. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Devices_Configure (removed)
Description :  Complete minimal setup before using the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice
{
parameters:
{
Description: The minimal properties to configure a device. ,
Required: True ,
}
{
properties:
{
Description: The properties of the configure device request. ,
Required: True ,
}
{
friendlyName:
{
Description: The friendly name for the device. ,
Required: True ,
}
string ,
currentDeviceName:
{
Description: The current name of the device. ,
Required: True ,
}
string ,
timeZone:
{
Description: The device time zone. For eg: "Pacific Standard Time" ,
Required: True ,
}
string ,
dnsSettings:
{
Description: The secondary DNS Settings of the device. ,
Required: False ,
}
{
secondaryDnsServers:
{
Description: The list of secondary DNS Server IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkInterfaceData0Settings:
{
Description: The 'Data 0' network interface card settings. ,
Required: False ,
}
{
controllerZeroIp:
{
Description: The controller 0's IPv4 address. ,
Required: False ,
}
string ,
controllerOneIp:
{
Description: The controller 1's IPv4 address. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Devices_ListByManager (removed)
Description :  Returns the list of devices for the specified manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the device or $expand=rolloverdetails to populate additional fields related to the service data encryption key rollover on device ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the StorSimple device. ,
Required: True ,
}
{
friendlyName:
{
Description: The friendly name of the device. ,
Required: True ,
}
string ,
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: True ,
}
string ,
culture:
{
Description: The language culture setting on the device. For eg: "en-US" ,
Required: True ,
}
string ,
deviceDescription:
{
Description: The device description. ,
Required: True ,
}
string ,
deviceSoftwareVersion:
{
Description: The version number of the software running on the device. ,
Required: True ,
}
string ,
friendlySoftwareName:
{
Description: The friendly name of the software running on the device. ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: The current configuration status of the device. ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
targetIqn:
{
Description: The target IQN. ,
Required: True ,
}
string ,
modelDescription:
{
Description: The device model. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the device. ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
Deactivated: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deactivating: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
}
,
Required: True ,
}
enum ,
serialNumber:
{
Description: The serial number. ,
Required: True ,
}
string ,
deviceType:
{
Description: The type of the device. ,
Enum:
{
Invalid: No description available. ,
Series8000VirtualAppliance: No description available. ,
Series8000PhysicalAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
activeController:
{
Description: The identifier of the active controller of the device. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
Controller0: No description available. ,
Controller1: No description available. ,
}
,
Required: True ,
}
enum ,
friendlySoftwareVersion:
{
Description: The device friendly software version. ,
Required: True ,
}
string ,
availableLocalStorageInBytes:
{
Description: The storage in bytes that is available locally on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
availableTieredStorageInBytes:
{
Description: The storage in bytes that is available on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedTieredStorageInBytes:
{
Description: The storage in bytes that has been provisioned on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: The storage in bytes used for locally pinned volumes on the device (including additional local reservation). ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedVolumeSizeInBytes:
{
Description: Total capacity in bytes of tiered and locally pinned volumes on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: The storage in bytes that is currently being used on the device, including both local and cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
totalTieredStorageInBytes:
{
Description: The total tiered storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
agentGroupVersion:
{
Description: The device agent group version. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaceCardCount:
{
Description: The number of network interface cards ,
Format: int32 ,
Required: False ,
}
integer ,
deviceLocation:
{
Description: The location of the virtual appliance. ,
Required: False ,
}
string ,
virtualMachineApiType:
{
Description: The virtual machine API type. ,
Enum:
{
Classic: No description available. ,
Arm: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The additional device details regarding the end point count and volume container count. ,
Required: False ,
}
{
endpointCount:
{
Description: The total number of endpoints that are currently on the device ( i.e. number of volumes). ,
Format: int32 ,
Required: False ,
}
integer ,
volumeContainerCount:
{
Description: The total number of volume containers on the device. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rolloverDetails:
{
Description: The additional device details for the service data encryption key rollover. ,
Required: False ,
}
{
authorizationEligibility:
{
Description: The eligibility status of device for service data encryption key rollover. ,
Enum:
{
InEligible: No description available. ,
Eligible: No description available. ,
}
,
Required: False ,
}
enum ,
authorizationStatus:
{
Description: The authorization status of the device for service data encryption key rollover. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
inEligibilityReason:
{
Description: The reason for inEligibility of device, in case it's not eligible for service data encryption key rollover. ,
Enum:
{
DeviceNotOnline: No description available. ,
NotSupportedAppliance: No description available. ,
RolloverPending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}
Devices_Get (removed)
Description :  Returns the properties of the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=details to populate additional fields related to the device or $expand=rolloverdetails to populate additional fields related to the service data encryption key rollover on device ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the StorSimple device. ,
Required: True ,
}
{
friendlyName:
{
Description: The friendly name of the device. ,
Required: True ,
}
string ,
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: True ,
}
string ,
culture:
{
Description: The language culture setting on the device. For eg: "en-US" ,
Required: True ,
}
string ,
deviceDescription:
{
Description: The device description. ,
Required: True ,
}
string ,
deviceSoftwareVersion:
{
Description: The version number of the software running on the device. ,
Required: True ,
}
string ,
friendlySoftwareName:
{
Description: The friendly name of the software running on the device. ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: The current configuration status of the device. ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
targetIqn:
{
Description: The target IQN. ,
Required: True ,
}
string ,
modelDescription:
{
Description: The device model. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the device. ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
Deactivated: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deactivating: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
}
,
Required: True ,
}
enum ,
serialNumber:
{
Description: The serial number. ,
Required: True ,
}
string ,
deviceType:
{
Description: The type of the device. ,
Enum:
{
Invalid: No description available. ,
Series8000VirtualAppliance: No description available. ,
Series8000PhysicalAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
activeController:
{
Description: The identifier of the active controller of the device. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
Controller0: No description available. ,
Controller1: No description available. ,
}
,
Required: True ,
}
enum ,
friendlySoftwareVersion:
{
Description: The device friendly software version. ,
Required: True ,
}
string ,
availableLocalStorageInBytes:
{
Description: The storage in bytes that is available locally on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
availableTieredStorageInBytes:
{
Description: The storage in bytes that is available on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedTieredStorageInBytes:
{
Description: The storage in bytes that has been provisioned on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: The storage in bytes used for locally pinned volumes on the device (including additional local reservation). ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedVolumeSizeInBytes:
{
Description: Total capacity in bytes of tiered and locally pinned volumes on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: The storage in bytes that is currently being used on the device, including both local and cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
totalTieredStorageInBytes:
{
Description: The total tiered storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
agentGroupVersion:
{
Description: The device agent group version. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaceCardCount:
{
Description: The number of network interface cards ,
Format: int32 ,
Required: False ,
}
integer ,
deviceLocation:
{
Description: The location of the virtual appliance. ,
Required: False ,
}
string ,
virtualMachineApiType:
{
Description: The virtual machine API type. ,
Enum:
{
Classic: No description available. ,
Arm: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The additional device details regarding the end point count and volume container count. ,
Required: False ,
}
{
endpointCount:
{
Description: The total number of endpoints that are currently on the device ( i.e. number of volumes). ,
Format: int32 ,
Required: False ,
}
integer ,
volumeContainerCount:
{
Description: The total number of volume containers on the device. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rolloverDetails:
{
Description: The additional device details for the service data encryption key rollover. ,
Required: False ,
}
{
authorizationEligibility:
{
Description: The eligibility status of device for service data encryption key rollover. ,
Enum:
{
InEligible: No description available. ,
Eligible: No description available. ,
}
,
Required: False ,
}
enum ,
authorizationStatus:
{
Description: The authorization status of the device for service data encryption key rollover. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
inEligibilityReason:
{
Description: The reason for inEligibility of device, in case it's not eligible for service data encryption key rollover. ,
Enum:
{
DeviceNotOnline: No description available. ,
NotSupportedAppliance: No description available. ,
RolloverPending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Devices_Delete (removed)
Description :  Deletes the device.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Devices_Update (removed)
Description :  Patches the device.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: Patch representation of the device. ,
Required: True ,
}
{
properties:
{
Description: The properties of the device patch. ,
Required: True ,
}
{
deviceDescription:
{
Description: Short description given for the device ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the StorSimple device. ,
Required: True ,
}
{
friendlyName:
{
Description: The friendly name of the device. ,
Required: True ,
}
string ,
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: True ,
}
string ,
culture:
{
Description: The language culture setting on the device. For eg: "en-US" ,
Required: True ,
}
string ,
deviceDescription:
{
Description: The device description. ,
Required: True ,
}
string ,
deviceSoftwareVersion:
{
Description: The version number of the software running on the device. ,
Required: True ,
}
string ,
friendlySoftwareName:
{
Description: The friendly name of the software running on the device. ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: The current configuration status of the device. ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
targetIqn:
{
Description: The target IQN. ,
Required: True ,
}
string ,
modelDescription:
{
Description: The device model. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the device. ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
Deactivated: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deactivating: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
}
,
Required: True ,
}
enum ,
serialNumber:
{
Description: The serial number. ,
Required: True ,
}
string ,
deviceType:
{
Description: The type of the device. ,
Enum:
{
Invalid: No description available. ,
Series8000VirtualAppliance: No description available. ,
Series8000PhysicalAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
activeController:
{
Description: The identifier of the active controller of the device. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
Controller0: No description available. ,
Controller1: No description available. ,
}
,
Required: True ,
}
enum ,
friendlySoftwareVersion:
{
Description: The device friendly software version. ,
Required: True ,
}
string ,
availableLocalStorageInBytes:
{
Description: The storage in bytes that is available locally on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
availableTieredStorageInBytes:
{
Description: The storage in bytes that is available on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedTieredStorageInBytes:
{
Description: The storage in bytes that has been provisioned on the device for tiered volumes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: The storage in bytes used for locally pinned volumes on the device (including additional local reservation). ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedVolumeSizeInBytes:
{
Description: Total capacity in bytes of tiered and locally pinned volumes on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: The storage in bytes that is currently being used on the device, including both local and cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
totalTieredStorageInBytes:
{
Description: The total tiered storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
agentGroupVersion:
{
Description: The device agent group version. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaceCardCount:
{
Description: The number of network interface cards ,
Format: int32 ,
Required: False ,
}
integer ,
deviceLocation:
{
Description: The location of the virtual appliance. ,
Required: False ,
}
string ,
virtualMachineApiType:
{
Description: The virtual machine API type. ,
Enum:
{
Classic: No description available. ,
Arm: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The additional device details regarding the end point count and volume container count. ,
Required: False ,
}
{
endpointCount:
{
Description: The total number of endpoints that are currently on the device ( i.e. number of volumes). ,
Format: int32 ,
Required: False ,
}
integer ,
volumeContainerCount:
{
Description: The total number of volume containers on the device. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rolloverDetails:
{
Description: The additional device details for the service data encryption key rollover. ,
Required: False ,
}
{
authorizationEligibility:
{
Description: The eligibility status of device for service data encryption key rollover. ,
Enum:
{
InEligible: No description available. ,
Eligible: No description available. ,
}
,
Required: False ,
}
enum ,
authorizationStatus:
{
Description: The authorization status of the device for service data encryption key rollover. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
inEligibilityReason:
{
Description: The reason for inEligibility of device, in case it's not eligible for service data encryption key rollover. ,
Enum:
{
DeviceNotOnline: No description available. ,
NotSupportedAppliance: No description available. ,
RolloverPending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
DeviceSettings_GetAlertSettings (removed)
Description :  Gets the alert settings of the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the alert notification settings. ,
Required: True ,
}
{
emailNotification:
{
Description: Indicates whether email notification enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: The alert notification culture. ,
Required: False ,
}
string ,
notificationToServiceOwners:
{
Description: The value indicating whether alert notification enabled for admin or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipientEmailList:
{
Description: The alert notification email list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceSettings_CreateOrUpdateAlertSettings (removed)
Description :  Creates or updates the alert settings of the specified device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: The alert settings to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the alert notification settings. ,
Required: True ,
}
{
emailNotification:
{
Description: Indicates whether email notification enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: The alert notification culture. ,
Required: False ,
}
string ,
notificationToServiceOwners:
{
Description: The value indicating whether alert notification enabled for admin or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipientEmailList:
{
Description: The alert notification email list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the alert notification settings. ,
Required: True ,
}
{
emailNotification:
{
Description: Indicates whether email notification enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: The alert notification culture. ,
Required: False ,
}
string ,
notificationToServiceOwners:
{
Description: The value indicating whether alert notification enabled for admin or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipientEmailList:
{
Description: The alert notification email list. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}
Devices_AuthorizeForServiceEncryptionKeyRollover (removed)
Description :  Authorizes the specified device for service data encryption key rollover.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/authorizeForServiceEncryptionKeyRollover
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
BackupPolicies_ListByDevice (removed)
Description :  Gets all the backup policies in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the backup policy. ,
Required: True ,
}
{
volumeIds:
{
Description: The path IDs of the volumes which are part of the backup policy. ,
Required: True ,
}
[
string ,
]
,
nextBackupTime:
{
Description: The time of the next backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: The time of the last backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
schedulesCount:
{
Description: The count of schedules the backup policy contains. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledBackupStatus:
{
Description: Indicates whether at least one of the schedules in the backup policy is active or not. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicyCreationType:
{
Description: The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. ,
Enum:
{
BySaaS: No description available. ,
BySSM: No description available. ,
}
,
Required: False ,
}
enum ,
ssmHostName:
{
Description: If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
BackupPolicies_Get (removed)
Description :  Gets the properties of the specified backup policy name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The name of backup policy to be fetched. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the backup policy. ,
Required: True ,
}
{
volumeIds:
{
Description: The path IDs of the volumes which are part of the backup policy. ,
Required: True ,
}
[
string ,
]
,
nextBackupTime:
{
Description: The time of the next backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: The time of the last backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
schedulesCount:
{
Description: The count of schedules the backup policy contains. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledBackupStatus:
{
Description: Indicates whether at least one of the schedules in the backup policy is active or not. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicyCreationType:
{
Description: The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. ,
Enum:
{
BySaaS: No description available. ,
BySSM: No description available. ,
}
,
Required: False ,
}
enum ,
ssmHostName:
{
Description: If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager. ,
Required: False ,
}
string ,
}
,
}
BackupPolicies_CreateOrUpdate (removed)
Description :  Creates or updates the backup policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The name of the backup policy to be created/updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The backup policy. ,
Required: True ,
}
{
properties:
{
Description: The properties of the backup policy. ,
Required: True ,
}
{
volumeIds:
{
Description: The path IDs of the volumes which are part of the backup policy. ,
Required: True ,
}
[
string ,
]
,
nextBackupTime:
{
Description: The time of the next backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: The time of the last backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
schedulesCount:
{
Description: The count of schedules the backup policy contains. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledBackupStatus:
{
Description: Indicates whether at least one of the schedules in the backup policy is active or not. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicyCreationType:
{
Description: The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. ,
Enum:
{
BySaaS: No description available. ,
BySSM: No description available. ,
}
,
Required: False ,
}
enum ,
ssmHostName:
{
Description: If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the backup policy. ,
Required: True ,
}
{
volumeIds:
{
Description: The path IDs of the volumes which are part of the backup policy. ,
Required: True ,
}
[
string ,
]
,
nextBackupTime:
{
Description: The time of the next backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: The time of the last backup for the backup policy. ,
Format: date-time ,
Required: False ,
}
string ,
schedulesCount:
{
Description: The count of schedules the backup policy contains. ,
Format: int64 ,
Required: False ,
}
integer ,
scheduledBackupStatus:
{
Description: Indicates whether at least one of the schedules in the backup policy is active or not. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicyCreationType:
{
Description: The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. ,
Enum:
{
BySaaS: No description available. ,
BySSM: No description available. ,
}
,
Required: False ,
}
enum ,
ssmHostName:
{
Description: If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
BackupPolicies_Delete (removed)
Description :  Deletes the backup policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The name of the backup policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupPolicies_BackupNow (removed)
Description :  Backup the backup policy now.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/backup
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The backup policy name. ,
Required: True ,
}
string ,
backupType:
{
Description: The backup Type. This can be cloudSnapshot or localSnapshot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupSchedules_ListByBackupPolicy (removed)
Description :  Gets all the backup schedules in a backup policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The backup policy name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the backup schedule. ,
Required: True ,
}
{
scheduleRecurrence:
{
Description: The schedule recurrence. ,
Required: True ,
}
{
recurrenceType:
{
Description: The recurrence type. ,
Enum:
{
Minutes: No description available. ,
Hourly: No description available. ,
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
recurrenceValue:
{
Description: The recurrence value. ,
Format: int32 ,
Required: True ,
}
integer ,
weeklyDaysList:
{
Description: The week days list. Applicable only for schedules of recurrence type 'weekly'. ,
Required: False ,
}
[
string ,
]
,
}
,
backupType:
{
Description: The type of backup which needs to be taken. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: True ,
}
enum ,
retentionCount:
{
Description: The number of backups to be retained. ,
Format: int64 ,
Required: True ,
}
integer ,
startTime:
{
Description: The start time of the schedule. ,
Format: date-time ,
Required: True ,
}
string ,
scheduleStatus:
{
Description: The schedule status. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
lastSuccessfulRun:
{
Description: The last successful backup run which was triggered for the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
BackupSchedules_Get (removed)
Description :  Gets the properties of the specified backup schedule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules/{backupScheduleName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The backup policy name. ,
Required: True ,
}
string ,
backupScheduleName:
{
Description: The name of the backup schedule to be fetched ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the backup schedule. ,
Required: True ,
}
{
scheduleRecurrence:
{
Description: The schedule recurrence. ,
Required: True ,
}
{
recurrenceType:
{
Description: The recurrence type. ,
Enum:
{
Minutes: No description available. ,
Hourly: No description available. ,
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
recurrenceValue:
{
Description: The recurrence value. ,
Format: int32 ,
Required: True ,
}
integer ,
weeklyDaysList:
{
Description: The week days list. Applicable only for schedules of recurrence type 'weekly'. ,
Required: False ,
}
[
string ,
]
,
}
,
backupType:
{
Description: The type of backup which needs to be taken. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: True ,
}
enum ,
retentionCount:
{
Description: The number of backups to be retained. ,
Format: int64 ,
Required: True ,
}
integer ,
startTime:
{
Description: The start time of the schedule. ,
Format: date-time ,
Required: True ,
}
string ,
scheduleStatus:
{
Description: The schedule status. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
lastSuccessfulRun:
{
Description: The last successful backup run which was triggered for the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
BackupSchedules_CreateOrUpdate (removed)
Description :  Creates or updates the backup schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules/{backupScheduleName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The backup policy name. ,
Required: True ,
}
string ,
backupScheduleName:
{
Description: The backup schedule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The backup schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the backup schedule. ,
Required: True ,
}
{
scheduleRecurrence:
{
Description: The schedule recurrence. ,
Required: True ,
}
{
recurrenceType:
{
Description: The recurrence type. ,
Enum:
{
Minutes: No description available. ,
Hourly: No description available. ,
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
recurrenceValue:
{
Description: The recurrence value. ,
Format: int32 ,
Required: True ,
}
integer ,
weeklyDaysList:
{
Description: The week days list. Applicable only for schedules of recurrence type 'weekly'. ,
Required: False ,
}
[
string ,
]
,
}
,
backupType:
{
Description: The type of backup which needs to be taken. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: True ,
}
enum ,
retentionCount:
{
Description: The number of backups to be retained. ,
Format: int64 ,
Required: True ,
}
integer ,
startTime:
{
Description: The start time of the schedule. ,
Format: date-time ,
Required: True ,
}
string ,
scheduleStatus:
{
Description: The schedule status. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
lastSuccessfulRun:
{
Description: The last successful backup run which was triggered for the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the backup schedule. ,
Required: True ,
}
{
scheduleRecurrence:
{
Description: The schedule recurrence. ,
Required: True ,
}
{
recurrenceType:
{
Description: The recurrence type. ,
Enum:
{
Minutes: No description available. ,
Hourly: No description available. ,
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
recurrenceValue:
{
Description: The recurrence value. ,
Format: int32 ,
Required: True ,
}
integer ,
weeklyDaysList:
{
Description: The week days list. Applicable only for schedules of recurrence type 'weekly'. ,
Required: False ,
}
[
string ,
]
,
}
,
backupType:
{
Description: The type of backup which needs to be taken. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: True ,
}
enum ,
retentionCount:
{
Description: The number of backups to be retained. ,
Format: int64 ,
Required: True ,
}
integer ,
startTime:
{
Description: The start time of the schedule. ,
Format: date-time ,
Required: True ,
}
string ,
scheduleStatus:
{
Description: The schedule status. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
lastSuccessfulRun:
{
Description: The last successful backup run which was triggered for the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
BackupSchedules_Delete (removed)
Description :  Deletes the backup schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules/{backupScheduleName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupPolicyName:
{
Description: The backup policy name. ,
Required: True ,
}
string ,
backupScheduleName:
{
Description: The name the backup schedule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Backups_ListByDevice (removed)
Description :  Retrieves all the backups in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the backup. ,
Required: True ,
}
{
createdOn:
{
Description: The time when the backup was created. ,
Format: date-time ,
Required: True ,
}
string ,
sizeInBytes:
{
Description: The backup size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
backupType:
{
Description: The type of the backup. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: False ,
}
enum ,
backupJobCreationType:
{
Description: The backup job creation type. ,
Enum:
{
Adhoc: No description available. ,
BySchedule: No description available. ,
BySSM: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicyId:
{
Description: The path ID of the backup policy. ,
Required: False ,
}
string ,
ssmHostName:
{
Description: The StorSimple Snapshot Manager host name. ,
Required: False ,
}
string ,
elements:
{
Description: The backup elements. ,
Required: True ,
}
[
{
elementId:
{
Description: The path ID that uniquely identifies the backup element. ,
Required: True ,
}
string ,
elementName:
{
Description: The name of the backup element. ,
Required: True ,
}
string ,
elementType:
{
Description: The hierarchical type of the backup element. ,
Required: True ,
}
string ,
sizeInBytes:
{
Description: The size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
volumeContainerId:
{
Description: The path ID of the volume container. ,
Required: True ,
}
string ,
volumeType:
{
Description: The volume type. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}
Backups_Delete (removed)
Description :  Deletes the backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups/{backupName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Backups_Clone (removed)
Description :  Clones the backup element as a new volume.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups/{backupName}/elements/{backupElementName}/clone
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
backupElementName:
{
Description: The backup element name. ,
Required: True ,
}
string ,
parameters:
{
Description: The clone request object. ,
Required: True ,
}
{
targetDeviceId:
{
Description: The path ID of the device which will act as the clone target. ,
Required: True ,
}
string ,
targetVolumeName:
{
Description: The name of the new volume which will be created and the backup will be cloned into. ,
Required: True ,
}
string ,
targetAccessControlRecordIds:
{
Description: The list of path IDs of the access control records to be associated to the new cloned volume. ,
Required: True ,
}
[
string ,
]
,
backupElement:
{
Description: The backup element that is cloned. ,
Required: True ,
}
{
elementId:
{
Description: The path ID that uniquely identifies the backup element. ,
Required: True ,
}
string ,
elementName:
{
Description: The name of the backup element. ,
Required: True ,
}
string ,
elementType:
{
Description: The hierarchical type of the backup element. ,
Required: True ,
}
string ,
sizeInBytes:
{
Description: The size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
volumeContainerId:
{
Description: The path ID of the volume container. ,
Required: True ,
}
string ,
volumeType:
{
Description: The volume type. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Backups_Restore (removed)
Description :  Restores the backup on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups/{backupName}/restore
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
backupName:
{
Description: The backupSet name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Devices_Deactivate (removed)
Description :  Deactivates the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
HardwareComponentGroups_ListByDevice (removed)
Description :  Lists the hardware component groups at device-level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/hardwareComponentGroups
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the hardware component group. ,
Required: True ,
}
{
displayName:
{
Description: The display name the hardware component group. ,
Required: True ,
}
string ,
lastUpdatedTime:
{
Description: The last updated time. ,
Format: date-time ,
Required: True ,
}
string ,
components:
{
Description: The list of hardware components. ,
Required: True ,
}
[
{
componentId:
{
Description: The component ID. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the hardware component. ,
Required: True ,
}
string ,
status:
{
Description: The status of the hardware component. ,
Enum:
{
Unknown: No description available. ,
NotPresent: No description available. ,
PoweredOff: No description available. ,
Ok: No description available. ,
Recovering: No description available. ,
Warning: No description available. ,
Failure: No description available. ,
}
,
Required: True ,
}
enum ,
statusDisplayName:
{
Description: The display name of the status of hardware component. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
HardwareComponentGroups_ChangeControllerPowerState (removed)
Description :  Changes the power state of the controller.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/hardwareComponentGroups/{hardwareComponentGroupName}/changeControllerPowerState
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
hardwareComponentGroupName:
{
Description: The hardware component group name. ,
Required: True ,
}
string ,
parameters:
{
Description: The controller power state change request. ,
Required: True ,
}
{
properties:
{
Description: The properties of the controller power state change request. ,
Required: True ,
}
{
action:
{
Description: The power state that the request is expecting for the controller of the device. ,
Enum:
{
Start: No description available. ,
Restart: No description available. ,
Shutdown: No description available. ,
}
,
Required: True ,
}
enum ,
activeController:
{
Description: The active controller that the request is expecting on the device. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
Controller0: No description available. ,
Controller1: No description available. ,
}
,
Required: True ,
}
enum ,
controller0State:
{
Description: The controller 0's status that the request is expecting on the device. ,
Enum:
{
NotPresent: No description available. ,
PoweredOff: No description available. ,
Ok: No description available. ,
Recovering: No description available. ,
Warning: No description available. ,
Failure: No description available. ,
}
,
Required: True ,
}
enum ,
controller1State:
{
Description: The controller 1's status that the request is expecting on the device. ,
Enum:
{
NotPresent: No description available. ,
PoweredOff: No description available. ,
Ok: No description available. ,
Recovering: No description available. ,
Warning: No description available. ,
Failure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Devices_InstallUpdates (removed)
Description :  Downloads and installs the updates on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/installUpdates
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_ListByDevice (removed)
Description :  Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
status:
{
Description: The current status of the job. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: The UTC time at which the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is already complete. ,
Format: int32 ,
Required: True ,
}
integer ,
error:
{
Description: The error details, if any, for the job. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
ScheduledBackup: No description available. ,
ManualBackup: No description available. ,
RestoreBackup: No description available. ,
CloneVolume: No description available. ,
FailoverVolumeContainers: No description available. ,
CreateLocallyPinnedVolume: No description available. ,
ModifyVolume: No description available. ,
InstallUpdates: No description available. ,
SupportPackageLogs: No description available. ,
CreateCloudAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
dataStats:
{
Description: The data statistics properties of the job. ,
Required: False ,
}
{
totalData:
{
Description: The total bytes of data to be processed, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
processedData:
{
Description: The number of bytes of data processed till now, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
cloudData:
{
Description: The number of bytes of data written to cloud, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The average throughput of data processed(bytes/sec), as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
entityLabel:
{
Description: The entity identifier for which the job ran. ,
Required: False ,
}
string ,
entityType:
{
Description: The entity type for which the job ran. ,
Required: False ,
}
string ,
jobStages:
{
Description: The job stages. ,
Required: False ,
}
[
{
message:
{
Description: The message of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: The stage status. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
detail:
{
Description: The details of the stage. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code of the stage if any. ,
Required: False ,
}
string ,
}
,
]
,
deviceId:
{
Description: The device ID in which the job ran. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
backupType:
{
Description: The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device ID of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}
Jobs_Get (removed)
Description :  Gets the details of the specified job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
jobName:
{
Description: The job Name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The current status of the job. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: The UTC time at which the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is already complete. ,
Format: int32 ,
Required: True ,
}
integer ,
error:
{
Description: The error details, if any, for the job. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
ScheduledBackup: No description available. ,
ManualBackup: No description available. ,
RestoreBackup: No description available. ,
CloneVolume: No description available. ,
FailoverVolumeContainers: No description available. ,
CreateLocallyPinnedVolume: No description available. ,
ModifyVolume: No description available. ,
InstallUpdates: No description available. ,
SupportPackageLogs: No description available. ,
CreateCloudAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
dataStats:
{
Description: The data statistics properties of the job. ,
Required: False ,
}
{
totalData:
{
Description: The total bytes of data to be processed, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
processedData:
{
Description: The number of bytes of data processed till now, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
cloudData:
{
Description: The number of bytes of data written to cloud, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The average throughput of data processed(bytes/sec), as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
entityLabel:
{
Description: The entity identifier for which the job ran. ,
Required: False ,
}
string ,
entityType:
{
Description: The entity type for which the job ran. ,
Required: False ,
}
string ,
jobStages:
{
Description: The job stages. ,
Required: False ,
}
[
{
message:
{
Description: The message of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: The stage status. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
detail:
{
Description: The details of the stage. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code of the stage if any. ,
Required: False ,
}
string ,
}
,
]
,
deviceId:
{
Description: The device ID in which the job ran. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
backupType:
{
Description: The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device ID of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Jobs_Cancel (removed)
Description :  Cancels a job on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}/cancel
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
jobName:
{
Description: The jobName. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Devices_ListFailoverSets (removed)
Description :  Returns all failover sets for a given device and their eligibility for participating in a failover. A failover set refers to a set of volume containers that need to be failed-over as a single unit to maintain data integrity.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of failover sets. ,
Required: False ,
}
[
{
volumeContainers:
{
Description: The list of meta data of volume containers, which are part of the failover set. ,
Required: False ,
}
[
{
volumeContainerId:
{
Description: The path ID of the volume container. ,
Required: False ,
}
string ,
volumes:
{
Description: The list of metadata of volumes inside the volume container, which contains valid cloud snapshots. ,
Required: False ,
}
[
{
volumeId:
{
Description: The path ID of the volume. ,
Required: False ,
}
string ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: The size of the volume in bytes at the time the snapshot was taken. ,
Format: int64 ,
Required: False ,
}
integer ,
backupCreatedDate:
{
Description: The date at which the snapshot was taken. ,
Format: date-time ,
Required: False ,
}
string ,
backupElementId:
{
Description: The path ID of the backup-element for this volume, inside the backup set. ,
Required: False ,
}
string ,
backupId:
{
Description: The path ID of the backup set. ,
Required: False ,
}
string ,
backupPolicyId:
{
Description: The path ID of the backup policy using which the snapshot was taken. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
eligibilityResult:
{
Description: The eligibility result of the failover set, for failover. ,
Required: False ,
}
{
isEligibleForFailover:
{
Description: Represents if this failover set is eligible for failover or not. ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: The error message, if the failover set is not eligible for failover. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Devices_ListMetrics (removed)
Description :  Gets the metrics for the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ID of metric source. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time granularity of the metric data. ,
Required: False ,
}
string ,
primaryAggregation:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
unit:
{
Description: The unit of the metric data. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the metric data. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric data. ,
Required: False ,
}
[
{
timeStamp:
{
Description: The time stamp of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
count:
{
Description: The count of all samples at the time stamp. ,
Format: int32 ,
Required: False ,
}
integer ,
average:
{
Description: The average of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The minimum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The maximum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Devices_ListMetricDefinition (removed)
Description :  Gets the metric definitions for the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The metric unit. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
primaryAggregationType:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The metric source ID. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The aggregation interval for the metric. ,
Required: False ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: The available metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the metric. ,
Required: False ,
}
string ,
type:
{
Description: The metric definition type. ,
Required: False ,
}
string ,
}
,
]
,
}
DeviceSettings_GetNetworkSettings (removed)
Description :  Gets the network settings of the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of network settings of a device. ,
Required: True ,
}
{
dnsSettings:
{
Description: The DNS (Domain Name System) settings of device. ,
Required: True ,
}
{
primaryDnsServer:
{
Description: The primary IPv4 DNS server for the device ,
Required: False ,
}
string ,
primaryIpv6DnsServer:
{
Description: The primary IPv6 DNS server for the device ,
Required: False ,
}
string ,
secondaryDnsServers:
{
Description: The secondary IPv4 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
secondaryIpv6DnsServers:
{
Description: The secondary IPv6 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
}
,
networkAdapters:
{
Description: The network adapter list of device. ,
Required: True ,
}
{
value:
{
Description: The value. ,
Required: True ,
}
[
{
interfaceId:
{
Description: The ID of the network adapter. ,
Enum:
{
Invalid: No description available. ,
Data0: No description available. ,
Data1: No description available. ,
Data2: No description available. ,
Data3: No description available. ,
Data4: No description available. ,
Data5: No description available. ,
}
,
Required: True ,
}
enum ,
netInterfaceStatus:
{
Description: Value indicating status of network adapter. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Value indicating whether this instance is default. ,
Required: False ,
}
boolean ,
iscsiAndCloudStatus:
{
Description: Value indicating cloud and ISCSI status of network adapter. ,
Enum:
{
Disabled: No description available. ,
IscsiEnabled: No description available. ,
CloudEnabled: No description available. ,
IscsiAndCloudEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
speed:
{
Description: The speed of the network adapter. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of network adapter, either IPv4, IPv6 or both. ,
Enum:
{
Invalid: No description available. ,
IPV4: No description available. ,
IPV6: No description available. ,
BOTH: No description available. ,
}
,
Required: True ,
}
enum ,
nicIpv4Settings:
{
Description: The IPv4 configuration of the network adapter. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address of the network adapter. ,
Required: False ,
}
string ,
ipv4Netmask:
{
Description: The IPv4 netmask of the network adapter. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The IPv4 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv4Address:
{
Description: The IPv4 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv4Address:
{
Description: The IPv4 address of Controller1. ,
Required: False ,
}
string ,
}
,
nicIpv6Settings:
{
Description: The IPv6 configuration of the network adapter. ,
Required: False ,
}
{
ipv6Address:
{
Description: The IPv6 address of the network adapter. ,
Required: False ,
}
string ,
ipv6Prefix:
{
Description: The IPv6 prefix of the network adapter. ,
Required: False ,
}
string ,
ipv6Gateway:
{
Description: The IPv6 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv6Address:
{
Description: The IPv6 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv6Address:
{
Description: The IPv6 address of Controller1. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
webproxySettings:
{
Description: The webproxy settings of device. ,
Required: True ,
}
{
connectionUri:
{
Description: The connection URI. ,
Required: False ,
}
string ,
authentication:
{
Description: The authentication type. ,
Enum:
{
Invalid: No description available. ,
None: No description available. ,
Basic: No description available. ,
NTLM: No description available. ,
}
,
Required: True ,
}
enum ,
username:
{
Description: The webproxy username. ,
Required: True ,
}
string ,
}
,
}
,
}
DeviceSettings_UpdateNetworkSettings (removed)
Description :  Updates the network settings on the specified device.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: The network settings to be updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the network settings patch. ,
Required: True ,
}
{
dnsSettings:
{
Description: The DNS (Domain Name System) settings of device. ,
Required: False ,
}
{
primaryDnsServer:
{
Description: The primary IPv4 DNS server for the device ,
Required: False ,
}
string ,
primaryIpv6DnsServer:
{
Description: The primary IPv6 DNS server for the device ,
Required: False ,
}
string ,
secondaryDnsServers:
{
Description: The secondary IPv4 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
secondaryIpv6DnsServers:
{
Description: The secondary IPv6 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
}
,
networkAdapters:
{
Description: The network adapter list of device. ,
Required: False ,
}
{
value:
{
Description: The value. ,
Required: True ,
}
[
{
interfaceId:
{
Description: The ID of the network adapter. ,
Enum:
{
Invalid: No description available. ,
Data0: No description available. ,
Data1: No description available. ,
Data2: No description available. ,
Data3: No description available. ,
Data4: No description available. ,
Data5: No description available. ,
}
,
Required: True ,
}
enum ,
netInterfaceStatus:
{
Description: Value indicating status of network adapter. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Value indicating whether this instance is default. ,
Required: False ,
}
boolean ,
iscsiAndCloudStatus:
{
Description: Value indicating cloud and ISCSI status of network adapter. ,
Enum:
{
Disabled: No description available. ,
IscsiEnabled: No description available. ,
CloudEnabled: No description available. ,
IscsiAndCloudEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
speed:
{
Description: The speed of the network adapter. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of network adapter, either IPv4, IPv6 or both. ,
Enum:
{
Invalid: No description available. ,
IPV4: No description available. ,
IPV6: No description available. ,
BOTH: No description available. ,
}
,
Required: True ,
}
enum ,
nicIpv4Settings:
{
Description: The IPv4 configuration of the network adapter. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address of the network adapter. ,
Required: False ,
}
string ,
ipv4Netmask:
{
Description: The IPv4 netmask of the network adapter. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The IPv4 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv4Address:
{
Description: The IPv4 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv4Address:
{
Description: The IPv4 address of Controller1. ,
Required: False ,
}
string ,
}
,
nicIpv6Settings:
{
Description: The IPv6 configuration of the network adapter. ,
Required: False ,
}
{
ipv6Address:
{
Description: The IPv6 address of the network adapter. ,
Required: False ,
}
string ,
ipv6Prefix:
{
Description: The IPv6 prefix of the network adapter. ,
Required: False ,
}
string ,
ipv6Gateway:
{
Description: The IPv6 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv6Address:
{
Description: The IPv6 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv6Address:
{
Description: The IPv6 address of Controller1. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of network settings of a device. ,
Required: True ,
}
{
dnsSettings:
{
Description: The DNS (Domain Name System) settings of device. ,
Required: True ,
}
{
primaryDnsServer:
{
Description: The primary IPv4 DNS server for the device ,
Required: False ,
}
string ,
primaryIpv6DnsServer:
{
Description: The primary IPv6 DNS server for the device ,
Required: False ,
}
string ,
secondaryDnsServers:
{
Description: The secondary IPv4 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
secondaryIpv6DnsServers:
{
Description: The secondary IPv6 DNS server for the device ,
Required: False ,
}
[
string ,
]
,
}
,
networkAdapters:
{
Description: The network adapter list of device. ,
Required: True ,
}
{
value:
{
Description: The value. ,
Required: True ,
}
[
{
interfaceId:
{
Description: The ID of the network adapter. ,
Enum:
{
Invalid: No description available. ,
Data0: No description available. ,
Data1: No description available. ,
Data2: No description available. ,
Data3: No description available. ,
Data4: No description available. ,
Data5: No description available. ,
}
,
Required: True ,
}
enum ,
netInterfaceStatus:
{
Description: Value indicating status of network adapter. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Value indicating whether this instance is default. ,
Required: False ,
}
boolean ,
iscsiAndCloudStatus:
{
Description: Value indicating cloud and ISCSI status of network adapter. ,
Enum:
{
Disabled: No description available. ,
IscsiEnabled: No description available. ,
CloudEnabled: No description available. ,
IscsiAndCloudEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
speed:
{
Description: The speed of the network adapter. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of network adapter, either IPv4, IPv6 or both. ,
Enum:
{
Invalid: No description available. ,
IPV4: No description available. ,
IPV6: No description available. ,
BOTH: No description available. ,
}
,
Required: True ,
}
enum ,
nicIpv4Settings:
{
Description: The IPv4 configuration of the network adapter. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address of the network adapter. ,
Required: False ,
}
string ,
ipv4Netmask:
{
Description: The IPv4 netmask of the network adapter. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The IPv4 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv4Address:
{
Description: The IPv4 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv4Address:
{
Description: The IPv4 address of Controller1. ,
Required: False ,
}
string ,
}
,
nicIpv6Settings:
{
Description: The IPv6 configuration of the network adapter. ,
Required: False ,
}
{
ipv6Address:
{
Description: The IPv6 address of the network adapter. ,
Required: False ,
}
string ,
ipv6Prefix:
{
Description: The IPv6 prefix of the network adapter. ,
Required: False ,
}
string ,
ipv6Gateway:
{
Description: The IPv6 gateway of the network adapter. ,
Required: False ,
}
string ,
controller0Ipv6Address:
{
Description: The IPv6 address of Controller0. ,
Required: False ,
}
string ,
controller1Ipv6Address:
{
Description: The IPv6 address of Controller1. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
webproxySettings:
{
Description: The webproxy settings of device. ,
Required: True ,
}
{
connectionUri:
{
Description: The connection URI. ,
Required: False ,
}
string ,
authentication:
{
Description: The authentication type. ,
Enum:
{
Invalid: No description available. ,
None: No description available. ,
Basic: No description available. ,
NTLM: No description available. ,
}
,
Required: True ,
}
enum ,
username:
{
Description: The webproxy username. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
Managers_GetDevicePublicEncryptionKey (removed)
Description :  Returns the public encryption key of the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/publicEncryptionKey
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key:
{
Description: The key. ,
Required: True ,
}
string ,
}
Devices_ScanForUpdates (removed)
Description :  Scans for updates on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/scanForUpdates
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DeviceSettings_GetSecuritySettings (removed)
Description :  Returns the Security properties of the specified device name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the security settings of a device. ,
Required: True ,
}
{
remoteManagementSettings:
{
Description: The settings for remote management of a device. ,
Required: True ,
}
{
remoteManagementMode:
{
Description: The remote management mode. ,
Enum:
{
Unknown: No description available. ,
Disabled: No description available. ,
HttpsEnabled: No description available. ,
HttpsAndHttpEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
remoteManagementCertificate:
{
Description: The remote management certificates. ,
Required: False ,
}
string ,
}
,
chapSettings:
{
Description: The Challenge-Handshake Authentication Protocol (CHAP) settings. ,
Required: True ,
}
{
initiatorUser:
{
Description: The CHAP initiator user. ,
Required: False ,
}
string ,
initiatorSecret:
{
Description: The CHAP initiator secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
targetUser:
{
Description: The CHAP target user. ,
Required: False ,
}
string ,
targetSecret:
{
Description: The target secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}
DeviceSettings_UpdateSecuritySettings (removed)
Description :  Patch Security properties of the specified device name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: The security settings properties to be patched. ,
Required: True ,
}
{
properties:
{
Description: The properties of the security settings patch. ,
Required: True ,
}
{
remoteManagementSettings:
{
Description: The remote management settings. ,
Required: False ,
}
{
remoteManagementMode:
{
Description: The remote management mode. ,
Enum:
{
Unknown: No description available. ,
Disabled: No description available. ,
HttpsEnabled: No description available. ,
HttpsAndHttpEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deviceAdminPassword:
{
Description: The device administrator password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
snapshotPassword:
{
Description: The snapshot manager password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
chapSettings:
{
Description: The device CHAP and reverse-CHAP settings. ,
Required: False ,
}
{
initiatorUser:
{
Description: The CHAP initiator user. ,
Required: False ,
}
string ,
initiatorSecret:
{
Description: The CHAP initiator secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
targetUser:
{
Description: The CHAP target user. ,
Required: False ,
}
string ,
targetSecret:
{
Description: The target secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
cloudApplianceSettings:
{
Description: The cloud appliance settings. ,
Required: False ,
}
{
serviceDataEncryptionKey:
{
Description: The service data encryption key (encrypted with DAK). ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
channelIntegrityKey:
{
Description: The channel integrity key (encrypted with DAK). ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the security settings of a device. ,
Required: True ,
}
{
remoteManagementSettings:
{
Description: The settings for remote management of a device. ,
Required: True ,
}
{
remoteManagementMode:
{
Description: The remote management mode. ,
Enum:
{
Unknown: No description available. ,
Disabled: No description available. ,
HttpsEnabled: No description available. ,
HttpsAndHttpEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
remoteManagementCertificate:
{
Description: The remote management certificates. ,
Required: False ,
}
string ,
}
,
chapSettings:
{
Description: The Challenge-Handshake Authentication Protocol (CHAP) settings. ,
Required: True ,
}
{
initiatorUser:
{
Description: The CHAP initiator user. ,
Required: False ,
}
string ,
initiatorSecret:
{
Description: The CHAP initiator secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
targetUser:
{
Description: The CHAP target user. ,
Required: False ,
}
string ,
targetSecret:
{
Description: The target secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{}
DeviceSettings_SyncRemotemanagementCertificate (removed)
Description :  sync Remote management Certificate between appliance and Service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/syncRemoteManagementCertificate
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Alerts_SendTestEmail (removed)
Description :  Sends a test alert email.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/sendTestAlertEmail
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: The send test alert email request. ,
Required: True ,
}
{
emailList:
{
Description: The list of email IDs to send the test alert email ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
DeviceSettings_GetTimeSettings (removed)
Description :  Gets the time settings of the specified device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the time settings of a device. ,
Required: True ,
}
{
timeZone:
{
Description: The timezone of device, like '(UTC -06:00) Central America' ,
Required: True ,
}
string ,
primaryTimeServer:
{
Description: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'. ,
Required: False ,
}
string ,
secondaryTimeServer:
{
Description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeviceSettings_CreateOrUpdateTimeSettings (removed)
Description :  Creates or updates the time settings of the specified device.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
parameters:
{
Description: The time settings to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the time settings of a device. ,
Required: True ,
}
{
timeZone:
{
Description: The timezone of device, like '(UTC -06:00) Central America' ,
Required: True ,
}
string ,
primaryTimeServer:
{
Description: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'. ,
Required: False ,
}
string ,
secondaryTimeServer:
{
Description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the time settings of a device. ,
Required: True ,
}
{
timeZone:
{
Description: The timezone of device, like '(UTC -06:00) Central America' ,
Required: True ,
}
string ,
primaryTimeServer:
{
Description: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'. ,
Required: False ,
}
string ,
secondaryTimeServer:
{
Description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}
Devices_GetUpdateSummary (removed)
Description :  Returns the update summary of the specified device name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/updateSummary/default
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the updates profile. ,
Required: True ,
}
{
regularUpdatesAvailable:
{
Description: Set to 'true' if regular updates are available for the device. ,
Required: False ,
}
boolean ,
maintenanceModeUpdatesAvailable:
{
Description: Set to 'true' if maintenance mode update available. ,
Required: False ,
}
boolean ,
isUpdateInProgress:
{
Description: Indicates whether an update is in progress or not. ,
Required: False ,
}
boolean ,
lastUpdatedTime:
{
Description: The time when the last update was completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
VolumeContainers_ListByDevice (removed)
Description :  Gets all the volume containers in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The volume container properties. ,
Required: True ,
}
{
encryptionKey:
{
Description: The key used to encrypt data in the volume container. It is required when property 'EncryptionStatus' is "Enabled". ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionStatus:
{
Description: The flag to denote whether encryption is enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
volumeCount:
{
Description: The number of volumes in the volume Container. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountCredentialId:
{
Description: The path ID of storage account associated with the volume container. ,
Required: True ,
}
string ,
ownerShipStatus:
{
Description: The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. ,
Enum:
{
Owned: No description available. ,
NotOwned: No description available. ,
}
,
Required: False ,
}
enum ,
bandWidthRateInMbps:
{
Description: The bandwidth-rate set on the volume container. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthSettingId:
{
Description: The ID of the bandwidth setting associated with the volume container. ,
Required: False ,
}
string ,
totalCloudStorageUsageInBytes:
{
Description: The total cloud storage for the volume container. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
VolumeContainers_Get (removed)
Description :  Gets the properties of the specified volume container name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The name of the volume container. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The volume container properties. ,
Required: True ,
}
{
encryptionKey:
{
Description: The key used to encrypt data in the volume container. It is required when property 'EncryptionStatus' is "Enabled". ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionStatus:
{
Description: The flag to denote whether encryption is enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
volumeCount:
{
Description: The number of volumes in the volume Container. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountCredentialId:
{
Description: The path ID of storage account associated with the volume container. ,
Required: True ,
}
string ,
ownerShipStatus:
{
Description: The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. ,
Enum:
{
Owned: No description available. ,
NotOwned: No description available. ,
}
,
Required: False ,
}
enum ,
bandWidthRateInMbps:
{
Description: The bandwidth-rate set on the volume container. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthSettingId:
{
Description: The ID of the bandwidth setting associated with the volume container. ,
Required: False ,
}
string ,
totalCloudStorageUsageInBytes:
{
Description: The total cloud storage for the volume container. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
VolumeContainers_CreateOrUpdate (removed)
Description :  Creates or updates the volume container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The name of the volume container. ,
Required: True ,
}
string ,
parameters:
{
Description: The volume container to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The volume container properties. ,
Required: True ,
}
{
encryptionKey:
{
Description: The key used to encrypt data in the volume container. It is required when property 'EncryptionStatus' is "Enabled". ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionStatus:
{
Description: The flag to denote whether encryption is enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
volumeCount:
{
Description: The number of volumes in the volume Container. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountCredentialId:
{
Description: The path ID of storage account associated with the volume container. ,
Required: True ,
}
string ,
ownerShipStatus:
{
Description: The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. ,
Enum:
{
Owned: No description available. ,
NotOwned: No description available. ,
}
,
Required: False ,
}
enum ,
bandWidthRateInMbps:
{
Description: The bandwidth-rate set on the volume container. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthSettingId:
{
Description: The ID of the bandwidth setting associated with the volume container. ,
Required: False ,
}
string ,
totalCloudStorageUsageInBytes:
{
Description: The total cloud storage for the volume container. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The volume container properties. ,
Required: True ,
}
{
encryptionKey:
{
Description: The key used to encrypt data in the volume container. It is required when property 'EncryptionStatus' is "Enabled". ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
encryptionStatus:
{
Description: The flag to denote whether encryption is enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
volumeCount:
{
Description: The number of volumes in the volume Container. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountCredentialId:
{
Description: The path ID of storage account associated with the volume container. ,
Required: True ,
}
string ,
ownerShipStatus:
{
Description: The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. ,
Enum:
{
Owned: No description available. ,
NotOwned: No description available. ,
}
,
Required: False ,
}
enum ,
bandWidthRateInMbps:
{
Description: The bandwidth-rate set on the volume container. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthSettingId:
{
Description: The ID of the bandwidth setting associated with the volume container. ,
Required: False ,
}
string ,
totalCloudStorageUsageInBytes:
{
Description: The total cloud storage for the volume container. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}
VolumeContainers_Delete (removed)
Description :  Deletes the volume container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The name of the volume container. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
VolumeContainers_ListMetrics (removed)
Description :  Gets the metrics for the specified volume container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/metrics
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ID of metric source. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time granularity of the metric data. ,
Required: False ,
}
string ,
primaryAggregation:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
unit:
{
Description: The unit of the metric data. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the metric data. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric data. ,
Required: False ,
}
[
{
timeStamp:
{
Description: The time stamp of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
count:
{
Description: The count of all samples at the time stamp. ,
Format: int32 ,
Required: False ,
}
integer ,
average:
{
Description: The average of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The minimum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The maximum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
VolumeContainers_ListMetricDefinition (removed)
Description :  Gets the metric definitions for the specified volume container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/metricsDefinitions
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The metric unit. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
primaryAggregationType:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The metric source ID. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The aggregation interval for the metric. ,
Required: False ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: The available metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the metric. ,
Required: False ,
}
string ,
type:
{
Description: The metric definition type. ,
Required: False ,
}
string ,
}
,
]
,
}
Volumes_ListByVolumeContainer (removed)
Description :  Retrieves all the volumes in a volume container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the volume. ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size of the volume in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: True ,
}
enum ,
volumeContainerId:
{
Description: The ID of the volume container, in which this volume is created. ,
Required: False ,
}
string ,
accessControlRecordIds:
{
Description: The IDs of the access control records, associated with the volume. ,
Required: True ,
}
[
string ,
]
,
volumeStatus:
{
Description: The volume status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
operationStatus:
{
Description: The operation status on the volume. ,
Enum:
{
None: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Restoring: No description available. ,
}
,
Required: False ,
}
enum ,
backupStatus:
{
Description: The backup status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: The monitoring status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
backupPolicyIds:
{
Description: The IDs of the backup policies, in which this volume is part of. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Volumes_Get (removed)
Description :  Returns the properties of the specified volume name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
volumeName:
{
Description: The volume name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the volume. ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size of the volume in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: True ,
}
enum ,
volumeContainerId:
{
Description: The ID of the volume container, in which this volume is created. ,
Required: False ,
}
string ,
accessControlRecordIds:
{
Description: The IDs of the access control records, associated with the volume. ,
Required: True ,
}
[
string ,
]
,
volumeStatus:
{
Description: The volume status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
operationStatus:
{
Description: The operation status on the volume. ,
Enum:
{
None: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Restoring: No description available. ,
}
,
Required: False ,
}
enum ,
backupStatus:
{
Description: The backup status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: The monitoring status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
backupPolicyIds:
{
Description: The IDs of the backup policies, in which this volume is part of. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Volumes_CreateOrUpdate (removed)
Description :  Creates or updates the volume.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
volumeName:
{
Description: The volume name. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the volume. ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size of the volume in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: True ,
}
enum ,
volumeContainerId:
{
Description: The ID of the volume container, in which this volume is created. ,
Required: False ,
}
string ,
accessControlRecordIds:
{
Description: The IDs of the access control records, associated with the volume. ,
Required: True ,
}
[
string ,
]
,
volumeStatus:
{
Description: The volume status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
operationStatus:
{
Description: The operation status on the volume. ,
Enum:
{
None: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Restoring: No description available. ,
}
,
Required: False ,
}
enum ,
backupStatus:
{
Description: The backup status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: The monitoring status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
backupPolicyIds:
{
Description: The IDs of the backup policies, in which this volume is part of. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the volume. ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size of the volume in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: True ,
}
enum ,
volumeContainerId:
{
Description: The ID of the volume container, in which this volume is created. ,
Required: False ,
}
string ,
accessControlRecordIds:
{
Description: The IDs of the access control records, associated with the volume. ,
Required: True ,
}
[
string ,
]
,
volumeStatus:
{
Description: The volume status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
operationStatus:
{
Description: The operation status on the volume. ,
Enum:
{
None: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Restoring: No description available. ,
}
,
Required: False ,
}
enum ,
backupStatus:
{
Description: The backup status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: The monitoring status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
backupPolicyIds:
{
Description: The IDs of the backup policies, in which this volume is part of. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}
Volumes_Delete (removed)
Description :  Deletes the volume.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
volumeName:
{
Description: The volume name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Volumes_ListMetrics (removed)
Description :  Gets the metrics for the specified volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}/metrics
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
volumeName:
{
Description: The volume name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ID of metric source. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time granularity of the metric data. ,
Required: False ,
}
string ,
primaryAggregation:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
unit:
{
Description: The unit of the metric data. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the metric data. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric data. ,
Required: False ,
}
[
{
timeStamp:
{
Description: The time stamp of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
count:
{
Description: The count of all samples at the time stamp. ,
Format: int32 ,
Required: False ,
}
integer ,
average:
{
Description: The average of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The minimum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The maximum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Volumes_ListMetricDefinition (removed)
Description :  Gets the metric definitions for the specified volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}/metricsDefinitions
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
volumeContainerName:
{
Description: The volume container name. ,
Required: True ,
}
string ,
volumeName:
{
Description: The volume name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The metric unit. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
primaryAggregationType:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The metric source ID. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The aggregation interval for the metric. ,
Required: False ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: The available metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the metric. ,
Required: False ,
}
string ,
type:
{
Description: The metric definition type. ,
Required: False ,
}
string ,
}
,
]
,
}
Volumes_ListByDevice (removed)
Description :  Retrieves all the volumes in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumes
{
deviceName:
{
Description: The device name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the volume. ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size of the volume in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: The type of the volume. ,
Enum:
{
Tiered: No description available. ,
Archival: No description available. ,
LocallyPinned: No description available. ,
}
,
Required: True ,
}
enum ,
volumeContainerId:
{
Description: The ID of the volume container, in which this volume is created. ,
Required: False ,
}
string ,
accessControlRecordIds:
{
Description: The IDs of the access control records, associated with the volume. ,
Required: True ,
}
[
string ,
]
,
volumeStatus:
{
Description: The volume status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
operationStatus:
{
Description: The operation status on the volume. ,
Enum:
{
None: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Restoring: No description available. ,
}
,
Required: False ,
}
enum ,
backupStatus:
{
Description: The backup status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: The monitoring status of the volume. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
backupPolicyIds:
{
Description: The IDs of the backup policies, in which this volume is part of. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Devices_Failover (removed)
Description :  Failovers a set of volume containers from a specified source device to a target device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/failover
{
sourceDeviceName:
{
Description: The source device name on which failover is performed. ,
Required: True ,
}
string ,
parameters:
{
Description: FailoverRequest containing the source device and the list of volume containers to be failed over. ,
Required: True ,
}
{
targetDeviceId:
{
Description: The ARM path ID of the device which will act as the failover target. ,
Required: False ,
}
string ,
volumeContainers:
{
Description: The list of path IDs of the volume containers which needs to be failed-over to the target device. ,
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Devices_ListFailoverTargets (removed)
Description :  Given a list of volume containers to be failed over from a source device, this method returns the eligibility result, as a failover target, for all devices under that resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets
{
sourceDeviceName:
{
Description: The source device name on which failover is performed. ,
Required: True ,
}
string ,
parameters:
{
Description: ListFailoverTargetsRequest containing the list of volume containers to be failed over. ,
Required: True ,
}
{
volumeContainers:
{
Description: The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets. ,
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of all the failover targets. ,
Required: False ,
}
[
{
deviceId:
{
Description: The path ID of the device. ,
Required: False ,
}
string ,
deviceStatus:
{
Description: The status of the device. ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
Deactivated: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deactivating: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
}
,
Required: False ,
}
enum ,
modelDescription:
{
Description: The model number of the device. ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: The software version of the device. ,
Required: False ,
}
string ,
dataContainersCount:
{
Description: The count of data containers on the device. ,
Format: int32 ,
Required: False ,
}
integer ,
volumesCount:
{
Description: The count of volumes on the device. ,
Format: int32 ,
Required: False ,
}
integer ,
availableLocalStorageInBytes:
{
Description: The amount of free local storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableTieredStorageInBytes:
{
Description: The amount of free tiered storage available for the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
deviceLocation:
{
Description: The geo location (applicable only for cloud appliances) of the device. ,
Required: False ,
}
string ,
friendlyDeviceSoftwareVersion:
{
Description: The friendly name for the current version of software on the device. ,
Required: False ,
}
string ,
eligibilityResult:
{
Description: The eligibility result of the device, as a failover target device. ,
Required: False ,
}
{
eligibilityStatus:
{
Description: The eligibility status of device, as a failover target device. ,
Enum:
{
NotEligible: No description available. ,
Eligible: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: The list of error messages, if a device does not qualify as a failover target device. ,
Required: False ,
}
[
{
message:
{
Description: The localized error message stating the reason why the device is not eligible as a target device. ,
Required: False ,
}
string ,
resolution:
{
Description: The localized resolution message for the error. ,
Required: False ,
}
string ,
resultCode:
{
Description: The result code for the error, due to which the device does not qualify as a failover target device. ,
Enum:
{
TargetAndSourceCannotBeSameError: No description available. ,
TargetIsNotOnlineError: No description available. ,
TargetSourceIncompatibleVersionError: No description available. ,
LocalToTieredVolumesConversionWarning: No description available. ,
TargetInsufficientCapacityError: No description available. ,
TargetInsufficientLocalVolumeMemoryError: No description available. ,
TargetInsufficientTieredVolumeMemoryError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
Managers_GetEncryptionSettings (removed)
Description :  Returns the encryption settings of the manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/encryptionSettings/default
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the encryption settings. ,
Required: True ,
}
{
encryptionStatus:
{
Description: The encryption status to indicates if encryption is enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
keyRolloverStatus:
{
Description: The key rollover status to indicates if key rollover is required or not. If secret's encryption has been upgraded, then it requires key rollover. ,
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Managers_GetExtendedInfo (removed)
Description :  Returns the extended information of the specified manager name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
version:
{
Description: The version of the extended info being persisted. ,
Required: False ,
}
string ,
integrityKey:
{
Description: Represents the CIK of the resource. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: Represents the CEK of the resource. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Represents the Cert thumbprint that was used to encrypt the CEK. ,
Required: False ,
}
string ,
portalCertificateThumbprint:
{
Description: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. ,
Required: False ,
}
string ,
algorithm:
{
Description: Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted ,
Required: True ,
}
string ,
}
,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
}
Managers_CreateExtendedInfo (removed)
Description :  Creates the extended info of the manager.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/extendedInformation/vaultExtendedInfo
{
parameters:
{
Description: The manager extended information. ,
Required: True ,
}
{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
version:
{
Description: The version of the extended info being persisted. ,
Required: False ,
}
string ,
integrityKey:
{
Description: Represents the CIK of the resource. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: Represents the CEK of the resource. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Represents the Cert thumbprint that was used to encrypt the CEK. ,
Required: False ,
}
string ,
portalCertificateThumbprint:
{
Description: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. ,
Required: False ,
}
string ,
algorithm:
{
Description: Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted ,
Required: True ,
}
string ,
}
,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
version:
{
Description: The version of the extended info being persisted. ,
Required: False ,
}
string ,
integrityKey:
{
Description: Represents the CIK of the resource. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: Represents the CEK of the resource. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Represents the Cert thumbprint that was used to encrypt the CEK. ,
Required: False ,
}
string ,
portalCertificateThumbprint:
{
Description: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. ,
Required: False ,
}
string ,
algorithm:
{
Description: Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted ,
Required: True ,
}
string ,
}
,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
}
Managers_DeleteExtendedInfo (removed)
Description :  Deletes the extended info of the manager.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Managers_UpdateExtendedInfo (removed)
Description :  Updates the extended info of the manager.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/extendedInformation/vaultExtendedInfo
{
parameters:
{
Description: The manager extended information. ,
Required: True ,
}
{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
version:
{
Description: The version of the extended info being persisted. ,
Required: False ,
}
string ,
integrityKey:
{
Description: Represents the CIK of the resource. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: Represents the CEK of the resource. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Represents the Cert thumbprint that was used to encrypt the CEK. ,
Required: False ,
}
string ,
portalCertificateThumbprint:
{
Description: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. ,
Required: False ,
}
string ,
algorithm:
{
Description: Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted ,
Required: True ,
}
string ,
}
,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
If-Match:
{
Description: Pass the ETag of ExtendedInfo fetched from GET call ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The extended info properties. ,
Required: False ,
}
{
version:
{
Description: The version of the extended info being persisted. ,
Required: False ,
}
string ,
integrityKey:
{
Description: Represents the CIK of the resource. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: Represents the CEK of the resource. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Represents the Cert thumbprint that was used to encrypt the CEK. ,
Required: False ,
}
string ,
portalCertificateThumbprint:
{
Description: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. ,
Required: False ,
}
string ,
algorithm:
{
Description: Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted ,
Required: True ,
}
string ,
}
,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
}
Managers_ListFeatureSupportStatus (removed)
Description :  Lists the features and their support status
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/features
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
name:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
status:
{
Description: The feature support status. ,
Enum:
{
NotAvailable: No description available. ,
UnsupportedDeviceVersion: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
Jobs_ListByManager (removed)
Description :  Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/jobs
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
status:
{
Description: The current status of the job. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: The UTC time at which the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the job that is already complete. ,
Format: int32 ,
Required: True ,
}
integer ,
error:
{
Description: The error details, if any, for the job. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The error code intended for programmatic access. ,
Required: True ,
}
string ,
message:
{
Description: The error message intended to describe the error in detail. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
jobType:
{
Description: The type of the job. ,
Enum:
{
ScheduledBackup: No description available. ,
ManualBackup: No description available. ,
RestoreBackup: No description available. ,
CloneVolume: No description available. ,
FailoverVolumeContainers: No description available. ,
CreateLocallyPinnedVolume: No description available. ,
ModifyVolume: No description available. ,
InstallUpdates: No description available. ,
SupportPackageLogs: No description available. ,
CreateCloudAppliance: No description available. ,
}
,
Required: True ,
}
enum ,
dataStats:
{
Description: The data statistics properties of the job. ,
Required: False ,
}
{
totalData:
{
Description: The total bytes of data to be processed, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
processedData:
{
Description: The number of bytes of data processed till now, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
cloudData:
{
Description: The number of bytes of data written to cloud, as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The average throughput of data processed(bytes/sec), as part of the job. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
entityLabel:
{
Description: The entity identifier for which the job ran. ,
Required: False ,
}
string ,
entityType:
{
Description: The entity type for which the job ran. ,
Required: False ,
}
string ,
jobStages:
{
Description: The job stages. ,
Required: False ,
}
[
{
message:
{
Description: The message of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: The stage status. ,
Enum:
{
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
detail:
{
Description: The details of the stage. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code of the stage if any. ,
Required: False ,
}
string ,
}
,
]
,
deviceId:
{
Description: The device ID in which the job ran. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not. ,
Required: False ,
}
boolean ,
backupType:
{
Description: The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs. ,
Enum:
{
LocalSnapshot: No description available. ,
CloudSnapshot: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device ID of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}
Managers_GetActivationKey (removed)
Description :  Returns the activation key of the manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/listActivationKey
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationKey:
{
Description: The activation key for the device. ,
Required: True ,
}
string ,
}
Managers_GetPublicEncryptionKey (removed)
Description :  Returns the symmetric encrypted public encryption key of the manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/listPublicEncryptionKey
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value of the secret itself. If the secret is in plaintext or null then EncryptionAlgorithm will be none. ,
Required: True ,
}
string ,
valueCertificateThumbprint:
{
Description: The thumbprint of the cert that was used to encrypt "Value". ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt the "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
Managers_ListMetrics (removed)
Description :  Gets the metrics for the specified manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/metrics
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ID of metric source. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time granularity of the metric data. ,
Required: False ,
}
string ,
primaryAggregation:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
unit:
{
Description: The unit of the metric data. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the metric data. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric data. ,
Required: False ,
}
[
{
timeStamp:
{
Description: The time stamp of the metric data. ,
Format: date-time ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
count:
{
Description: The count of all samples at the time stamp. ,
Format: int32 ,
Required: False ,
}
integer ,
average:
{
Description: The average of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The minimum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The maximum of all samples at the time stamp. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Managers_ListMetricDefinition (removed)
Description :  Gets the metric definitions for the specified manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/metricsDefinitions
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
{
value:
{
Description: The metric name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized metric name. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The metric unit. ,
Enum:
{
Bytes: No description available. ,
BytesPerSecond: No description available. ,
Count: No description available. ,
CountPerSecond: No description available. ,
Percent: No description available. ,
Seconds: No description available. ,
}
,
Required: False ,
}
enum ,
primaryAggregationType:
{
Description: The metric aggregation type. ,
Enum:
{
Average: No description available. ,
Last: No description available. ,
Maximum: No description available. ,
Minimum: No description available. ,
None: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The metric source ID. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The aggregation interval for the metric. ,
Required: False ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain. ,
Required: False ,
}
string ,
}
,
]
,
dimensions:
{
Description: The available metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
value:
{
Description: The metric dimension values. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the metric. ,
Required: False ,
}
string ,
type:
{
Description: The metric definition type. ,
Required: False ,
}
string ,
}
,
]
,
}
CloudAppliances_Provision (removed)
Description :  Provisions cloud appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/provisionCloudAppliance
{
parameters:
{
Description: The cloud appliance ,
Required: True ,
}
{
name:
{
Description: The name. ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the virtual network. ,
Required: False ,
}
string ,
vnetRegion:
{
Description: The virtual network region. ,
Required: True ,
}
string ,
isVnetDnsConfigured:
{
Description: Indicates whether virtual network used is configured with DNS or not. ,
Required: False ,
}
boolean ,
isVnetExpressConfigured:
{
Description: Indicates whether virtual network used is configured with express route or not. ,
Required: False ,
}
boolean ,
subnetName:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageAccountType:
{
Description: The type of the storage account. ,
Required: False ,
}
string ,
vmType:
{
Description: The type of the virtual machine. ,
Required: False ,
}
string ,
vmImageName:
{
Description: The name of the virtual machine image. ,
Required: False ,
}
string ,
modelNumber:
{
Description: The model number. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Managers_RegenerateActivationKey (removed)
Description :  Re-generates and returns the activation key of the manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/regenerateActivationKey
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationKey:
{
Description: The activation key for the device. ,
Required: True ,
}
string ,
}
StorageAccountCredentials_ListByManager (removed)
Description :  Gets all the storage account credentials in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials
{
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
accessKey:
{
Description: The details of the storage account password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
volumesCount:
{
Description: The count of volumes using this storage account credential. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
StorageAccountCredentials_Get (removed)
Description :  Gets the properties of the specified storage account credential name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{storageAccountCredentialName}
{
storageAccountCredentialName:
{
Description: The name of storage account credential to be fetched. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
accessKey:
{
Description: The details of the storage account password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
volumesCount:
{
Description: The count of volumes using this storage account credential. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
StorageAccountCredentials_CreateOrUpdate (removed)
Description :  Creates or updates the storage account credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{storageAccountCredentialName}
{
storageAccountCredentialName:
{
Description: The storage account credential name. ,
Required: True ,
}
string ,
parameters:
{
Description: The storage account credential to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
accessKey:
{
Description: The details of the storage account password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
volumesCount:
{
Description: The count of volumes using this storage account credential. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The storage account credential properties. ,
Required: True ,
}
{
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
sslStatus:
{
Description: Signifies whether SSL needs to be enabled or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
accessKey:
{
Description: The details of the storage account password. ,
Required: False ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
encryptionCertThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: The algorithm used to encrypt "Value". ,
Enum:
{
None: No description available. ,
AES256: No description available. ,
RSAES_PKCS1_v_1_5: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
volumesCount:
{
Description: The count of volumes using this storage account credential. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}
StorageAccountCredentials_Delete (removed)
Description :  Deletes the storage account credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{storageAccountCredentialName}
{
storageAccountCredentialName:
{
Description: The name of the storage account credential. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
managerName:
{
Description: The manager name ,
Required: True ,
}
string ,
api-version:
{
Description: The api version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}