PureStorage.Block (preview:2024-10-01)

2025/03/31 • 36 new methods

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

⚼ Request

GET:  /providers/PureStorage.Block/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). ,
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 ,
}
,
]
,
}
,
}
Reservations_ListBySubscription (new)
Description :  List reservations by Azure subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/PureStorage.Block/reservations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Reservation items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
StoragePools_ListBySubscription (new)
Description :  List storage pools by Azure subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/PureStorage.Block/storagePools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StoragePool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Reservations_ListByResourceGroup (new)
Description :  List reservations by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Reservation items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Reservations_Get (new)
Description :  Get a reservation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
reservationName:
{
Description: Name of the reservation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
reservationName:
{
Description: Name of the reservation. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Pure Storage cloud service resource type, also called reservation ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
reservationName:
{
Description: Name of the reservation. ,
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 ,
}
{
user:
{
Description: User details ,
Required: False ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: False ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: False ,
}
string ,
state:
{
Description: State (if any) ,
Required: False ,
}
string ,
country:
{
Description: Name of the country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
reservationInternalId:
{
Description: Pure Storage's internal ID for the reservation ,
Required: False ,
}
string ,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
subscriptionId:
{
Description: Marketplace subscription ID ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Marketplace subscription purchased but not yet activated ,
Subscribed: Marketplace subscription activated ,
Suspended: Marketplace subscription suspended due to missing customer payment ,
Unsubscribed: Marketplace subscription cancelled ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details of the marketplace subscription ,
Required: True ,
}
{
publisherId:
{
Description: Publisher ID for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer ID for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan ID for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term ID for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: User details ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: True ,
}
string ,
lastName:
{
Description: Last name ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
upn:
{
Description: Principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number ,
Required: False ,
}
string ,
companyDetails:
{
Description: Company details ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: True ,
}
string ,
address:
{
Description: Company address ,
Required: False ,
}
{
addressLine1:
{
Description: Address line 1 ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2 ,
Required: False ,
}
string ,
city:
{
Description: Name of the city ,
Required: True ,
}
string ,
state:
{
Description: State (if any) ,
Required: True ,
}
string ,
country:
{
Description: Name of the country ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: True ,
}
string ,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Reservations_Delete (new)
Description :  Delete a reservation
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
reservationName:
{
Description: Name of the reservation. ,
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 ,
}
,
]
,
}
,
}
Reservations_GetResourceLimits (new)
Description :  Limits constraining certain resource properties.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}/getResourceLimits
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
reservationName:
{
Description: Name of the reservation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
storagePool:
{
Description: Limits used for storage pool resources ,
Required: True ,
}
{
provisionedBandwidthMbPerSec:
{
Description: Allowed provisioned bandwidth range for a storage pool, in MB/s ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
provisionedIops:
{
Description: Allowed provisioned IOPS range for a storage pool, as a number of operations ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
physicalAvailabilityZones:
{
Description: List of physical availability zones in the region in which storage pools can be deployed; some Azure regions do not support the necessary resources in all availability zones ,
Required: True ,
}
[
string ,
]
,
}
,
volume:
{
Description: Limits used for volume resources ,
Required: True ,
}
{
provisionedSize:
{
Description: Provisioned size limits for a volume, in bytes ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
protectionPolicy:
{
Description: internal ,
Required: True ,
}
{
frequency:
{
Description: internal ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
retention:
{
Description: internal ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
performancePolicy:
{
Description: internal ,
Required: True ,
}
{
iopsLimit:
{
Description: internal ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
bandwidthLimit:
{
Description: internal ,
Required: True ,
}
{
min:
{
Description: Minimum value of the property ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum value of the property ,
Format: int64 ,
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 ,
}
,
]
,
}
,
}
StoragePools_ListByResourceGroup (new)
Description :  List storage pools by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StoragePool items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
StoragePools_Get (new)
Description :  Get a storage pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
StoragePools_Create (new)
Description :  Create a storage pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Storage pool resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
StoragePools_Update (new)
Description :  Update a storage pool
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID of the storage pool ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Azure Availability Zone the Pool is located in ,
Required: True ,
}
string ,
vnetInjection:
{
Description: Network properties of the storage pool ,
Required: True ,
}
{
subnetId:
{
Description: Azure resource ID of the Virtual Network subnet where the storage pool will be connected ,
Required: True ,
}
string ,
vnetId:
{
Description: Azure resource ID of the Virtual Network in which the subnet is located ,
Required: True ,
}
string ,
}
,
dataRetentionPeriod:
{
Description: How long a destroyed object is kept before being eradicated, in seconds ,
Format: int64 ,
Required: False ,
}
integer ,
provisionedBandwidthMbPerSec:
{
Description: Total bandwidth provisioned for the pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
provisionedIops:
{
Description: Total I/O operations per second (IOPS) provisioned for the pool ,
Format: int64 ,
Required: False ,
}
integer ,
avs:
{
Description: AVS connection state summary ,
Required: False ,
}
{
avsEnabled:
{
Description: If true, an AVS SDDC is successfully connected to the storage pool ,
Required: True ,
}
boolean ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the storage pool is connected to ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Deletion in progress ,
Accepted: Change accepted for processing ,
}
,
Required: False ,
}
enum ,
reservationResourceId:
{
Description: Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
StoragePools_Delete (new)
Description :  Delete a storage pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
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 ,
}
,
]
,
}
,
}
AvsStorageContainers_ListByStoragePool (new)
Description :  List AVS storage containers by storage pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsStorageContainer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
storageName:
{
Description: Name of the storage used. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
provisionedLimit:
{
Description: Maximum amount of bytes that can be provisioned in this storage container; it must be a multiple of 512; each time a volume is provisioned in this container, its provisionedSize will be counted against the provisionLimit and the provisioning will fail if it goes over (minimum: 1048576 (1MiB), maximum: 4503599627370496 (4PiB)); by default it is unrestricted ,
Format: int64 ,
Required: False ,
}
integer ,
datastore:
{
Description: VMware datastore associated with this storage container (if any) ,
Required: False ,
}
string ,
mounted:
{
Description: Whether the datastore is mounted in VMware or not ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
AvsStorageContainers_Get (new)
Description :  Get an AVS storage container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
storageName:
{
Description: Name of the storage used. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
provisionedLimit:
{
Description: Maximum amount of bytes that can be provisioned in this storage container; it must be a multiple of 512; each time a volume is provisioned in this container, its provisionedSize will be counted against the provisionLimit and the provisioning will fail if it goes over (minimum: 1048576 (1MiB), maximum: 4503599627370496 (4PiB)); by default it is unrestricted ,
Format: int64 ,
Required: False ,
}
integer ,
datastore:
{
Description: VMware datastore associated with this storage container (if any) ,
Required: False ,
}
string ,
mounted:
{
Description: Whether the datastore is mounted in VMware or not ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AvsStorageContainers_Delete (new)
Description :  Delete an AVS storage container
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
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 ,
}
,
]
,
}
,
}
AvsStorageContainerVolumes_ListByAvsStorageContainer (new)
Description :  List volumes in an AVS storage container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsStorageContainerVolume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
AvsStorageContainerVolumes_Get (new)
Description :  Get a volume in an AVS storage container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the storage container ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsStorageContainerVolumes_Update (new)
Description :  Update a volume in an AVS storage container
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the storage container ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AvsStorageContainerVolumes_Delete (new)
Description :  Delete a volume in an AVS storage container
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the storage container ,
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 ,
}
,
]
,
}
,
}
AvsVms_ListByStoragePool (new)
Description :  List AVS VMs by storage pool
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsVm items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure resource ID of the storage pool ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the AVS VM ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date at which the AVS VM was created, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
softDeletion:
{
Description: AVS VM's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
volumeContainerType:
{
Description: Specify which control plane handles the lifecycle of the volume container ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS VM details ,
Required: False ,
}
{
vmId:
{
Description: ID of the AVS VM using this set of volumes ,
Required: True ,
}
string ,
vmName:
{
Description: Name of the VMware VM using this set of volumes ,
Required: True ,
}
string ,
vmType:
{
Description: Type of the VMware VM using this set of volumes ,
Enum:
{
vvol: VM using vVols as underlying storage ,
}
,
Required: True ,
}
enum ,
avsVmInternalId:
{
Description: Pure Storage's internal ID for this AVS VM ,
Required: True ,
}
string ,
}
,
space:
{
Description: Contains properties related to used Flash space ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
AvsVms_Get (new)
Description :  Get an AVS VM
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure resource ID of the storage pool ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the AVS VM ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date at which the AVS VM was created, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
softDeletion:
{
Description: AVS VM's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
volumeContainerType:
{
Description: Specify which control plane handles the lifecycle of the volume container ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS VM details ,
Required: False ,
}
{
vmId:
{
Description: ID of the AVS VM using this set of volumes ,
Required: True ,
}
string ,
vmName:
{
Description: Name of the VMware VM using this set of volumes ,
Required: True ,
}
string ,
vmType:
{
Description: Type of the VMware VM using this set of volumes ,
Enum:
{
vvol: VM using vVols as underlying storage ,
}
,
Required: True ,
}
enum ,
avsVmInternalId:
{
Description: Pure Storage's internal ID for this AVS VM ,
Required: True ,
}
string ,
}
,
space:
{
Description: Contains properties related to used Flash space ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
softDeletion:
{
Description: AVS VM's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure resource ID of the storage pool ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the AVS VM ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Date at which the AVS VM was created, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
softDeletion:
{
Description: AVS VM's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
volumeContainerType:
{
Description: Specify which control plane handles the lifecycle of the volume container ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS VM details ,
Required: False ,
}
{
vmId:
{
Description: ID of the AVS VM using this set of volumes ,
Required: True ,
}
string ,
vmName:
{
Description: Name of the VMware VM using this set of volumes ,
Required: True ,
}
string ,
vmType:
{
Description: Type of the VMware VM using this set of volumes ,
Enum:
{
vvol: VM using vVols as underlying storage ,
}
,
Required: True ,
}
enum ,
avsVmInternalId:
{
Description: Pure Storage's internal ID for this AVS VM ,
Required: True ,
}
string ,
}
,
space:
{
Description: Contains properties related to used Flash space ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AvsVms_Delete (new)
Description :  Delete an AVS VM
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
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 ,
}
,
]
,
}
,
}
AvsVmVolumes_ListByAvsVm (new)
Description :  List volumes in an AVS VM
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvsVmVolume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
AvsVmVolumes_Get (new)
Description :  Get a volume in an AVS VM
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the AVS VM ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvsVmVolumes_Update (new)
Description :  Update a volume in an AVS VM
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the AVS VM ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: False ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePoolInternalId:
{
Description: Pure Storage's internal ID for the storage pool containing the volume ,
Required: False ,
}
string ,
storagePoolResourceId:
{
Description: Azure Resource ID of the storage pool containing this volume ,
Required: False ,
}
string ,
volumeInternalId:
{
Description: Pure Storage's internal ID for the volume ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable name of the volume ,
Required: False ,
}
string ,
space:
{
Description: Storage space usage ,
Required: False ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
softDeletion:
{
Description: Volume's soft-deletion state ,
Required: True ,
}
{
destroyed:
{
Description: If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false ,
Required: True ,
}
boolean ,
eradicationTimestamp:
{
Description: Date at which the resource will be eradicated and impossible to recover, as an RFC 3339 timestamp; invalid if destroyed is false; ,
Required: False ,
}
string ,
}
,
createdTimestamp:
{
Description: Volume creation date, as an RFC 3339 timestamp ,
Required: False ,
}
string ,
provisionedSize:
{
Description: Currently provisioned size of the volume, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
volumeType:
{
Description: Specify which control plane handles the lifecycle of the volume ,
Enum:
{
avs: AVS/VMware ,
}
,
Required: False ,
}
enum ,
avs:
{
Description: AVS-specific volume information ,
Required: False ,
}
{
diskId:
{
Description: VMware ID of the disk/volume ,
Required: True ,
}
string ,
diskName:
{
Description: VMware name of the disk/volume ,
Required: True ,
}
string ,
folder:
{
Description: Name of the top-level folder in the datastore that contains the disk/volume ,
Required: True ,
}
string ,
avsVmInternalId:
{
Description: VMware ID assigned to the disk/volume ,
Required: True ,
}
string ,
avsVmResourceId:
{
Description: Azure resource ID of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsVmName:
{
Description: Name of the AVS VM connected to this disk/volume ,
Required: True ,
}
string ,
avsStorageContainerResourceId:
{
Description: Azure resource ID of the AVS storage container containing this disk/volume ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AvsVmVolumes_Delete (new)
Description :  Delete a volume in an AVS VM
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes/{volumeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
avsVmId:
{
Description: ID of the AVS VM ,
Required: True ,
}
string ,
volumeId:
{
Description: ID of the volume in the AVS VM ,
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 ,
}
,
]
,
}
,
}
StoragePools_DisableAvsConnection (new)
Description :  Disable the existing AVS connection
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/disableAvsConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
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 ,
}
,
]
,
}
,
}
StoragePools_EnableAvsConnection (new)
Description :  Initiate a connection between the storage pool and a specified AVS SDDC resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/enableAvsConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
properties:
{
Description: Storage pool EnableAvsConnection properties ,
Required: True ,
}
{
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC to connect to ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
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 ,
}
,
]
,
}
,
}
StoragePools_FinalizeAvsConnection (new)
Description :  Finalize an already started AVS connection to a specific AVS SDDC
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/finalizeAvsConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
properties:
{
Description: Storage pool FinalizeAvsConnection properties ,
Required: True ,
}
{
serviceInitializationDataEnc:
{
Description: Encoded AVS connection information ,
Required: False ,
}
string ,
serviceInitializationData:
{
Description: Explicit AVS connection information ,
Required: False ,
}
{
serviceAccountUsername:
{
Description: Service account username ,
Required: False ,
}
string ,
serviceAccountPassword:
{
Description: Service account password ,
Format: password ,
Required: False ,
}
string ,
vSphereIp:
{
Description: AVS instance's vSphere IP address ,
Required: False ,
}
string ,
vSphereCertificate:
{
Description: AVS instance's vSphere certificate ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
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 ,
}
,
]
,
}
,
}
StoragePools_GetAvsConnection (new)
Description :  Returns current information about an on-going connection to an AVS instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getAvsConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceInitializationCompleted:
{
Description: Indicates whether service initialization is complete ,
Required: True ,
}
boolean ,
serviceInitializationHandleEnc:
{
Description: Encoded service account credentials alongside connection information ,
Required: False ,
}
string ,
serviceInitializationHandle:
{
Description: Explicit service account credentials ,
Required: False ,
}
{
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the pool is connecting to ,
Required: False ,
}
string ,
serviceAccountUsername:
{
Description: Requested service account username ,
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 ,
}
,
]
,
}
,
}
StoragePools_GetAvsStatus (new)
Description :  Returns the status of the storage pool connection to AVS
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getAvsStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
avsEnabled:
{
Description: If true, an AVS connection has been successfully completed ,
Required: True ,
}
boolean ,
currentConnectionStatus:
{
Description: Human-readable current AVS connection status ,
Required: True ,
}
string ,
sddcResourceId:
{
Description: Azure resource ID of the AVS SDDC the pool is connected to ,
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 ,
}
,
]
,
}
,
}
StoragePools_GetHealthStatus (new)
Description :  Retrieve health metrics of a storage pool
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getHealthStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
health:
{
Description: Health metrics ,
Required: True ,
}
{
usedCapacityPercentage:
{
Description: How full the pool is right now, in %, compared to the maximum size it can grow to; estimated based on current usage and data reduction ratio ,
Format: double ,
Required: True ,
}
number ,
bandwidthUsage:
{
Description: Bandwidth usage metrics ,
Required: True ,
}
{
current:
{
Description: Number of bytes written and read per second (maximum value over the last 10 minutes) ,
Format: int64 ,
Required: True ,
}
integer ,
provisioned:
{
Description: Bandwidth value currently provisioned for the storage pool, in MB/s ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum bandwidth value that can be provisioned for the storage pool ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
iopsUsage:
{
Description: IOPS usage metrics ,
Required: True ,
}
{
current:
{
Description: Current number of IOPS (maximum value over the last 10 minutes) ,
Format: int64 ,
Required: True ,
}
integer ,
provisioned:
{
Description: IOPS value currently provisioned for the storage pool ,
Format: int64 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum IOPS value that can be provisioned for the storage pool ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
space:
{
Description: Storage space usage ,
Required: True ,
}
{
totalUsed:
{
Description: Total space occupied by customer data (i.e., being billed for), in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
unique:
{
Description: Unique space occupied by customer data, in bytes; for a volume, this is the amount of storage that would be freed by deleting the volume, since snapshot and shared data would be kept ,
Format: int64 ,
Required: True ,
}
integer ,
snapshots:
{
Description: Space occupied by data unique to one or more snapshots, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
shared:
{
Description: Space occupied by duplicated data, meaning data shared with other volumes and snapshots as a result of data deduplication, in bytes ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
dataReductionRatio:
{
Description: Data reduction ratio achieved on this pool ,
Format: double ,
Required: True ,
}
number ,
estimatedMaxCapacity:
{
Description: Estimated maximum capacity of the pool, in bytes, based on current usage and data reduction ratio ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
alerts:
{
Description: List of health alerts ,
Required: True ,
}
[
{
level:
{
Description: Severity level ,
Enum:
{
info: Information level ,
warning: Warning level ,
error: Error level ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A short description of the alert ,
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 ,
}
,
]
,
}
,
}
StoragePools_RepairAvsConnection (new)
Description :  Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/repairAvsConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storagePoolName:
{
Description: Name of the storage pool ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
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 ,
}
,
]
,
}
,
}