Storage Appliances - List By Resource Group

Service:: Operator Nexus - Network Cloud

API Version:: 2025-02-01

List storage appliances in the resource group.
Get a list of storage appliances in the provided resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	StorageApplianceList	The resource list has been successfully retrieved.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List storage appliances for resource group

Sample request

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances?api-version=2025-02-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName",
      "name": "storageApplianceName",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/storageAppliances",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
        "storageApplianceSkuId": "684E-3B16-399E",
        "rackSlot": 1,
        "serialNumber": "BM1219XXX",
        "administratorCredentials": {
          "username": "adminUser"
        },
        "provisioningState": "Succeeded",
        "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
        "capacity": 893,
        "capacityUsed": 500,
        "remoteVendorManagementStatus": "Enabled",
        "remoteVendorManagementFeature": "Supported",
        "detailedStatus": "Available",
        "detailedStatusMessage": "Storage appliance is up and running",
        "managementIpv4Address": "192.0.2.2",
        "manufacturer": "Contoso Storage",
        "model": "ArrayStore-Flash70",
        "secretRotationStatus": [
          {
            "secretType": "Storage Appliance User",
            "lastRotationTime": "2023-09-30T13:27:23.103Z",
            "rotationPeriodDays": 60,
            "expirePeriodDays": 90,
            "secretArchiveReference": {
              "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName",
              "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff",
              "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b"
            }
          }
        ],
        "version": "9.9.9"
      }
    }
  ],
  "nextLink": "https://fully.qualified.hyperlink"
}

Definitions

Name	Description
AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created.
RemoteVendorManagementFeature	The indicator of whether the storage appliance supports remote vendor management.
RemoteVendorManagementStatus	The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.
SecretArchiveReference	SecretArchiveReference represents the reference to a secret in a key vault.
SecretRotationStatus	SecretRotationStatus represents the status of a secret rotation.
StorageAppliance	StorageAppliance represents on-premises Network Cloud storage appliance.
StorageApplianceDetailedStatus	The detailed status of the storage appliance.
StorageApplianceList	StorageApplianceList represents a list of storage appliances.
StorageApplianceProvisioningState	The provisioning state of the storage appliance.
systemData	Metadata pertaining to creation and last modification of the resource.

AdministrativeCredentials

Object

AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.

Name	Type	Description
password	string minLength: 1	The password of the administrator of the device used during initialization.
username	string minLength: 1	The username of the administrator of the device used during initialization.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Object

ExtendedLocation represents the Azure custom location where the resource will be created.

Name	Type	Description
name	string	The resource ID of the extended location on which the resource will be created.
type	string	The extended location type, for example, CustomLocation.

RemoteVendorManagementFeature

Enumeration

The indicator of whether the storage appliance supports remote vendor management.

Value	Description
Supported
Unsupported

RemoteVendorManagementStatus

Enumeration

The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.

Value	Description
Disabled
Enabled
Unsupported

SecretArchiveReference

Object

SecretArchiveReference represents the reference to a secret in a key vault.

Name	Type	Description
keyVaultId	string (arm-id)	The resource ID of the key vault containing the secret.
secretName	string	The name of the secret in the key vault.
secretVersion	string	The version of the secret in the key vault.

SecretRotationStatus

Object

SecretRotationStatus represents the status of a secret rotation.

Name	Type	Description
expirePeriodDays	integer (int64)	The maximum number of days the secret may be used before it must be changed.
lastRotationTime	string (date-time)	The date and time when the secret was last changed.
rotationPeriodDays	integer (int64)	The number of days a secret exists before rotations will be attempted.
secretArchiveReference	SecretArchiveReference	SecretArchiveReference represents the reference to a secret in a key vault. The reference to the secret in a key vault.
secretType	string	The type name used to identify the purpose of the secret.