[Azure Stack] Update Volume and Drive API for Fabric Admin

custom-words.txt

@@ -1527,3 +1527,4 @@ Corent
 Carbonite
 AATP
 MDATP
+LEDs

specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2019-05-01/Drive.json

@@ -0,0 +1,258 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "description": "Drive operation endpoints and objects.",
+    "title": "FabricAdminClient",
+    "version": "2019-05-01"
+  },
+  "host": "adminmanagement.local.azurestack.external",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "paths": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/drives/{drive}": {
+      "get": {
+        "x-ms-examples": {
+          "Return the requested a storage drive.": {
+            "$ref": "./examples/Drive/Get.json"
+          }
+        },
+        "tags": [
+          "Drives"
+        ],
+        "description": "Return the requested a storage drive.",
+        "operationId": "Drives_Get",
+        "parameters": [
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter"
+          },
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter"
+          },
+          {
+            "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter"
+          },
+          {
+            "$ref": "../2018-10-01/StorageSubSystem.json#/parameters/StorageSubSystemParameter"
+          },
+          {
+            "$ref": "#/parameters/DriveParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/Drive"
+            }
+          },
+          "404": {
+            "description": "NOT FOUND"
+          }
+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/drives": {
+      "get": {
+        "x-ms-examples": {
+          "Returns a list of all storage drives at a location.": {
+            "$ref": "./examples/Drive/List.json"
+          }
+        },
+        "tags": [
+          "Drives"
+        ],
+        "description": "Returns a list of all storage drives at a location.",
+        "operationId": "Drives_List",
+        "parameters": [
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter"
+          },
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter"
+          },
+          {
+            "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter"
+          },
+          {
+            "$ref": "../2018-10-01/StorageSubSystem.json#/parameters/StorageSubSystemParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../2016-05-01/Fabric.json#/parameters/FilterParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/DriveList"
+            }
+          },
+          "404": {
+            "description": "NOT FOUND"
+          }
+        },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        },
+        "x-ms-odata": "#/definitions/Drive"
+      }
+    }
+  },
+  "definitions": {
+    "Drive": {
+      "description": "Representation of a drive resource.",
+      "type": "object",
+      "properties": {
+        "properties": {
+          "description": "Properties of a drive.",
+          "x-ms-client-flatten": true,
+          "$ref": "#/definitions/DriveModel"
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../2016-05-01/Fabric.json#/definitions/Resource"
+        }
+      ]
+    },
+    "DriveModel": {
+      "description": "Properties of a drive.",
+      "type": "object",
+      "properties": {
+        "storageNode": {
+          "description": "Node that the drive is physically connected.",
+          "type": "string"
+        },
+        "serialNumber": {
+          "description": "Serial number of the drive.",
+          "type": "string"
+        },
+        "healthStatus": {
+          "description": "Health status of the drive.",
+          "type": "string"
+        },
+        "operationalStatus": {
+          "description": "Operational status of the drive.",
+          "type": "string"
+        },
+        "usage": {
+          "description": "Intended usage of the drive.",
+          "type": "string"
+        },
+        "physicalLocation": {
+          "description": "Indicate where the hardware is located.",
+          "type": "string"
+        },
+        "model": {
+          "description": "Model of the drive.",
+          "type": "string"
+        },
+        "firmwareVersion": {
+          "description": "The firmware version of the drive.",
+          "type": "string"
+        },
+        "isIndicationEnabled": {
+          "description": "Indicate whether the drive's identification LEDs are active or not.",
+          "type": "boolean"
+        },
+        "manufacturer": {
+          "description": "The name of the drive's manufacturer.",
+          "type": "string"
+        },
+        "storagePool": {
+          "description": "The storage pool where the drive is located.",
+          "type": "string"
+        },
+        "mediaType": {
+          "description": "Media type of the drive.",
+          "type": "string"
+        },
+        "capacityGB": {
+          "description": "Total capacity in GB of the drive.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "description": {
+          "description": "Detailed description for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.",
+          "type": "string"
+        },
+        "action": {
+          "description": "Detailed recommended action for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.",
+          "type": "string"
+        }
+      }
+    },
+    "DriveList": {
+      "description": "Pageable list of storage drives.",
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "List of storage drives.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Drive"
+          }
+        },
+        "nextLink": {
+          "description": "URI to the next page.",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "parameters": {
+    "ApiVersionParameter": {
+      "name": "api-version",
+      "in": "query",
+      "description": "Client API Version.",
+      "required": true,
+      "type": "string",
+      "default": "2019-05-01"
+    },
+    "DriveParameter": {
+      "name": "drive",
+      "description": "Name of the storage drive.",
+      "in": "path",
+      "required": true,
+      "type": "string",
+      "x-ms-parameter-location": "method"
+    }
+  },
+  "securityDefinitions": {
+    "azure_auth": {
+      "type": "oauth2",
+      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+      "flow": "implicit",
+      "description": "Authorization uses an Azure Active Directory OAuth2 flow.",
+      "scopes": {
+        "user_impersonation": "impersonate your user account"
+      }
+    }
+  },
+  "security": [
+    {
+      "azure_auth": [
+        "user_impersonation"
+      ]
+    }
+  ]
+}