Dell.Storage (preview:2025-03-21)

2025/04/22 • 5 updated methods

FileSystems_ListBySubscription (updated)
Description :  List FileSystemResource resources by subscription ID
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystems_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "marketplace": [
                  {
                    "@added_c76f9d17dae348218990db742d089cf6": {
                      "#name": "termUnit",
                      "Description": "Term Unit",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "@added_a218322bba0d4383a0820138f1cfb63d": {
                  "#name": "oneFsUrl",
                  "Description": "OneFS url",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "encryption": [
                  {
                    "#name": "encryptionType",
                    "Enum": {
                      "new": [
                        [
                          "Microsoft-managed keys (MMK)",
                          "Microsoft managed keys (Default)"
                        ],
                        [
                          "Customer-managed keys (CMK)",
                          "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                        ]
                      ],
                      "old": [
                        [
                          "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                          "Microsoft Managed key"
                        ],
                        [
                          "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                          "Customer Managed key"
                        ]
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Dell.Storage/filesystems
{
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 FileSystemResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
FileSystems_ListByResourceGroup (updated)
Description :  List FileSystemResource resources by resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystems_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "marketplace": [
                  {
                    "@added_5a676ce29ccd4db9b30a58702c0d1bb9": {
                      "#name": "termUnit",
                      "Description": "Term Unit",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "@added_ff323e73b5fd4669981e06894e407642": {
                  "#name": "oneFsUrl",
                  "Description": "OneFS url",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "encryption": [
                  {
                    "#name": "encryptionType",
                    "Enum": {
                      "new": [
                        [
                          "Microsoft-managed keys (MMK)",
                          "Microsoft managed keys (Default)"
                        ],
                        [
                          "Customer-managed keys (CMK)",
                          "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                        ]
                      ],
                      "old": [
                        [
                          "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                          "Microsoft Managed key"
                        ],
                        [
                          "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                          "Customer Managed key"
                        ]
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dell.Storage/filesystems
{
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 FileSystemResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
FileSystems_Get (updated)
Description :  Get a FileSystemResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystems_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "marketplace": [
              {
                "@added_5018577b15bb4f75b0ab09873665425c": {
                  "#name": "termUnit",
                  "Description": "Term Unit",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_ea5877fe09134263ae821352a70bd022": {
              "#name": "oneFsUrl",
              "Description": "OneFS url",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dell.Storage/filesystems/{filesystemName}
{
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 ,
filesystemName:
{
Description: Name of the filesystem resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
FileSystems_CreateOrUpdate (updated)
Description :  Create a FileSystemResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystems_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "marketplace": [
              {
                "@added_e39ab8377d684081a0bd47baf3f6ebc2": {
                  "#name": "termUnit",
                  "Description": "Term Unit",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_ee59051fc10d43fb87ebbc283b050b2f": {
              "#name": "oneFsUrl",
              "Description": "OneFS url",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "marketplace": [
              {
                "@added_fcbab9c38e9643e3bca91e14cb73094f": {
                  "#name": "termUnit",
                  "Description": "Term Unit",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_5899a41929a84460802e091cd8665ce6": {
              "#name": "oneFsUrl",
              "Description": "OneFS url",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "marketplace": [
              {
                "@added_8bba02a8ff93400aadb989599923eb08": {
                  "#name": "termUnit",
                  "Description": "Term Unit",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_1d39dc73e49149a7b4f437cddfe36f65": {
              "#name": "oneFsUrl",
              "Description": "OneFS url",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dell.Storage/filesystems/{filesystemName}
{
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 ,
filesystemName:
{
Description: Name of the filesystem resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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: Concrete tracked resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
FileSystems_Update (updated)
Description :  Update a FileSystemResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileSystems_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "marketplace": [
              {
                "@added_bfdf53357721418dbbc437b2f2bd3322": {
                  "#name": "termUnit",
                  "Description": "Term Unit",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_b3025f323b5c47fcb462b34a7096a290": {
              "#name": "oneFsUrl",
              "Description": "OneFS url",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "encryption": [
              {
                "#name": "encryptionType",
                "Enum": {
                  "new": [
                    [
                      "Microsoft-managed keys (MMK)",
                      "Microsoft managed keys (Default)"
                    ],
                    [
                      "Customer-managed keys (CMK)",
                      "Customer managed keys\n(CMK) - Only UserAssigned identity is supported"
                    ]
                  ],
                  "old": [
                    [
                      "ENCRYPTION_AT_REST_WITH_MICROSOFT_KEY",
                      "Microsoft Managed key"
                    ],
                    [
                      "ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY",
                      "Customer Managed key"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dell.Storage/filesystems/{filesystemName}
{
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 ,
filesystemName:
{
Description: Name of the filesystem resource ,
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 ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the FileSystemResource. ,
Required: False ,
}
{
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity for Dell Filesystem ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
encryption:
{
Description: Encryption Details of the resource ,
Required: False ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: False ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capacity:
{
Description: Capacity for Dell Filesystem, Will be received as part of Job Status ,
Required: False ,
}
{
min:
{
Description: Minimum Capacity ,
Required: False ,
}
string ,
max:
{
Description: Maximum Capacity ,
Required: False ,
}
string ,
incremental:
{
Description: Units to be increased ,
Required: False ,
}
string ,
current:
{
Description: Current Capacity of the resource ,
Required: False ,
}
string ,
}
,
marketplace:
{
Description: Marketplace details ,
Required: True ,
}
{
marketplaceSubscriptionId:
{
Description: Marketplace Subscription Id ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: True ,
}
string ,
marketplaceSubscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Fulfillment has not started ,
Subscribed: Marketplace offer is subscribed ,
Suspended: Marketplace offer is suspended because of non payment ,
Unsubscribed: Marketplace offer is unsubscribed ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: End Date of the subscription ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Unit ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: File system resource creation request accepted ,
Creating: File system resource creation started ,
Updating: File system resource is being updated ,
Deleting: File system resource deletion started ,
Succeeded: File system resource creation successful ,
Failed: File system resource creation failed ,
Canceled: File system resource creation canceled ,
Deleted: File system resource is deleted ,
NotSpecified: File system resource state is unknown ,
}
,
Required: False ,
}
enum ,
delegatedSubnetId:
{
Description: Delegated subnet id for Vnet injection ,
Required: True ,
}
string ,
delegatedSubnetCidr:
{
Description: Domain range for the delegated subnet ,
Required: True ,
}
string ,
user:
{
Description: User Details ,
Required: True ,
}
{
email:
{
Description: User Email ,
Required: True ,
}
string ,
}
,
fileSystemId:
{
Description: File system Id of the resource ,
Required: False ,
}
string ,
smartConnectFqdn:
{
Description: Smart Connect FQDN of the resource ,
Required: False ,
}
string ,
oneFsUrl:
{
Description: OneFS url ,
Required: False ,
}
string ,
dellReferenceNumber:
{
Description: DellReferenceNumber of the resource ,
Required: True ,
}
string ,
encryption:
{
Description: EncryptionProperties of the resource ,
Required: True ,
}
{
encryptionType:
{
Description: Encryption Type - MMK/CMK ,
Enum:
{
Microsoft-managed keys (MMK): Microsoft managed keys (Default) ,
Customer-managed keys (CMK): Customer managed keys (CMK) - Only UserAssigned identity is supported ,
}
,
Required: True ,
}
enum ,
keyUrl:
{
Description: Versioned Encryption Key Url - Only when user opts for CMK and hence optional ,
Required: False ,
}
string ,
encryptionIdentityProperties:
{
Description: Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional ,
Required: False ,
}
{
identityType:
{
Description: Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now ,
Enum:
{
SystemAssigned: System Assigned Managed identity ,
UserAssigned: User Assigned managed identity ,
}
,
Required: False ,
}
enum ,
identityResourceId:
{
Description: User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}