PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/?api-version=2023-07-01-preview
Create a Pool
Servers
- https://management.azure.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
poolName |
String | Yes |
Pool Object |
subscriptionId |
String | Yes |
The ID of the target subscription. |
resourceGroupName |
String | Yes |
The name of the resource group. The name is case insensitive. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
properties |
Object | No |
Pool Properties |
properties.poolType |
Object | Yes |
Type of the Pool: ephemeralDisk, azureDisk, or elasticsan |
properties.poolType.ephemeralDisk |
Object | No |
Ephemeral Disk Pool Properties |
properties.poolType.ephemeralDisk.disks[] |
Array | No |
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). |
properties.poolType.ephemeralDisk.disks[].id |
String | Yes |
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 |
properties.poolType.ephemeralDisk.disks[].reference |
String | Yes |
Reference is the location of the disk in an external system. |
properties.poolType.ephemeralDisk.replicas |
Integer | No |
The number of data copies. Default 3. Default value: 3 |
properties.poolType.azureDisk |
Object | No |
Azure Disk Pool Properties |
properties.poolType.azureDisk.skuName |
String | No |
SKU of the underlying managed disk Possible values:
|
properties.poolType.azureDisk.resourceGroup |
String | No |
Managed resource group for the pool. |
properties.poolType.azureDisk.disks[] |
Array | No |
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). |
properties.poolType.azureDisk.disks[].id |
String | Yes |
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 |
properties.poolType.azureDisk.disks[].reference |
String | Yes |
Reference is the location of the disk in an external system. |
properties.poolType.azureDisk.encryption |
Object | No |
Encryption key properties for the pool. |
properties.poolType.azureDisk.encryption.keyVaultUri |
String | Yes |
The URI of the key vault. |
properties.poolType.azureDisk.encryption.identity |
Object | No |
Managed service identity (system assigned and/or user assigned identities) |
properties.poolType.azureDisk.encryption.identity.tenantId |
String | No |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
properties.poolType.azureDisk.encryption.identity.type |
String | Yes |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Possible values:
|
properties.poolType.azureDisk.encryption.identity.userAssignedIdentities |
Object | No |
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. |
properties.poolType.azureDisk.encryption.identity.principalId |
String | No |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
properties.poolType.azureDisk.encryption.keyName |
String | Yes |
The name of the key vault key. |
properties.poolType.elasticSan |
Object | No |
Elastic San Pool Properties |
properties.poolType.elasticSan.skuName |
String | No |
ElasticSAN SKUs Possible values:
|
properties.poolType.elasticSan.resourceGroup |
String | No |
Managed resource group for the pool. |
properties.poolType.elasticSan.encryption |
Object | No |
Encryption key properties for the pool. |
properties.poolType.elasticSan.encryption.keyVaultUri |
String | Yes |
The URI of the key vault. |
properties.poolType.elasticSan.encryption.identity |
Object | No |
Managed service identity (system assigned and/or user assigned identities) |
properties.poolType.elasticSan.encryption.identity.tenantId |
String | No |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
properties.poolType.elasticSan.encryption.identity.type |
String | Yes |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Possible values:
|
properties.poolType.elasticSan.encryption.identity.userAssignedIdentities |
Object | No |
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. |
properties.poolType.elasticSan.encryption.identity.principalId |
String | No |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
properties.poolType.elasticSan.encryption.keyName |
String | Yes |
The name of the key vault key. |
properties.provisioningState |
String | No |
Provisioning state of the resource. Possible values:
|
properties.resources |
Object | No |
Resource Requests for the pool. |
properties.resources.requests |
Object | No |
Requests for capacity for the pool. |
properties.resources.requests.storage |
Integer | No |
Requested capacity of the pool in GiB. Default value: 1024 |
properties.zones[] |
Array | No |
List of availability zones that resources can be created in. |
properties.status |
Object | No |
Status of the resource |
properties.status.message |
String | No |
Reason for state. |
properties.status.state |
String | Yes |
State of the resource. Possible values:
|
properties.assignments[] |
Array | No |
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. |
properties.assignments[].id |
String | Yes |
A type definition that refers the id to an ARM resource. |
properties.assignments[].status |
Object | No |
Status of the assignment resource |
properties.assignments[].status.message |
String | No |
Reason for the status |
properties.assignments[].status.state |
String | Yes |
Status of the assignment resource Possible values:
|
properties.reclaimPolicy |
String | No |
Reclaim policy Possible values:
|
location |
String | No |
The geo-location where the resource lives |
tags |
Object | No |
Resource tags. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.