Microsoft.StoragePool (stable:2021-08-01)

2025/09/19 • 18 new, 18 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 ,
}
[
{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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. This create or update operation can take 15 minutes to complete. This is expected service behavior.
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 ,
}
{
sku:
{
Description: Determines the SKU of the Disk Pool ,
Required: True ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for Disk Pool create request. ,
Required: True ,
}
{
availabilityZones:
{
Description: Logical zone for Disk Pool resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk Pool. ,
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 ,
]
,
}
,
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 ,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
{
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties for Disk Pool update request. ,
Required: True ,
}
{
disks:
{
Description: List of Azure Managed Disks to attach to a Disk Pool. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: Determines the SKU of the Disk Pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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_Delete (new)
Description :  Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
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)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
DiskPoolZones_List (new)
Description :  Lists available Disk Pool Skus in an Azure location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of Disk Pool Skus. ,
Required: False ,
}
[
{
availabilityZones:
{
Description: Logical zone for Disk Pool resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
additionalCapabilities:
{
Description: List of additional capabilities for Disk Pool. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: Determines the SKU of VM deployed for Disk Pool ,
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 ,
}
,
]
,
}
,
}
ResourceSkus_List (new)
Description :  Lists available StoragePool resources and skus in an Azure location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of StoragePool resource skus. ,
Required: False ,
}
[
{
apiVersion:
{
Description: StoragePool RP API version ,
Required: False ,
}
string ,
resourceType:
{
Description: StoragePool resource type ,
Required: False ,
}
string ,
capabilities:
{
Description: List of additional capabilities for StoragePool resource. ,
Required: False ,
}
[
{
name:
{
Description: Capability name ,
Required: False ,
}
string ,
value:
{
Description: Capability value ,
Required: False ,
}
string ,
}
,
]
,
locationInfo:
{
Description: Zones and zone capabilities in those locations where the SKU is available. ,
Required: False ,
}
{
location:
{
Description: Location of the SKU ,
Required: False ,
}
string ,
zones:
{
Description: List of availability zones where the SKU is supported. ,
Required: False ,
}
[
string ,
]
,
zoneDetails:
{
Description: Details of capabilities available to a SKU in specific zones. ,
Required: False ,
}
[
{
name:
{
Description: The set of zones that the SKU is available in with the specified capabilities. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: A list of capabilities that are available for the SKU in the specified list of zones. ,
Required: False ,
}
[
{
name:
{
Description: Capability name ,
Required: False ,
}
string ,
value:
{
Description: Capability value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
name:
{
Description: Sku name ,
Required: False ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. ,
Enum:
{
Location: No description available. ,
Zone: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
restrictionInfo:
{
Description: The information about the restriction where the SKU cannot be used. ,
Required: False ,
}
{
locations:
{
Description: Locations where the SKU is restricted ,
Required: False ,
}
[
string ,
]
,
zones:
{
Description: List of availability zones where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
reasonCode:
{
Description: The reason for restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: 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_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Gets the network endpoints of all outbound dependencies of a Disk Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/outboundNetworkDependenciesEndpoints
{
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: Collection of resources. ,
Required: True ,
}
[
{
category:
{
Description: The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that the App Service Environment reaches the service at. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The IP Addresses and Ports used when connecting to DomainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
latency:
{
Description: The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port. ,
Format: double ,
Required: False ,
}
number ,
isAccessible:
{
Description: Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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_Start (new)
Description :  The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/start
{
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 (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_Deallocate (new)
Description :  Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/deallocate
{
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 (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_Upgrade (new)
Description :  Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/upgrade
{
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 (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_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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
,
]
,
}
,
}
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Properties for iSCSI Target operations. ,
Required: True ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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_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 update operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI Target update request. ,
Required: True ,
}
{
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}

⚐ 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_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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
,
]
,
}
,
}
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 ,
}
[
{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
[
{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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. This create or update operation can take 15 minutes to complete. This is expected service behavior.
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 ,
}
{
sku:
{
Description: Determines the SKU of the Disk Pool ,
Required: True ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for Disk Pool create request. ,
Required: True ,
}
{
availabilityZones:
{
Description: Logical zone for Disk Pool resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
disks:
{
Description: List of Azure Managed Disks to attach to a Disk Pool. ,
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 ,
]
,
}
,
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 ,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
{
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties for Disk Pool update request. ,
Required: True ,
}
{
disks:
{
Description: List of Azure Managed Disks to attach to a Disk Pool. ,
Required: False ,
}
[
{
id:
{
Description: Unique Azure Resource ID of the Managed Disk. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: Determines the SKU of the Disk Pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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_Delete (removed)
Description :  Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
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)

{
sku:
{
Description: Determines the SKU of the Disk pool ,
Required: False ,
}
{
name:
{
Description: Sku name ,
Required: True ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
}
,
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. ,
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 ,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
DiskPoolZones_List (removed)
Description :  Lists available Disk Pool Skus in an Azure location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of Disk Pool Skus. ,
Required: False ,
}
[
{
availabilityZones:
{
Description: Logical zone for Disk Pool resource; example: ["1"]. ,
Required: False ,
}
[
string ,
]
,
additionalCapabilities:
{
Description: List of additional capabilities for Disk Pool. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: Determines the SKU of VM deployed for Disk Pool ,
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 ,
}
,
]
,
}
,
}
ResourceSkus_List (removed)
Description :  Lists available StoragePool resources and skus in an Azure location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of StoragePool resource skus. ,
Required: False ,
}
[
{
apiVersion:
{
Description: StoragePool RP API version ,
Required: False ,
}
string ,
resourceType:
{
Description: StoragePool resource type ,
Required: False ,
}
string ,
capabilities:
{
Description: List of additional capabilities for StoragePool resource. ,
Required: False ,
}
[
{
name:
{
Description: Capability name ,
Required: False ,
}
string ,
value:
{
Description: Capability value ,
Required: False ,
}
string ,
}
,
]
,
locationInfo:
{
Description: Zones and zone capabilities in those locations where the SKU is available. ,
Required: False ,
}
{
location:
{
Description: Location of the SKU ,
Required: False ,
}
string ,
zones:
{
Description: List of availability zones where the SKU is supported. ,
Required: False ,
}
[
string ,
]
,
zoneDetails:
{
Description: Details of capabilities available to a SKU in specific zones. ,
Required: False ,
}
[
{
name:
{
Description: The set of zones that the SKU is available in with the specified capabilities. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: A list of capabilities that are available for the SKU in the specified list of zones. ,
Required: False ,
}
[
{
name:
{
Description: Capability name ,
Required: False ,
}
string ,
value:
{
Description: Capability value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
name:
{
Description: Sku name ,
Required: False ,
}
string ,
tier:
{
Description: Sku tier ,
Required: False ,
}
string ,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. ,
Enum:
{
Location: No description available. ,
Zone: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
restrictionInfo:
{
Description: The information about the restriction where the SKU cannot be used. ,
Required: False ,
}
{
locations:
{
Description: Locations where the SKU is restricted ,
Required: False ,
}
[
string ,
]
,
zones:
{
Description: List of availability zones where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
reasonCode:
{
Description: The reason for restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next section of the paginated response. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: 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_ListOutboundNetworkDependenciesEndpoints (removed)
Description :  Gets the network endpoints of all outbound dependencies of a Disk Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/outboundNetworkDependenciesEndpoints
{
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: Collection of resources. ,
Required: True ,
}
[
{
category:
{
Description: The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that the App Service Environment reaches the service at. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The IP Addresses and Ports used when connecting to DomainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
latency:
{
Description: The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port. ,
Format: double ,
Required: False ,
}
number ,
isAccessible:
{
Description: Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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_Start (removed)
Description :  The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/start
{
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 (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_Deallocate (removed)
Description :  Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/deallocate
{
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 (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_Upgrade (removed)
Description :  Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/upgrade
{
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 (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_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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
,
]
,
}
,
}
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: False ,
}
string ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Properties for iSCSI Target operations. ,
Required: True ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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_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 update operation. ,
Required: True ,
}
{
properties:
{
Description: Properties for iSCSI Target update request. ,
Required: True ,
}
{
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
Required: False ,
}
[
string ,
]
,
}

⚐ 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_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 ,
}
{
aclMode:
{
Description: Mode for Target connectivity. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: True ,
}
enum ,
staticAcls:
{
Description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy ,
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 ,
]
,
}
,
]
,
luns:
{
Description: List of LUNs to be exposed through iSCSI Target. ,
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 ,
lun:
{
Description: Specifies the Logical Unit Number of the iSCSI LUN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". ,
Required: True ,
}
string ,
provisioningState:
{
Description: State of the operation on the resource. ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
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 ,
endpoints:
{
Description: List of private IPv4 addresses to connect to the iSCSI Target. ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: The port used by iSCSI Target portal group. ,
Format: int32 ,
Required: False ,
}
integer ,
sessions:
{
Description: List of identifiers for active sessions on the iSCSI target ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Resource metadata required by ARM RPC ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: Azure resource id. Indicates if this resource is managed by another Azure resource. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of Azure resource ids that manage this resource. ,
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 ,
}
,
]
,
}
,
}