Microsoft.ContainerStorage (preview:2023-07-01)

2025/08/29 • 16 new, 16 deleted methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListBySubscription (new)
Description :  List Pool resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListByResourceGroup (new)
Description :  List Pool resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Pool resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: False ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
object ,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Snapshot items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
labels:
{
Description: String KV pairs indicating labels ,
Required: False ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListBySubscription (removed)
Description :  List Pool resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pools_ListByResourceGroup (removed)
Description :  List Pool resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Pool resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: False ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
object ,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The operational status of the resource ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of availability zones that resources can be created in. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: Resources represent the resources the pool should have. ,
Required: False ,
}
{
requests:
{
Description: Requests for capacity for the pool. ,
Required: False ,
}
{
storage:
{
Description: Requested capacity of the pool in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
poolType:
{
Description: Type of the Pool: ephemeralDisk, azureDisk, or elasticsan. ,
Required: True ,
}
{
azureDisk:
{
Description: Disk Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Standard_LRS: Standard_LRS SKU ,
StandardSSD_LRS: StandardSSD_LRS SKU ,
UltraSSD_LRS: UltraSSD_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
PremiumV2_LRS: PremiumV2_LRS SKU ,
StandardSSD_ZRS: StandardSSD_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
elasticSan:
{
Description: Elastic San Pool Properties ,
Required: False ,
}
{
resourceGroup:
{
Description: Managed resource group for the pool. ,
Required: False ,
}
string ,
skuName:
{
Description: Sku name ,
Enum:
{
Premium_LRS: Premium_LRS SKU ,
Premium_ZRS: Premium_ZRS SKU ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption specifies the encryption configuration for the Azure Disk pool ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVaultUri:
{
Description: The URI of the key vault. ,
Required: True ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}
,
ephemeralDisk:
{
Description: Ephemeral Pool Properties ,
Required: False ,
}
{
replicas:
{
Description: The number of data copies. Default 3. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). ,
Required: False ,
}
[
{
id:
{
Description: ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 ,
Required: True ,
}
string ,
reference:
{
Description: Reference is the location of the disk in an external system. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
reclaimPolicy:
{
Description: ReclaimPolicy defines what happens to the backend storage when StoragePool is deleted ,
Enum:
{
Delete: Delete resource ,
Retain: Retain resource ,
}
,
Required: False ,
}
enum ,
assignments:
{
Description: List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For ElasticSAN there can be many. ,
Required: False ,
}
[
{
status:
{
Description: Indicates if the assignment is in a usable state ,
Required: False ,
}
{
state:
{
Description: State of the assignment resource ,
Enum:
{
Assigning: The assignment of the pool to the resource is in progress ,
Assigned: The assignment to the pool was successful. ,
Unassigning: The pool is being unassigned. ,
Failed: The operation of assigning or unassigning the pool failed. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for the status ,
Required: False ,
}
string ,
}
,
id:
{
Description: Resource id for the assigned resource ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Snapshots_ListByPool (removed)
Description :  List Snapshot resources by Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Snapshot items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Reference to the source volume ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/snapshots/{snapshotName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
snapshotName:
{
Description: Volume Snapshot Resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_ListByPool (removed)
Description :  List Volume resources by Pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
labels:
{
Description: String KV pairs indicating labels ,
Required: False ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the resource. ,
Required: False ,
}
{
state:
{
Description: state of the resource ,
Enum:
{
Pending: The resource is pending. ,
Available: The resource is available. ,
Unavailable: The resource is unavailable. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Reason for state. ,
Required: False ,
}
string ,
}
,
labels:
{
Description: String KV pairs indicating labels ,
Required: True ,
}
object ,
capacityGiB:
{
Description: Requested capacity in GiB ,
Format: int64 ,
Required: True ,
}
integer ,
volumeType:
{
Description: Properties of the volume ,
Required: False ,
}
{
elasticSan:
{
Description: Properties of the ElasticSAN iSCSI target ,
Required: False ,
}
{
targetIqn:
{
Description: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" ,
Required: True ,
}
string ,
targetPortalHostname:
{
Description: iSCSI Target Portal Host Name ,
Required: True ,
}
string ,
targetPortalPort:
{
Description: iSCSI Target Portal Port ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool Object ,
Required: True ,
}
string ,
volumeName:
{
Description: Volume Resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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