Microsoft.ElasticSan (preview:2024-07-01)

2025/04/01 • 30 new methods

Operations_List (new)
Description :  Gets a list of ElasticSan operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ElasticSan/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_List (new)
Description :  List all the available Skus in the region and information related to them
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/skus
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='location eq ' to filter on location. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ResourceType Sku ,
Required: False ,
}
[
{
name:
{
Description: Sku Name ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Sku Tier ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Availability of the SKU for the location/zone ,
Required: False ,
}
[
{
location:
{
Description: The location. ,
Required: False ,
}
string ,
zones:
{
Description: The zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The capability information in the specified SKU. ,
Required: False ,
}
[
{
name:
{
Description: The name of capability. ,
Required: False ,
}
string ,
value:
{
Description: A string value to indicate states of given capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_ListBySubscription (new)
Description :  Gets a list of ElasticSans in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Elastic San objects. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_ListByResourceGroup (new)
Description :  Gets a list of ElasticSan in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Elastic San objects. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_Create (new)
Description :  Create ElasticSan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
parameters:
{
Description: Elastic San object. ,
Required: True ,
}
{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_Update (new)
Description :  Update a Elastic San.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
parameters:
{
Description: Elastic San object. ,
Required: True ,
}
{
properties:
{
Description: Properties of ElasticSan. ,
Required: False ,
}
{
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
tags:
{
Description: Update tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_Delete (new)
Description :  Delete a Elastic San.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticSans_Get (new)
Description :  Get a ElasticSan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of ElasticSan. ,
Required: True ,
}
{
sku:
{
Description: resource sku ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Premium_LRS: Premium locally redundant storage ,
Premium_ZRS: Premium zone redundant storage ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The sku tier. ,
Enum:
{
Premium: Premium Tier ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: Logical zone for Elastic San resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
baseSizeTiB:
{
Description: Base size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
extendedCapacitySizeTiB:
{
Description: Extended size of the Elastic San appliance in TiB. ,
Format: int64 ,
Required: True ,
}
integer ,
totalVolumeSizeGiB:
{
Description: Total size of the provisioned Volumes in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupCount:
{
Description: Total number of volume groups in this Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalIops:
{
Description: Total Provisioned IOPS of the Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMBps:
{
Description: Total Provisioned MBps Elastic San appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeTiB:
{
Description: Total size of the Elastic San appliance in TB. ,
Format: int64 ,
Required: False ,
}
integer ,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
autoScaleProperties:
{
Description: Auto Scale Properties for Elastic San Appliance. ,
Required: False ,
}
{
scaleUpProperties:
{
Description: Scale up settings on Elastic San Appliance. ,
Required: False ,
}
{
unusedSizeTiB:
{
Description: Unused size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
increaseCapacityUnitByTiB:
{
Description: Unit to increase Capacity Unit on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUnitScaleUpLimitTiB:
{
Description: Maximum scale up size on Elastic San appliance in TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
autoScalePolicyEnforcement:
{
Description: Enable or Disable scale up setting on Elastic San Appliance. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_ListByElasticSan (new)
Description :  List VolumeGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-access-soft-deleted-resources:
{
Description: Optional, returns only soft deleted volume groups if set to true. If set to false or if not specified, returns only active volume groups. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Volume Groups objects. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Create (new)
Description :  Create a Volume Group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume Group object. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Update (new)
Description :  Update an VolumeGroup.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume Group object. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Delete (new)
Description :  Delete an VolumeGroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Get (new)
Description :  Get an VolumeGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of VolumeGroup. ,
Required: False ,
}
{
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
protocolType:
{
Description: Type of storage target ,
Enum:
{
Iscsi: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Type of encryption ,
Enum:
{
EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type. ,
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: Encryption Properties describing Key Vault and Identity information ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of Private Endpoint Connections. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enforceDataIntegrityCheckForIscsi:
{
Description: A boolean indicating whether or not Data Integrity Check is enabled ,
Required: False ,
}
boolean ,
deleteRetentionPolicy:
{
Description: The retention policy for the soft deleted volume group and its associated resources. ,
Required: False ,
}
{
policyState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionPeriodDays:
{
Description: The number of days to retain the resources after deletion. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Create (new)
Description :  Create a Volume.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the Volume. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume object. ,
Required: True ,
}
{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Update (new)
Description :  Update an Volume.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the Volume. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume object. ,
Required: True ,
}
{
properties:
{
Description: Properties of Volume. ,
Required: False ,
}
{
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: False ,
}
integer ,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Delete (new)
Description :  Delete an Volume.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the Volume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-delete-snapshots:
{
Description: Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false. ,
Required: False ,
}
string ,
x-ms-force-delete:
{
Description: Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false. ,
Required: False ,
}
string ,
deleteType:
{
Description: Optional. Specifies that the delete operation should be a permanent delete for the soft deleted volume. The value of deleteType can only be 'permanent'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Get (new)
Description :  Get an Volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the Volume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestoreVolume (new)
Description :  Restore Soft Deleted Volumes. The volume name is obtained by using the API to list soft deleted volumes by volume group
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}/restore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the Volume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_ListByVolumeGroup (new)
Description :  List Volumes in a VolumeGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-access-soft-deleted-resources:
{
Description: Optional, returns only soft deleted volumes if set to true. If set to false or if not specified, returns only active volumes. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Volume objects. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Volume. ,
Required: True ,
}
{
volumeId:
{
Description: Unique Id of the volume in GUID format ,
Required: False ,
}
string ,
creationData:
{
Description: State of the operation on the resource. ,
Required: False ,
}
{
createSource:
{
Description: This enumerates the possible sources of a volume creation. ,
Enum:
{
None: No description available. ,
VolumeSnapshot: No description available. ,
DiskSnapshot: No description available. ,
Disk: No description available. ,
DiskRestorePoint: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" ,
Required: False ,
}
string ,
}
,
sizeGiB:
{
Description: Volume size. ,
Format: int64 ,
Required: True ,
}
integer ,
storageTarget:
{
Description: Storage target information ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: False ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operational status of the iSCSI Target. ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Updating: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Stopped (deallocated): No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
Description: Parent resource information. ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Create (new)
Description :  Update the state of specified private endpoint connection associated with the Elastic San
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the Private Endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: Private Endpoint Connection Approval object. ,
Required: True ,
}
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the Elastic San
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the Private Endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the Elastic San
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the Private Endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List all Private Endpoint Connections associated with the Elastic San.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning State of Private Endpoint connection resource ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private Endpoint resource ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Private Link Service Connection State. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of resources private endpoint is mapped ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByElasticSan (new)
Description :  Gets the private link resources that need to be created for a elastic San.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeSnapshots_ListByVolumeGroup (new)
Description :  List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
$filter:
{
Description: Specify $filter='volumeName eq ' to filter on volume. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Snapshot objects. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Volume Snapshot. ,
Required: True ,
}
{
creationData:
{
Description: Data used when creating a volume snapshot. ,
Required: True ,
}
{
sourceId:
{
Description: Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
sourceVolumeSizeGiB:
{
Description: Size of Source Volume ,
Format: int64 ,
Required: False ,
}
integer ,
volumeName:
{
Description: Source Volume Name of a snapshot ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeSnapshots_Create (new)
Description :  Create a Volume Snapshot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the volume snapshot within the given volume group. ,
Required: True ,
}
string ,
parameters:
{
Description: Snapshot object. ,
Required: True ,
}
{
properties:
{
Description: Properties of Volume Snapshot. ,
Required: True ,
}
{
creationData:
{
Description: Data used when creating a volume snapshot. ,
Required: True ,
}
{
sourceId:
{
Description: Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
sourceVolumeSizeGiB:
{
Description: Size of Source Volume ,
Format: int64 ,
Required: False ,
}
integer ,
volumeName:
{
Description: Source Volume Name of a snapshot ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume Snapshot. ,
Required: True ,
}
{
creationData:
{
Description: Data used when creating a volume snapshot. ,
Required: True ,
}
{
sourceId:
{
Description: Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
sourceVolumeSizeGiB:
{
Description: Size of Source Volume ,
Format: int64 ,
Required: False ,
}
integer ,
volumeName:
{
Description: Source Volume Name of a snapshot ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Volume Snapshot. ,
Required: True ,
}
{
creationData:
{
Description: Data used when creating a volume snapshot. ,
Required: True ,
}
{
sourceId:
{
Description: Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
sourceVolumeSizeGiB:
{
Description: Size of Source Volume ,
Format: int64 ,
Required: False ,
}
integer ,
volumeName:
{
Description: Source Volume Name of a snapshot ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeSnapshots_Delete (new)
Description :  Delete a Volume Snapshot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the volume snapshot within the given volume group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeSnapshots_Get (new)
Description :  Get a Volume Snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the volume snapshot within the given volume group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Volume Snapshot. ,
Required: True ,
}
{
creationData:
{
Description: Data used when creating a volume snapshot. ,
Required: True ,
}
{
sourceId:
{
Description: Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Restoring: No description available. ,
SoftDeleting: No description available. ,
}
,
Required: False ,
}
enum ,
sourceVolumeSizeGiB:
{
Description: Size of Source Volume ,
Format: int64 ,
Required: False ,
}
integer ,
volumeName:
{
Description: Source Volume Name of a snapshot ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_PreBackup (new)
Description :  Validate whether a disk snapshot backup can be taken for list of volumes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/preBackup
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
parameters:
{
Description: Volume Name List (currently only one volume name in the list is supported. Server would return error if list is bigger) ,
Required: True ,
}
{
volumeNames:
{
Description: array of volume names ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
validationStatus:
{
Description: a status value indicating success or failure of validation ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_PreRestore (new)
Description :  Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/preRestore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
elasticSanName:
{
Description: The name of the ElasticSan. ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the VolumeGroup. ,
Required: True ,
}
string ,
parameters:
{
Description: Disk Snapshot List (currently only one Disk Snapshot in the list is supported and that the Disk Snapshot must be in same azure region as the ElasticSan. Server would return error if list is bigger) ,
Required: True ,
}
{
diskSnapshotIds:
{
Description: array of DiskSnapshot ARM IDs ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
validationStatus:
{
Description: a status value indicating success or failure of validation ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}