Microsoft.StoragePool (preview:2020-03-15)

2025/09/19 • 12 new, 12 deleted methods

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of operations supported by the StoragePool RP. ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object ,
Required: True ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: True ,
}
boolean ,
actionType:
{
Description: Indicates the action type. ,
Required: False ,
}
string ,
display:
{
Description: Additional metadata about RP operation. ,
Required: True ,
}
{
provider:
{
Description: Localized friendly form of the resource provider name. ,
Required: True ,
}
string ,
resource:
{
Description: Localized friendly form of the resource type related to this action/operation. ,
Required: True ,
}
string ,
operation:
{
Description: Localized friendly name for the operation, as it should be shown to the user. ,
Required: True ,
}
string ,
description:
{
Description: Localized friendly description for the operation, as it should be shown to the user. ,
Required: True ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_ListBySubscription (new)
Description :  Gets a list of Disk Pools in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StoragePool/diskPools
{
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 Disk pool objects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_ListByResourceGroup (new)
Description :  Gets a list of DiskPools in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools
{
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 Disk pool objects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_CreateOrUpdate (new)
Description :  Create or Update Disk pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
diskPoolCreatePayload:
{
Description: Request payload for Disk pool create operation ,
Required: True ,
}
{
properties:
{
Description: Properties for Disk pool create request. ,
Required: True ,
}
{
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for a Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: True ,
}
string ,
id:
{
Description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Update (new)
Description :  Update a Disk pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
diskPoolUpdatePayload:
{
Description: Request payload for Disk pool update operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for Disk pool update request. ,
Required: True ,
}
{
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Delete (new)
Description :  Delete a Disk pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Get (new)
Description :  Get a Disk pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_ListByDiskPool (new)
Description :  Get iSCSI Targets in a Disk pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of iSCSI targets in a Disk pool. ,
Required: True ,
}
[
{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_CreateOrUpdate (new)
Description :  Create or Update an iSCSI target.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
iscsiTargetCreatePayload:
{
Description: Request payload for iSCSI target create operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI target create request. ,
Required: True ,
}
{
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through the iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Update (new)
Description :  Update an iSCSI target.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
iscsiTargetUpdatePayload:
{
Description: Request payload for iSCSI target operations. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI target update request. ,
Required: True ,
}
{
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through the iSCSI target portal group. ,
Required: False ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: False ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Delete (new)
Description :  Delete an iSCSI target.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Get (new)
Description :  Get an iSCSI target.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Gets a list of StoragePool operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of operations supported by the StoragePool RP. ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object ,
Required: True ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: True ,
}
boolean ,
actionType:
{
Description: Indicates the action type. ,
Required: False ,
}
string ,
display:
{
Description: Additional metadata about RP operation. ,
Required: True ,
}
{
provider:
{
Description: Localized friendly form of the resource provider name. ,
Required: True ,
}
string ,
resource:
{
Description: Localized friendly form of the resource type related to this action/operation. ,
Required: True ,
}
string ,
operation:
{
Description: Localized friendly name for the operation, as it should be shown to the user. ,
Required: True ,
}
string ,
description:
{
Description: Localized friendly description for the operation, as it should be shown to the user. ,
Required: True ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_ListBySubscription (removed)
Description :  Gets a list of Disk Pools in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StoragePool/diskPools
{
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 Disk pool objects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_ListByResourceGroup (removed)
Description :  Gets a list of DiskPools in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools
{
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 Disk pool objects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_CreateOrUpdate (removed)
Description :  Create or Update Disk pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
diskPoolCreatePayload:
{
Description: Request payload for Disk pool create operation ,
Required: True ,
}
{
properties:
{
Description: Properties for Disk pool create request. ,
Required: True ,
}
{
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for a Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: True ,
}
string ,
id:
{
Description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Update (removed)
Description :  Update a Disk pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
diskPoolUpdatePayload:
{
Description: Request payload for Disk pool update operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for Disk pool update request. ,
Required: True ,
}
{
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Delete (removed)
Description :  Delete a Disk pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
DiskPools_Get (removed)
Description :  Get a Disk pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Disk pool. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
enum ,
availabilityZones:
{
Description: Logical zone for Disk pool resource; example: ["1"]. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: Operational status of the Disk pool. ,
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: True ,
}
enum ,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk pool. Can attach 8 disks at most. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
subnetId:
{
Description: Azure Resource ID of a Subnet for the Disk pool. ,
Required: True ,
}
string ,
additionalCapabilities:
{
Description: List of additional capabilities for Disk pool. ,
Required: False ,
}
[
string ,
]
,
tier:
{
Description: Determines the SKU of VM deployed for Disk pool ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: A string identifier for the identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: A string identifier for the identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource: user, application, managedIdentity. ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_ListByDiskPool (removed)
Description :  Get iSCSI Targets in a Disk pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of iSCSI targets in a Disk pool. ,
Required: True ,
}
[
{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_CreateOrUpdate (removed)
Description :  Create or Update an iSCSI target.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
iscsiTargetCreatePayload:
{
Description: Request payload for iSCSI target create operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI target create request. ,
Required: True ,
}
{
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through the iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Update (removed)
Description :  Update an iSCSI target.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
iscsiTargetUpdatePayload:
{
Description: Request payload for iSCSI target operations. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI target update request. ,
Required: True ,
}
{
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through the iSCSI target portal group. ,
Required: False ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: False ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Delete (removed)
Description :  Delete an iSCSI target.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}
IscsiTargets_Get (removed)
Description :  Get an iSCSI target.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
{
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 ,
diskPoolName:
{
Description: The name of the Disk pool. ,
Required: True ,
}
string ,
iscsiTargetName:
{
Description: The name of the iSCSI target. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for iSCSI target operations. ,
Required: True ,
}
{
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. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
tpgs:
{
Description: List of iSCSI target portal groups. Can have 1 portal group at most. ,
Required: True ,
}
[
{
luns:
{
Description: List of LUNs to be exposed through iSCSI target portal group. ,
Required: True ,
}
[
{
name:
{
Description: User defined name for iSCSI LUN; example: "lun0" ,
Required: True ,
}
string ,
managedDiskAzureResourceId:
{
Description: Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
acls:
{
Description: Access Control List (ACL) for an iSCSI target portal group. ,
Required: True ,
}
[
{
initiatorIqn:
{
Description: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". ,
Required: True ,
}
string ,
mappedLuns:
{
Description: List of LUN names mapped to the ACL. ,
Required: True ,
}
[
string ,
]
,
credentials:
{
Description: Challenge Handshake Authentication Protocol (CHAP) credentials to set for the ACL. Credentials can not be updated for an ACL. ,
Required: False ,
}
{
username:
{
Description: Username for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
password:
{
Description: Password for Challenge Handshake Authentication Protocol (CHAP) authentication. ,
Required: True ,
}
string ,
}
,
}
,
]
,
attributes:
{
Description: Attributes of an iSCSI target portal group. ,
Required: True ,
}
{
authentication:
{
Description: Indicates whether or not authentication is enabled on the ACL. ,
Required: True ,
}
boolean ,
prodModeWriteProtect:
{
Description: Indicates whether or not write protect is enabled on the LUNs. ,
Required: True ,
}
boolean ,
}
,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI target. ,
Required: True ,
}
[
string ,
]
,
tag:
{
Description: The tag associated with the iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
port:
{
Description: The port used by iSCSI target portal group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: RP error response. ,
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 ,
}
,
]
,
}
,
}