Microsoft.StorSimple (stable:2016-10-01)

2025/09/29 • 94 deleted methods

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: List of Managers ,
Required: True ,
}
[
{
properties:
{
Description: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
AvailableProviderOperations_List (removed)
Description :  List of AvailableProviderOperations
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: Gets or sets the name of the operation being performed on this particular object Return value format: "{resourceProviderNamespace}/{resourceType}/{read|write|deletion|action}" Eg: Microsoft.StorSimple/managers/devices/fileServers/read Microsoft.StorSimple/managers/devices/alerts/clearAlerts/action ,
Required: False ,
}
string ,
display:
{
Description: Gets or sets Display information Contains the localized display information for this particular operation/action ,
Required: False ,
}
{
provider:
{
Description: Gets or sets Provider 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: Gets or sets Resource 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: Gets or sets Operation 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: Gets or sets 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: Gets or sets Origin 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: Gets or sets Properties Reserved for future use ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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: List of Managers ,
Required: True ,
}
[
{
properties:
{
Description: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Managers_CreateOrUpdate (removed)
Description :  Creates or updates the manager.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}
{
Manager:
{
Description: The manager. ,
Required: True ,
}
{
properties:
{
Description: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: 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: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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 StorSimple 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: List of properties of the Manager ,
Required: False ,
}
{
cisIntrinsicSettings:
{
Description: Specifies if the Manager is Garda or Helsinki ,
Required: False ,
}
{
type:
{
Description: Refers to the type of the 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: ETag of the Manager ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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: Properties of AccessControlRecord ,
Required: True ,
}
{
initiatorName:
{
Description: The Iscsi initiator name (IQN) ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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: Properties of AccessControlRecord ,
Required: True ,
}
{
initiatorName:
{
Description: The Iscsi initiator name (IQN) ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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 ,
accessControlRecord:
{
Description: The access control record to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: Properties of AccessControlRecord ,
Required: True ,
}
{
initiatorName:
{
Description: The Iscsi initiator name (IQN) ,
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: Properties of AccessControlRecord ,
Required: True ,
}
{
initiatorName:
{
Description: The Iscsi initiator name (IQN) ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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: Properties of alert ,
Required: True ,
}
{
title:
{
Description: Title of the alert ,
Required: True ,
}
string ,
scope:
{
Description: Device or Resource alert ,
Enum:
{
Resource: No description available. ,
Device: No description available. ,
}
,
Required: True ,
}
enum ,
alertType:
{
Description: Type of the alert ,
Required: True ,
}
string ,
appearedAtTime:
{
Description: UTC time at which the alert appeared ,
Format: date-time ,
Required: True ,
}
string ,
appearedAtSourceTime:
{
Description: UTC time at which the alert appeared on the source ,
Format: date-time ,
Required: True ,
}
string ,
clearedAtTime:
{
Description: UTC time at which the alert got cleared ,
Format: date-time ,
Required: False ,
}
string ,
clearedAtSourceTime:
{
Description: UTC time at which the alert was cleared on the source ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source at which the alert was cleared ,
Required: True ,
}
{
name:
{
Description: Name of the source. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
alertSourceType:
{
Description: Source type of the alert. ,
Enum:
{
Resource: No description available. ,
Device: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
recommendation:
{
Description: Recommendation for acting on the alert ,
Required: False ,
}
string ,
resolutionReason:
{
Description: Reason for resolving the alert ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the alert ,
Enum:
{
Informational: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Current status of the alert ,
Enum:
{
Active: No description available. ,
Cleared: No description available. ,
}
,
Required: True ,
}
enum ,
errorDetails:
{
Description: ErrorDetails of the alert ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message ,
Required: False ,
}
string ,
occurences:
{
Description: Number of occurrences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
detailedInformation:
{
Description: Other information about the alert ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Id of the next page of alerts ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Backups_ListByManager (removed)
Description :  Retrieves all the backups in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/backups
{
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: Properties of backup ,
Required: True ,
}
{
targetId:
{
Description: The path id of the target FileServer or IscsiServer for which the backup was taken. ,
Required: False ,
}
string ,
targetType:
{
Description: Type of target, FileServer or IscsiServer ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The backup size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
createdTime:
{
Description: The time when the backup was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time when the backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
initiatedBy:
{
Description: Indicates how the backup was initiated "Manual | Scheduled". ,
Enum:
{
Manual: No description available. ,
Scheduled: No description available. ,
}
,
Required: True ,
}
enum ,
deviceId:
{
Description: The Device Identifier. ,
Required: True ,
}
string ,
elements:
{
Description: The backup elements. ,
Required: True ,
}
[
{
properties:
{
Description: The Properties of backup element ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
endpointName:
{
Description: The name of the endpoint. ,
Required: True ,
}
string ,
dataPolicy:
{
Description: The data policy of backed up endpoint. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Managers_UploadRegistrationCertificate (removed)
Description :  Upload Vault Cred Certificate. Returns UploadCertificateResponse
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/certificates/{certificateName}
{
certificateName:
{
Description: Certificate Name ,
Required: True ,
}
string ,
uploadCertificateRequestrequest:
{
Description: UploadCertificateRequest Request ,
Required: True ,
}
{
properties:
{
Description: Raw Certificate Data From IDM ,
Required: True ,
}
{
authType:
{
Description: Specify the Authentication type ,
Enum:
{
Invalid: No description available. ,
AccessControlService: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: Gets or sets the base64 encoded certificate raw data string ,
Required: True ,
}
string ,
}
,
contractVersion:
{
Description: Gets ContractVersion ,
Enum:
{
InvalidVersion: No description available. ,
V2011_09: No description available. ,
V2012_02: No description available. ,
V2012_05: No description available. ,
V2012_12: No description available. ,
V2013_04: No description available. ,
V2013_10: No description available. ,
V2013_11: No description available. ,
V2014_04: No description available. ,
V2014_06: No description available. ,
V2014_07: No description available. ,
V2014_09: No description available. ,
V2014_10: No description available. ,
V2014_12: No description available. ,
V2015_01: No description available. ,
V2015_02: No description available. ,
V2015_04: No description available. ,
V2015_05: No description available. ,
V2015_06: No description available. ,
V2015_07: No description available. ,
V2015_08: No description available. ,
V2015_10: No description available. ,
V2015_12: No description available. ,
V2016_01: No description available. ,
V2016_02: No description available. ,
V2016_04: No description available. ,
V2016_05: No description available. ,
V2016_07: No description available. ,
V2016_08: 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)

{
properties:
{
Description: Resource Certificate And AAD Details from IDM ,
Required: True ,
}
{
authType:
{
Description: Specify the Authentication type ,
Enum:
{
Invalid: No description available. ,
AccessControlService: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: Gets or sets the base64 encoded certificate raw data string ,
Required: True ,
}
string ,
resourceId:
{
Description: Gets or Sets the ResourceId ,
Format: int64 ,
Required: True ,
}
integer ,
aadAuthority:
{
Description: AAD tenant authority ,
Required: True ,
}
string ,
aadTenantId:
{
Description: AAD tenant Id ,
Required: True ,
}
string ,
servicePrincipalClientId:
{
Description: AAD service principal clientId ,
Required: True ,
}
string ,
servicePrincipalObjectId:
{
Description: AAD service principal ObjectId ,
Required: True ,
}
string ,
azureManagementEndpointAudience:
{
Description: Azure Management Endpoint Audience ,
Required: True ,
}
string ,
subject:
{
Description: Certificate Subject Name ,
Required: True ,
}
string ,
validFrom:
{
Description: Certificate Validity start Date time ,
Format: date-time ,
Required: True ,
}
string ,
validTo:
{
Description: Certificate Validity End Date time ,
Format: date-time ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
friendlyName:
{
Description: Certificate friendly name ,
Required: True ,
}
string ,
issuer:
{
Description: Certificate issuer ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Alerts_Clear (removed)
Description :  Clear the alerts.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/clearAlerts
{
request:
{
Description: The clear alert request. ,
Required: True ,
}
{
resolutionMessage:
{
Description: Resolution message while clearing the request ,
Required: False ,
}
string ,
alerts:
{
Description: 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_ListByManager (removed)
Description :  Retrieves all the devices in a 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: Collection of properties for the device ,
Required: False ,
}
{
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: False ,
}
string ,
allowedDeviceOperations:
{
Description: Operations that are allowed on the device based on its current state ,
Required: False ,
}
[
string ,
]
,
culture:
{
Description: Language culture setting on the device. For eg: "en-US" ,
Required: False ,
}
string ,
deviceCapabilities:
{
Description: Device can be configured either as FileServer or IscsiServer ,
Required: False ,
}
[
string ,
]
,
deviceDescription:
{
Description: Short description given for the device ,
Required: False ,
}
string ,
domainName:
{
Description: Fully qualified name of the domain to which the device is attached ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: Version number of the software running on the device ,
Required: False ,
}
string ,
friendlySoftwareName:
{
Description: Friendly name for the software version ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: "Complete" if the device has been successfully registered as File/IscsiServer and the creation of share/volume is complete, "Pending" if the device is only registered but the creation of share/volume is complete is still pending ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
modelDescription:
{
Description: Name of the device model ,
Required: False ,
}
string ,
status:
{
Description: Current status of the device ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
Deactivated: No description available. ,
Deactivating: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of the device ,
Enum:
{
Invalid: No description available. ,
Appliance: No description available. ,
VirtualAppliance: No description available. ,
Series9000OnPremVirtualAppliance: No description available. ,
Series9000VirtualAppliance: No description available. ,
Series9000PhysicalAppliance: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: subclass containing more storage-related information about the device. This field will be populated only if the get call is made with $expand = details. ,
Required: False ,
}
{
endpointCount:
{
Description: Total number of endpoints that are currently on the device ( i.e. number of shares on FileServer or number of volumes on IscsiServer) ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageInBytes:
{
Description: Total storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalLocalStorageInBytes:
{
Description: Total local storage capacity in device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedStorageInBytes:
{
Description: Storage in bytes that has been provisioned on the device including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: Storage in bytes that has been provisioned locally on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: Storage that is being currently used in bytes including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
usingLocalStorageInBytes:
{
Description: Local Storage that is being currently used in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBackupSizeInBytes:
{
Description: Total size taken up by backups in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableStorageInBytes:
{
Description: Total pending available storage on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableLocalStorageInBytes:
{
Description: Local pending storage available on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_Get (removed)
Description :  Returns the properties of the specified device name.
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Collection of properties for the device ,
Required: False ,
}
{
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: False ,
}
string ,
allowedDeviceOperations:
{
Description: Operations that are allowed on the device based on its current state ,
Required: False ,
}
[
string ,
]
,
culture:
{
Description: Language culture setting on the device. For eg: "en-US" ,
Required: False ,
}
string ,
deviceCapabilities:
{
Description: Device can be configured either as FileServer or IscsiServer ,
Required: False ,
}
[
string ,
]
,
deviceDescription:
{
Description: Short description given for the device ,
Required: False ,
}
string ,
domainName:
{
Description: Fully qualified name of the domain to which the device is attached ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: Version number of the software running on the device ,
Required: False ,
}
string ,
friendlySoftwareName:
{
Description: Friendly name for the software version ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: "Complete" if the device has been successfully registered as File/IscsiServer and the creation of share/volume is complete, "Pending" if the device is only registered but the creation of share/volume is complete is still pending ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
modelDescription:
{
Description: Name of the device model ,
Required: False ,
}
string ,
status:
{
Description: Current status of the device ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
Deactivated: No description available. ,
Deactivating: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of the device ,
Enum:
{
Invalid: No description available. ,
Appliance: No description available. ,
VirtualAppliance: No description available. ,
Series9000OnPremVirtualAppliance: No description available. ,
Series9000VirtualAppliance: No description available. ,
Series9000PhysicalAppliance: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: subclass containing more storage-related information about the device. This field will be populated only if the get call is made with $expand = details. ,
Required: False ,
}
{
endpointCount:
{
Description: Total number of endpoints that are currently on the device ( i.e. number of shares on FileServer or number of volumes on IscsiServer) ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageInBytes:
{
Description: Total storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalLocalStorageInBytes:
{
Description: Total local storage capacity in device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedStorageInBytes:
{
Description: Storage in bytes that has been provisioned on the device including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: Storage in bytes that has been provisioned locally on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: Storage that is being currently used in bytes including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
usingLocalStorageInBytes:
{
Description: Local Storage that is being currently used in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBackupSizeInBytes:
{
Description: Total size taken up by backups in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableStorageInBytes:
{
Description: Total pending available storage on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableLocalStorageInBytes:
{
Description: Local pending storage available on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_Patch (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 ,
devicePatch:
{
Description: Patch representation of the device. ,
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: Collection of properties for the device ,
Required: False ,
}
{
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: False ,
}
string ,
allowedDeviceOperations:
{
Description: Operations that are allowed on the device based on its current state ,
Required: False ,
}
[
string ,
]
,
culture:
{
Description: Language culture setting on the device. For eg: "en-US" ,
Required: False ,
}
string ,
deviceCapabilities:
{
Description: Device can be configured either as FileServer or IscsiServer ,
Required: False ,
}
[
string ,
]
,
deviceDescription:
{
Description: Short description given for the device ,
Required: False ,
}
string ,
domainName:
{
Description: Fully qualified name of the domain to which the device is attached ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: Version number of the software running on the device ,
Required: False ,
}
string ,
friendlySoftwareName:
{
Description: Friendly name for the software version ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: "Complete" if the device has been successfully registered as File/IscsiServer and the creation of share/volume is complete, "Pending" if the device is only registered but the creation of share/volume is complete is still pending ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
modelDescription:
{
Description: Name of the device model ,
Required: False ,
}
string ,
status:
{
Description: Current status of the device ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
Deactivated: No description available. ,
Deactivating: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of the device ,
Enum:
{
Invalid: No description available. ,
Appliance: No description available. ,
VirtualAppliance: No description available. ,
Series9000OnPremVirtualAppliance: No description available. ,
Series9000VirtualAppliance: No description available. ,
Series9000PhysicalAppliance: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: subclass containing more storage-related information about the device. This field will be populated only if the get call is made with $expand = details. ,
Required: False ,
}
{
endpointCount:
{
Description: Total number of endpoints that are currently on the device ( i.e. number of shares on FileServer or number of volumes on IscsiServer) ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageInBytes:
{
Description: Total storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalLocalStorageInBytes:
{
Description: Total local storage capacity in device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedStorageInBytes:
{
Description: Storage in bytes that has been provisioned on the device including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: Storage in bytes that has been provisioned locally on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: Storage that is being currently used in bytes including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
usingLocalStorageInBytes:
{
Description: Local Storage that is being currently used in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBackupSizeInBytes:
{
Description: Total size taken up by backups in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableStorageInBytes:
{
Description: Total pending available storage on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableLocalStorageInBytes:
{
Description: Local pending storage available on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_GetAlertSettings (removed)
Description :  Returns the alert settings of the specified device name.
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: Properties of AlertSettings ,
Required: True ,
}
{
emailNotification:
{
Description: Value indicating whether user/admins will receive emails when an alert condition occurs on the system ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
notificationToServiceOwners:
{
Description: Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: Culture setting to be used while building alert emails. For eg: "en-US" ,
Required: True ,
}
string ,
additionalRecipientEmailList:
{
Description: List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_CreateOrUpdateAlertSettings (removed)
Description :  Creates or updates the alert settings
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 ,
alertSettings:
{
Description: The alert settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of AlertSettings ,
Required: True ,
}
{
emailNotification:
{
Description: Value indicating whether user/admins will receive emails when an alert condition occurs on the system ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
notificationToServiceOwners:
{
Description: Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: Culture setting to be used while building alert emails. For eg: "en-US" ,
Required: True ,
}
string ,
additionalRecipientEmailList:
{
Description: List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent ,
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: Properties of AlertSettings ,
Required: True ,
}
{
emailNotification:
{
Description: Value indicating whether user/admins will receive emails when an alert condition occurs on the system ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
notificationToServiceOwners:
{
Description: Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
alertNotificationCulture:
{
Description: Culture setting to be used while building alert emails. For eg: "en-US" ,
Required: True ,
}
string ,
additionalRecipientEmailList:
{
Description: List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Backups_ListByDevice (removed)
Description :  Retrieves all the backups in a device. Can be used to get the backups for failover also.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
forFailover:
{
Description: Set to true if you need backups which can be used for failover. ,
Required: False ,
}
boolean ,
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: Properties of backup ,
Required: True ,
}
{
targetId:
{
Description: The path id of the target FileServer or IscsiServer for which the backup was taken. ,
Required: False ,
}
string ,
targetType:
{
Description: Type of target, FileServer or IscsiServer ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The backup size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
createdTime:
{
Description: The time when the backup was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time when the backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
initiatedBy:
{
Description: Indicates how the backup was initiated "Manual | Scheduled". ,
Enum:
{
Manual: No description available. ,
Scheduled: No description available. ,
}
,
Required: True ,
}
enum ,
deviceId:
{
Description: The Device Identifier. ,
Required: True ,
}
string ,
elements:
{
Description: The backup elements. ,
Required: True ,
}
[
{
properties:
{
Description: The Properties of backup element ,
Required: True ,
}
{
sizeInBytes:
{
Description: The size in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
endpointName:
{
Description: The name of the endpoint. ,
Required: True ,
}
string ,
dataPolicy:
{
Description: The data policy of backed up endpoint. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Backups_Clone (removed)
Description :  Clones the given backup element to a new disk or share with given details.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backups/{backupName}/elements/{elementName}/clone
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
elementName:
{
Description: The backup element name. ,
Required: True ,
}
string ,
cloneRequest:
{
Description: The clone request. ,
Required: True ,
}
{
properties:
{
Description: CloneJob Properties are encapsulated in this object. ,
Required: True ,
}
{
targetDeviceId:
{
Description: DeviceId of the device which will act as the Clone target ,
Required: True ,
}
string ,
targetAccessPointId:
{
Description: Access point Id on which clone job will performed. ,
Required: True ,
}
string ,
newEndpointName:
{
Description: Name of new endpoint which will created as part of clone job. ,
Required: True ,
}
string ,
share:
{
Description: Share Object. ,
Required: False ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
disk:
{
Description: Disk Object ,
Required: False ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: 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)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
BackupScheduleGroups_ListByDevice (removed)
Description :  Retrieves all the backup schedule groups in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupScheduleGroups
{
deviceName:
{
Description: The name of the device. ,
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: Properties of BackupScheduleGroup ,
Required: True ,
}
{
startTime:
{
Description: The start time. When this field is specified we will generate Default GrandFather Father Son Backup Schedules. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
BackupScheduleGroups_Get (removed)
Description :  Returns the properties of the specified backup schedule group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupScheduleGroups/{scheduleGroupName}
{
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
scheduleGroupName:
{
Description: The name of the schedule group. ,
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: Properties of BackupScheduleGroup ,
Required: True ,
}
{
startTime:
{
Description: The start time. When this field is specified we will generate Default GrandFather Father Son Backup Schedules. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
BackupScheduleGroups_CreateOrUpdate (removed)
Description :  Creates or Updates the backup schedule Group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupScheduleGroups/{scheduleGroupName}
{
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
scheduleGroupName:
{
Description: The name of the schedule group. ,
Required: True ,
}
string ,
scheduleGroup:
{
Description: The schedule group to be created ,
Required: True ,
}
{
properties:
{
Description: Properties of BackupScheduleGroup ,
Required: True ,
}
{
startTime:
{
Description: The start time. When this field is specified we will generate Default GrandFather Father Son Backup Schedules. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
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: Properties of BackupScheduleGroup ,
Required: True ,
}
{
startTime:
{
Description: The start time. When this field is specified we will generate Default GrandFather Father Son Backup Schedules. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
BackupScheduleGroups_Delete (removed)
Description :  Deletes the backup schedule group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupScheduleGroups/{scheduleGroupName}
{
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
scheduleGroupName:
{
Description: The name of the schedule group. ,
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
ChapSettings_ListByDevice (removed)
Description :  Retrieves all the chap settings in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings
{
deviceName:
{
Description: The name of the device. ,
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 chap settings entity collection ,
Required: True ,
}
[
{
properties:
{
Description: Chap properties ,
Required: True ,
}
{
password:
{
Description: The chap password. ,
Required: True ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
ChapSettings_Get (removed)
Description :  Returns the properties of the specified chap setting name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings/{chapUserName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
chapUserName:
{
Description: The user name of chap 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: Chap properties ,
Required: True ,
}
{
password:
{
Description: The chap password. ,
Required: True ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
ChapSettings_CreateOrUpdate (removed)
Description :  Creates or updates the chap setting.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings/{chapUserName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
chapUserName:
{
Description: The chap user name. ,
Required: True ,
}
string ,
chapSetting:
{
Description: The chap setting to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: Chap properties ,
Required: True ,
}
{
password:
{
Description: The chap password. ,
Required: True ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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: Chap properties ,
Required: True ,
}
{
password:
{
Description: The chap password. ,
Required: True ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
ChapSettings_Delete (removed)
Description :  Deletes the chap setting.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings/{chapUserName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
chapUserName:
{
Description: The chap user 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_ListByDevice (removed)
Description :  Retrieves all the iSCSI disks in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/disks
{
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. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_DownloadUpdates (removed)
Description :  Downloads updates on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/download
{
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_Failover (removed)
Description :  Fails over the device to another device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failover
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
failoverRequest:
{
Description: The failover request. ,
Required: True ,
}
{
accesspointIds:
{
Required: False ,
}
[
string ,
]
,
targetDeviceId:
{
Required: False ,
}
string ,
skipValidation:
{
Required: False ,
}
boolean ,
keepSourceDevice:
{
Required: False ,
}
boolean ,
}
,
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_ListFailoverTarget (removed)
Description :  Retrieves all the devices which can be used as failover targets for the given device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failoverTargets
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
properties:
{
Description: Collection of properties for the device ,
Required: False ,
}
{
activationTime:
{
Description: The UTC time at which the device was activated ,
Format: date-time ,
Required: False ,
}
string ,
allowedDeviceOperations:
{
Description: Operations that are allowed on the device based on its current state ,
Required: False ,
}
[
string ,
]
,
culture:
{
Description: Language culture setting on the device. For eg: "en-US" ,
Required: False ,
}
string ,
deviceCapabilities:
{
Description: Device can be configured either as FileServer or IscsiServer ,
Required: False ,
}
[
string ,
]
,
deviceDescription:
{
Description: Short description given for the device ,
Required: False ,
}
string ,
domainName:
{
Description: Fully qualified name of the domain to which the device is attached ,
Required: False ,
}
string ,
deviceSoftwareVersion:
{
Description: Version number of the software running on the device ,
Required: False ,
}
string ,
friendlySoftwareName:
{
Description: Friendly name for the software version ,
Required: False ,
}
string ,
deviceConfigurationStatus:
{
Description: "Complete" if the device has been successfully registered as File/IscsiServer and the creation of share/volume is complete, "Pending" if the device is only registered but the creation of share/volume is complete is still pending ,
Enum:
{
Complete: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
modelDescription:
{
Description: Name of the device model ,
Required: False ,
}
string ,
status:
{
Description: Current status of the device ,
Enum:
{
Unknown: No description available. ,
Online: No description available. ,
Offline: No description available. ,
RequiresAttention: No description available. ,
MaintenanceMode: No description available. ,
Creating: No description available. ,
Provisioning: No description available. ,
Deleted: No description available. ,
ReadyToSetup: No description available. ,
Deactivated: No description available. ,
Deactivating: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of the device ,
Enum:
{
Invalid: No description available. ,
Appliance: No description available. ,
VirtualAppliance: No description available. ,
Series9000OnPremVirtualAppliance: No description available. ,
Series9000VirtualAppliance: No description available. ,
Series9000PhysicalAppliance: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: subclass containing more storage-related information about the device. This field will be populated only if the get call is made with $expand = details. ,
Required: False ,
}
{
endpointCount:
{
Description: Total number of endpoints that are currently on the device ( i.e. number of shares on FileServer or number of volumes on IscsiServer) ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageInBytes:
{
Description: Total storage available on the device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalLocalStorageInBytes:
{
Description: Total local storage capacity in device in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedStorageInBytes:
{
Description: Storage in bytes that has been provisioned on the device including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedLocalStorageInBytes:
{
Description: Storage in bytes that has been provisioned locally on the device ,
Format: int64 ,
Required: False ,
}
integer ,
usingStorageInBytes:
{
Description: Storage that is being currently used in bytes including both local and cloud ,
Format: int64 ,
Required: False ,
}
integer ,
usingLocalStorageInBytes:
{
Description: Local Storage that is being currently used in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBackupSizeInBytes:
{
Description: Total size taken up by backups in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableStorageInBytes:
{
Description: Total pending available storage on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
availableLocalStorageInBytes:
{
Description: Local pending storage available on the device in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_ListByDevice (removed)
Description :  Retrieves all the file servers in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers
{
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. ,
Required: True ,
}
{
domainName:
{
Description: Domain of the file server ,
Required: True ,
}
string ,
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description of the file server ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_Get (removed)
Description :  Returns the properties of the specified file server name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server 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. ,
Required: True ,
}
{
domainName:
{
Description: Domain of the file server ,
Required: True ,
}
string ,
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description of the file server ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_CreateOrUpdate (removed)
Description :  Creates or updates the file server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
fileServer:
{
Description: The file server. ,
Required: True ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
domainName:
{
Description: Domain of the file server ,
Required: True ,
}
string ,
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description of the file server ,
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. ,
Required: True ,
}
{
domainName:
{
Description: Domain of the file server ,
Required: True ,
}
string ,
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description of the file server ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_Delete (removed)
Description :  Deletes the file server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_BackupNow (removed)
Description :  Backup the file server now.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/backup
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_ListMetrics (removed)
Description :  Gets the file server metrics.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/metrics
{
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The name of the file server 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 ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_ListMetricDefinition (removed)
Description :  Retrieves metric definitions of all metrics aggregated at the file server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/metricsDefinitions
{
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The name of the file server. ,
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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_ListByFileServer (removed)
Description :  Retrieves all the file shares in a file server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server 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. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_Get (removed)
Description :  Returns the properties of the specified file share name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
shareName:
{
Description: The file share 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. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_CreateOrUpdate (removed)
Description :  Creates or updates the file share.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
shareName:
{
Description: The file share name. ,
Required: True ,
}
string ,
fileShare:
{
Description: The file share. ,
Required: True ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: 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. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_Delete (removed)
Description :  Deletes the file share.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
shareName:
{
Description: The file share 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_ListMetrics (removed)
Description :  Gets the file share metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}/metrics
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
shareName:
{
Description: The file share 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 ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_ListMetricDefinition (removed)
Description :  Retrieves metric definitions of all metrics aggregated at the file share.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}/metricsDefinitions
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
fileServerName:
{
Description: The file server name. ,
Required: True ,
}
string ,
shareName:
{
Description: The file share 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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_InstallUpdates (removed)
Description :  Installs the updates on the device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/install
{
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_ListByDevice (removed)
Description :  Retrieves all the iSCSI in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers
{
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. ,
Required: True ,
}
{
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
chapId:
{
Description: The chap id. ,
Required: False ,
}
string ,
reverseChapId:
{
Description: The reverse chap id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_Get (removed)
Description :  Returns the properties of the specified iSCSI server name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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. ,
Required: True ,
}
{
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
chapId:
{
Description: The chap id. ,
Required: False ,
}
string ,
reverseChapId:
{
Description: The reverse chap id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_CreateOrUpdate (removed)
Description :  Creates or updates the iSCSI server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
iscsiServer:
{
Description: The iSCSI server. ,
Required: True ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
chapId:
{
Description: The chap id. ,
Required: False ,
}
string ,
reverseChapId:
{
Description: The reverse chap id. ,
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. ,
Required: True ,
}
{
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
chapId:
{
Description: The chap id. ,
Required: False ,
}
string ,
reverseChapId:
{
Description: The reverse chap id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_Delete (removed)
Description :  Deletes the iSCSI server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_BackupNow (removed)
Description :  Backup the iSCSI server now.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/backup
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_ListByIscsiServer (removed)
Description :  Retrieves all the disks in a iSCSI server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_Get (removed)
Description :  Returns the properties of the specified iSCSI disk name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks/{diskName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
diskName:
{
Description: The disk 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. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_CreateOrUpdate (removed)
Description :  Creates or updates the iSCSI disk.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks/{diskName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
diskName:
{
Description: The disk name. ,
Required: True ,
}
string ,
iscsiDisk:
{
Description: The iSCSI disk. ,
Required: True ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: 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. ,
Required: True ,
}
{
description:
{
Description: The description. ,
Required: False ,
}
string ,
diskStatus:
{
Description: The disk status. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
accessControlRecords:
{
Description: The access control records. ,
Required: True ,
}
[
string ,
]
,
dataPolicy:
{
Description: The data policy. ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
provisionedCapacityInBytes:
{
Description: The provisioned capacity in bytes. ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_Delete (removed)
Description :  Deletes the iSCSI disk.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks/{diskName}
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
diskName:
{
Description: The disk 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_ListMetrics (removed)
Description :  Gets the iSCSI disk metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks/{diskName}/metrics
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
diskName:
{
Description: The iSCSI disk 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 ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiDisks_ListMetricDefinition (removed)
Description :  Retrieves metric definitions for all metric aggregated at the iSCSI disk.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/disks/{diskName}/metricsDefinitions
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server name. ,
Required: True ,
}
string ,
diskName:
{
Description: The iSCSI disk 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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_ListMetrics (removed)
Description :  Gets the iSCSI server metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/metrics
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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 ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_ListMetricDefinition (removed)
Description :  Retrieves metric definitions for all metrics aggregated at iSCSI server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/iscsiservers/{iscsiServerName}/metricsDefinitions
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
iscsiServerName:
{
Description: The iSCSI server 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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Jobs_ListByDevice (removed)
Description :  Retrieves all the jobs in a device.
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: Current status of the job ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Other properties of the job ,
Required: False ,
}
{
jobType:
{
Description: Type of the job ,
Enum:
{
Backup: No description available. ,
Clone: No description available. ,
Failover: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
}
,
Required: True ,
}
enum ,
targetId:
{
Description: Id of the object that is created by the job ,
Required: False ,
}
string ,
entityId:
{
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:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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 is currently running ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not ,
Required: False ,
}
boolean ,
stats:
{
Description: stats properties for the job ,
Required: False ,
}
{
completedWorkItemCount:
{
Description: Completed work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
totalWorkItemCount:
{
Description: Total work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedTimeRemaining:
{
Description: The estimated time remaining. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
targetType:
{
Description: The target type of the backup. ,
Enum:
{
FileServer: No description available. ,
DiskServer: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device identifier of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Jobs_Get (removed)
Description :  Returns the properties 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: Current status of the job ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Other properties of the job ,
Required: False ,
}
{
jobType:
{
Description: Type of the job ,
Enum:
{
Backup: No description available. ,
Clone: No description available. ,
Failover: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
}
,
Required: True ,
}
enum ,
targetId:
{
Description: Id of the object that is created by the job ,
Required: False ,
}
string ,
entityId:
{
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:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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 is currently running ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not ,
Required: False ,
}
boolean ,
stats:
{
Description: stats properties for the job ,
Required: False ,
}
{
completedWorkItemCount:
{
Description: Completed work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
totalWorkItemCount:
{
Description: Total work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedTimeRemaining:
{
Description: The estimated time remaining. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
targetType:
{
Description: The target type of the backup. ,
Enum:
{
FileServer: No description available. ,
DiskServer: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device identifier of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_ListMetrics (removed)
Description :  Retrieves the device metrics.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics
{
deviceName:
{
Description: The name of the appliance. ,
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 ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_ListMetricDefinition (removed)
Description :  Retrieves metric definition of all metrics aggregated at device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions
{
deviceName:
{
Description: The name of the appliance. ,
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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_GetNetworkSettings (removed)
Description :  Returns the network settings of the specified device name.
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: Properties of the given NetworkSettings. ,
Required: True ,
}
{
primaryDnsServer:
{
Description: The Primary DNS server for the device ,
Required: True ,
}
string ,
secondaryDnsServer:
{
Description: The secondary DNS server for the device ,
Required: False ,
}
string ,
nodeNetworks:
{
Description: The NetworkAdapters under each node of the device. ,
Required: True ,
}
[
{
networkAdapters:
{
Description: The array of network adapters in the node. ,
Required: True ,
}
[
{
networkAdapterName:
{
Description: The name of the network adapter. ,
Required: True ,
}
string ,
iPv4Info:
{
Description: The ipv4 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IP address of the network adapter, either ipv4 or ipv6. ,
Required: True ,
}
string ,
prefixLength:
{
Description: The prefix length of the network adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
gateway:
{
Description: The gateway of the network adapter. ,
Required: True ,
}
string ,
}
,
iPv6Info:
{
Description: The ipv6 configuration of the network adapter. ,
Required: False ,
}
{
ipAddress:
{
Description: The IP address of the network adapter, either ipv4 or ipv6. ,
Required: True ,
}
string ,
prefixLength:
{
Description: The prefix length of the network adapter. ,
Format: int32 ,
Required: False ,
}
integer ,
gateway:
{
Description: The gateway of the network adapter. ,
Required: True ,
}
string ,
}
,
dhcpStatus:
{
Description: Represents state of DHCP. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
linkSpeed:
{
Description: The speed of the network adapter. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_CreateOrUpdateSecuritySettings (removed)
Description :  Creates or updates the security settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/update
{
deviceName:
{
Description: The device name. ,
Required: True ,
}
string ,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
properties:
{
Description: Properties of the SecuritySettings. ,
Required: True ,
}
{
deviceAdminPassword:
{
Description: Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to log into the local web UI of the device. Actual password could have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters ,
Required: True ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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 ,
request:
{
Description: The send test alert email request. ,
Required: True ,
}
{
emailList:
{
Description: List of emails to send the test alerts ,
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileShares_ListByDevice (removed)
Description :  Retrieves all the file shares in a device.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/shares
{
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. ,
Required: True ,
}
{
description:
{
Description: Description for file share ,
Required: False ,
}
string ,
shareStatus:
{
Description: The Share Status ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
}
,
Required: True ,
}
enum ,
dataPolicy:
{
Description: The data policy ,
Enum:
{
Invalid: No description available. ,
Local: No description available. ,
Tiered: No description available. ,
Cloud: No description available. ,
}
,
Required: True ,
}
enum ,
adminUser:
{
Description: The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. ,
Required: True ,
}
string ,
provisionedCapacityInBytes:
{
Description: The total provisioned capacity in Bytes ,
Format: int64 ,
Required: True ,
}
integer ,
usedCapacityInBytes:
{
Description: The used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
localUsedCapacityInBytes:
{
Description: The local used capacity in Bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
monitoringStatus:
{
Description: The monitoring status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Devices_GetTimeSettings (removed)
Description :  Returns the time settings of the specified device name.
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: Properties of the TimeSettings. ,
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: True ,
}
string ,
secondaryTimeServer:
{
Description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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: Update properties. ,
Required: False ,
}
{
deviceVersion:
{
Description: The current Device version. ,
Required: False ,
}
string ,
deviceLastScannedTime:
{
Description: The last time when the device did an update scan. ,
Format: date-time ,
Required: False ,
}
string ,
regularUpdatesAvailable:
{
Description: Set to true if regular updates were detected for the current version of the device. ,
Required: False ,
}
boolean ,
rebootRequiredForInstall:
{
Description: Set to true if RegularUpdatesAvailable is true and if at least one of the updateItems detected has needs a reboot to install. ,
Required: False ,
}
boolean ,
totalItemsPendingForDownload:
{
Description: The total number of items pending for download. ,
Format: int32 ,
Required: False ,
}
integer ,
totalItemsPendingForInstall:
{
Description: The total number of items pending for install. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The current update operation. ,
Enum:
{
Idle: No description available. ,
Scanning: No description available. ,
Downloading: No description available. ,
Installing: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletedScanTime:
{
Description: The time when the last scan job was completed (success|cancelled|failed) on the device. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedDownloadJobTime:
{
Description: The time when the last Download job was completed (success|cancelled|failed) on the device. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletedInstallJobTime:
{
Description: The time when the last Install job was completed (success|cancelled|failed) on the device. ,
Format: date-time ,
Required: False ,
}
string ,
inProgressDownloadJobId:
{
Description: If a download is in progress, this field contains the JobId of that particular download job ,
Required: False ,
}
string ,
inProgressInstallJobId:
{
Description: If an install is in progress, this field contains the JobId of that particular install job ,
Required: False ,
}
string ,
inProgressScanStartedTime:
{
Description: The time when the currently running scan (if any) started ,
Format: date-time ,
Required: False ,
}
string ,
inProgressDownloadJobStartedTime:
{
Description: The time when the currently running download (if any) started ,
Format: date-time ,
Required: False ,
}
string ,
inProgressInstallJobStartedTime:
{
Description: The time when the currently running install (if any) started ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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: Properties of the EncryptionSettings. ,
Required: True ,
}
{
encryptionStatus:
{
Description: The encryption status which 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 which indicates if key rollover is required or not. If secrets encryption has been upgraded, then it requires key rollover. ,
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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: True ,
}
{
version:
{
Description: Represents the version of the ExtendedInfo object 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 other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag of the Resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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
{
ManagerExtendedInfo:
{
Description: The manager extended information. ,
Required: True ,
}
{
properties:
{
Description: The extended info properties. ,
Required: True ,
}
{
version:
{
Description: Represents the version of the ExtendedInfo object 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 other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used ,
Required: True ,
}
string ,
}
,
etag:
{
Description: 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: True ,
}
{
version:
{
Description: Represents the version of the ExtendedInfo object 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 other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag of the Resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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
{
ManagerExtendedInfo:
{
Description: The manager extended information. ,
Required: True ,
}
{
properties:
{
Description: The extended info properties. ,
Required: True ,
}
{
version:
{
Description: Represents the version of the ExtendedInfo object 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 other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used ,
Required: True ,
}
string ,
}
,
etag:
{
Description: 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: True ,
}
{
version:
{
Description: Represents the version of the ExtendedInfo object 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 other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used ,
Required: True ,
}
string ,
}
,
etag:
{
Description: ETag of the Resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
FileServers_ListByManager (removed)
Description :  Retrieves all the file servers in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/fileservers
{
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 ,
}
{
domainName:
{
Description: Domain of the file server ,
Required: True ,
}
string ,
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description of the file server ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Managers_GetEncryptionKey (removed)
Description :  Returns the symmetric encryption key of the manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/getEncryptionKey
{
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: Thumbprint cert that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
IscsiServers_ListByManager (removed)
Description :  Retrieves all the iSCSI servers in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/iscsiservers
{
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 ,
}
{
storageDomainId:
{
Description: The storage domain id. ,
Required: True ,
}
string ,
backupScheduleGroupId:
{
Description: The backup policy id. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
chapId:
{
Description: The chap id. ,
Required: False ,
}
string ,
reverseChapId:
{
Description: The reverse chap id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Jobs_ListByManager (removed)
Description :  Retrieves all the jobs in a manager.
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: Current status of the job ,
Enum:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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. ,
Required: False ,
}
{
errorDetails:
{
Description: The error details. ,
Required: False ,
}
[
{
recommendations:
{
Description: The recommended actions. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
]
,
code:
{
Description: The code intended for programmatic access ,
Required: True ,
}
string ,
message:
{
Description: The message intended to describe the error in detail ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Other properties of the job ,
Required: False ,
}
{
jobType:
{
Description: Type of the job ,
Enum:
{
Backup: No description available. ,
Clone: No description available. ,
Failover: No description available. ,
DownloadUpdates: No description available. ,
InstallUpdates: No description available. ,
}
,
Required: True ,
}
enum ,
targetId:
{
Description: Id of the object that is created by the job ,
Required: False ,
}
string ,
entityId:
{
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:
{
Invalid: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Paused: No description available. ,
Scheduled: 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 is currently running ,
Required: False ,
}
string ,
isCancellable:
{
Description: Represents whether the job is cancellable or not ,
Required: False ,
}
boolean ,
stats:
{
Description: stats properties for the job ,
Required: False ,
}
{
completedWorkItemCount:
{
Description: Completed work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
totalWorkItemCount:
{
Description: Total work item count. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedTimeRemaining:
{
Description: The estimated time remaining. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
targetType:
{
Description: The target type of the backup. ,
Enum:
{
FileServer: No description available. ,
DiskServer: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDeviceId:
{
Description: The source device identifier of the failover job. ,
Required: False ,
}
string ,
backupPointInTime:
{
Description: The time of the backup used for the failover. ,
Format: date-time ,
Required: False ,
}
string ,
downloadProgress:
{
Description: The download progress. ,
Required: False ,
}
{
downloadPhase:
{
Description: The download phase. ,
Enum:
{
Unknown: No description available. ,
Initializing: No description available. ,
Downloading: No description available. ,
Verifying: No description available. ,
}
,
Required: False ,
}
enum ,
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
totalBytesToDownload:
{
Description: Total bytes to download. ,
Format: double ,
Required: False ,
}
number ,
totalBytesDownloaded:
{
Description: Total bytes downloaded. ,
Format: double ,
Required: False ,
}
number ,
numberOfUpdatesToDownload:
{
Description: Number of updates to download. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesDownloaded:
{
Description: Number of updates downloaded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
installProgress:
{
Description: The install progress. ,
Required: False ,
}
{
percentComplete:
{
Description: Percentage of completion. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesToInstall:
{
Description: Number of updates to install. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfUpdatesInstalled:
{
Description: Number of updates installed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The NextLink. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Managers_ListMetrics (removed)
Description :  Gets the manager metrics
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: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: True ,
}
[
{
resourceId:
{
Description: The id of metric source ,
Required: True ,
}
string ,
startTime:
{
Description: The metric start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The metric end time ,
Format: date-time ,
Required: True ,
}
string ,
timeGrain:
{
Description: The time grain, time grain indicates frequency of the metric data ,
Required: True ,
}
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: True ,
}
enum ,
name:
{
Description: The name of the metrics ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
string ,
}
,
dimensions:
{
Description: The Metric dimension which indicates the source of the metric ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
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: True ,
}
enum ,
type:
{
Description: The Type of the metric data ,
Required: True ,
}
string ,
values:
{
Description: The metric data ,
Required: True ,
}
[
{
timeStamp:
{
Description: The time when the metric data is fetched ,
Format: date-time ,
Required: True ,
}
string ,
sum:
{
Description: The sum of all the samples available in the given instance of time for the specific metric data ,
Format: double ,
Required: True ,
}
number ,
count:
{
Description: The count of samples of the metric data available for the given instance ,
Format: int32 ,
Required: True ,
}
integer ,
average:
{
Description: The average of all sample for the given instance ,
Format: double ,
Required: True ,
}
number ,
minimum:
{
Description: The minimum of all samples available ,
Format: double ,
Required: True ,
}
number ,
maximum:
{
Description: The maximum of all samples available ,
Format: double ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
Managers_ListMetricDefinition (removed)
Description :  Retrieves metric definition of all metrics aggregated at 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 definition ,
Required: True ,
}
[
{
name:
{
Description: The metric name ,
Required: True ,
}
{
value:
{
Description: Name of the metric ,
Required: True ,
}
string ,
localizedValue:
{
Description: Localized name of the metric ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
resourceId:
{
Description: The metric source id ,
Required: True ,
}
string ,
metricAvailabilities:
{
Description: The available metric granularities ,
Required: True ,
}
[
{
timeGrain:
{
Description: The time grain, specifies the aggregation interval for the metric. ,
Required: True ,
}
string ,
retention:
{
Description: The retention period for the metric at the specified timegrain ,
Required: True ,
}
string ,
}
,
]
,
dimensions:
{
Description: The supported dimensions ,
Required: True ,
}
[
{
name:
{
Description: Metric dimension name ,
Required: True ,
}
string ,
value:
{
Description: Metric dimension values ,
Required: True ,
}
string ,
}
,
]
,
type:
{
Description: The metric definition type ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageAccountCredentials_ListByManager (removed)
Description :  Retrieves 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: Credential properties ,
Required: True ,
}
{
cloudType:
{
Description: The cloud service provider ,
Enum:
{
Azure: No description available. ,
S3: No description available. ,
S3_RRS: No description available. ,
OpenStack: No description available. ,
HP: No description available. ,
}
,
Required: True ,
}
enum ,
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
login:
{
Description: The storage account login ,
Required: True ,
}
string ,
location:
{
Description: The storage account's geo location ,
Required: False ,
}
string ,
enableSSL:
{
Description: 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 itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageAccountCredentials_Get (removed)
Description :  Returns the properties of the specified storage account credential name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{credentialName}
{
credentialName:
{
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: Credential properties ,
Required: True ,
}
{
cloudType:
{
Description: The cloud service provider ,
Enum:
{
Azure: No description available. ,
S3: No description available. ,
S3_RRS: No description available. ,
OpenStack: No description available. ,
HP: No description available. ,
}
,
Required: True ,
}
enum ,
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
login:
{
Description: The storage account login ,
Required: True ,
}
string ,
location:
{
Description: The storage account's geo location ,
Required: False ,
}
string ,
enableSSL:
{
Description: 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 itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
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/{credentialName}
{
credentialName:
{
Description: The credential name. ,
Required: True ,
}
string ,
storageAccount:
{
Description: The storage account credential to be added or updated. ,
Required: True ,
}
{
properties:
{
Description: Credential properties ,
Required: True ,
}
{
cloudType:
{
Description: The cloud service provider ,
Enum:
{
Azure: No description available. ,
S3: No description available. ,
S3_RRS: No description available. ,
OpenStack: No description available. ,
HP: No description available. ,
}
,
Required: True ,
}
enum ,
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
login:
{
Description: The storage account login ,
Required: True ,
}
string ,
location:
{
Description: The storage account's geo location ,
Required: False ,
}
string ,
enableSSL:
{
Description: 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 itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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: Credential properties ,
Required: True ,
}
{
cloudType:
{
Description: The cloud service provider ,
Enum:
{
Azure: No description available. ,
S3: No description available. ,
S3_RRS: No description available. ,
OpenStack: No description available. ,
HP: No description available. ,
}
,
Required: True ,
}
enum ,
endPoint:
{
Description: The storage endpoint ,
Required: True ,
}
string ,
login:
{
Description: The storage account login ,
Required: True ,
}
string ,
location:
{
Description: The storage account's geo location ,
Required: False ,
}
string ,
enableSSL:
{
Description: 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 itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageAccountCredentials_Delete (removed)
Description :  Deletes the storage account credential
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{credentialName}
{
credentialName:
{
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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageDomains_ListByManager (removed)
Description :  Retrieves all the storage domains in a manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains
{
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 ,
}
{
storageAccountCredentialIds:
{
Description: The storage account credentials. ,
Required: True ,
}
[
string ,
]
,
encryptionKey:
{
Description: The encryption key used to encrypt the data. This is a user secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 encryption status "Enabled | Disabled". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageDomains_Get (removed)
Description :  Returns the properties of the specified storage domain name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains/{storageDomainName}
{
storageDomainName:
{
Description: The storage domain 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. ,
Required: True ,
}
{
storageAccountCredentialIds:
{
Description: The storage account credentials. ,
Required: True ,
}
[
string ,
]
,
encryptionKey:
{
Description: The encryption key used to encrypt the data. This is a user secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 encryption status "Enabled | Disabled". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageDomains_CreateOrUpdate (removed)
Description :  Creates or updates the storage domain.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains/{storageDomainName}
{
storageDomainName:
{
Description: The storage domain name. ,
Required: True ,
}
string ,
storageDomain:
{
Description: The storageDomain. ,
Required: True ,
}
{
properties:
{
Description: The properties. ,
Required: True ,
}
{
storageAccountCredentialIds:
{
Description: The storage account credentials. ,
Required: True ,
}
[
string ,
]
,
encryptionKey:
{
Description: The encryption key used to encrypt the data. This is a user secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 encryption status "Enabled | Disabled". ,
Enum:
{
Enabled: No description available. ,
Disabled: 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. ,
Required: True ,
}
{
storageAccountCredentialIds:
{
Description: The storage account credentials. ,
Required: True ,
}
[
string ,
]
,
encryptionKey:
{
Description: The encryption key used to encrypt the data. This is a user secret. ,
Required: False ,
}
{
value:
{
Description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. ,
Required: True ,
}
string ,
encryptionCertificateThumbprint:
{
Description: Thumbprint certificate that was used to encrypt "Value" ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: 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 encryption status "Enabled | Disabled". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}
StorageDomains_Delete (removed)
Description :  Deletes the storage domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains/{storageDomainName}
{
storageDomainName:
{
Description: The storage domain 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)

{}

⚐ Response (default)

{
errorCode:
{
Required: True ,
}
string ,
message:
{
Required: True ,
}
{
language:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
values:
{
Required: False ,
}
[
{
key:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
}