FabricAdminClient
Volume operation endpoints and objects
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "adminmanagement.local.azurestack.external",
"info": {
"description": "Volume operation endpoints and objects.",
"title": "FabricAdminClient",
"version": "2019-05-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2019-05-01/Volume.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "azsadmin-Volume",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Authorization uses an Azure Active Directory OAuth2 flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"ApiVersionParameter": {
"default": "2019-05-01",
"description": "Client API Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"VolumeParameter": {
"description": "Name of the storage volume.",
"in": "path",
"name": "volume",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/volumes": {
"get": {
"description": "Returns a list of all storage volumes at a location.",
"operationId": "Volumes_List",
"parameters": [
{
"description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Location of the resource.",
"in": "path",
"name": "location",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Name of the scale units.",
"in": "path",
"name": "scaleUnit",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Name of the storage system.",
"in": "path",
"name": "storageSubSystem",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"description": "OData filter parameter.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-parameter-location": "method"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VolumeList"
}
},
"404": {
"description": "NOT FOUND"
}
},
"tags": [
"Volumes"
],
"x-ms-examples": {
"Returns a list of all storage volumes at a location.": {
"parameters": {
"api-version": "2019-05-01",
"location": "redmond",
"resourceGroupName": "System.redmond",
"scaleUnit": "s-cluster",
"storageSubSystem": "s-cluster.v.masd.stbtest.microsoft.com",
"subscriptionId": "72526b2b-4b61-4700-8f0c-7bb7ae9b6a2d"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/72526b2b-4b61-4700-8f0c-7bb7ae9b6a2d/resourceGroups/System.redmond/providers/Microsoft.Fabric.Admin/fabricLocations/redmond/scaleUnits/s-cluster/storageSubSystems/s-cluster.v.masd.stbtest.microsoft.com/volumes/48f356d4-362d-49cb-a021-fafffbe0e8ad",
"location": "redmond",
"name": "redmond/s-cluster/s-cluster.v.masd.stbtest.microsoft.com/48f356d4-362d-49cb-a021-fafffbe0e8ad",
"properties": {
"action": "",
"description": "",
"healthStatus": "Healthy",
"operationalStatus": "OK",
"remainingCapacityGB": 1317,
"repairStatus": "",
"totalCapacityGB": 1375,
"volumeLabel": "ObjStore_1"
},
"tags": {},
"type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/volumes"
}
]
}
},
"404": {}
}
}
},
"x-ms-odata": "#/definitions/Volume",
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/volumes/{volume}": {
"get": {
"description": "Return the requested a storage volume.",
"operationId": "Volumes_Get",
"parameters": [
{
"description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Location of the resource.",
"in": "path",
"name": "location",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Name of the scale units.",
"in": "path",
"name": "scaleUnit",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Name of the storage system.",
"in": "path",
"name": "storageSubSystem",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/VolumeParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Volume"
}
},
"404": {
"description": "NOT FOUND"
}
},
"tags": [
"Volumes"
],
"x-ms-examples": {
"Return the requested a storage volume.": {
"parameters": {
"api-version": "2019-05-01",
"location": "redmond",
"resourceGroupName": "System.redmond",
"scaleUnit": "s-cluster",
"storageSubSystem": "s-cluster.v.masd.stbtest.microsoft.com",
"subscriptionId": "72526b2b-4b61-4700-8f0c-7bb7ae9b6a2d",
"volume": "48f356d4-362d-49cb-a021-fafffbe0e8ad"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/72526b2b-4b61-4700-8f0c-7bb7ae9b6a2d/resourceGroups/System.redmond/providers/Microsoft.Fabric.Admin/fabricLocations/redmond/scaleUnits/s-cluster/storageSubSystems/s-cluster.v.masd.stbtest.microsoft.com/volumes/48f356d4-362d-49cb-a021-fafffbe0e8ad",
"location": "redmond",
"name": "redmond/s-cluster/s-cluster.v.masd.stbtest.microsoft.com/48f356d4-362d-49cb-a021-fafffbe0e8ad",
"properties": {
"action": "",
"description": "",
"healthStatus": "Healthy",
"operationalStatus": "OK",
"remainingCapacityGB": 1317,
"repairStatus": "",
"totalCapacityGB": 1375,
"volumeLabel": "ObjStore_1"
},
"tags": {},
"type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/volumes"
}
},
"404": {}
}
}
}
}
}
},
"definitions": {
"Volume": {
"allOf": [
{
"description": "Base resource object.",
"properties": {
"id": {
"description": "URI of the resource.",
"readOnly": true,
"type": "string"
},
"location": {
"description": "The region where the resource is located.",
"type": "string"
},
"name": {
"description": "Name of the resource.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "List of key-value pairs.",
"type": "object"
},
"type": {
"description": "Type of resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"x-ms-azure-resource": true
}
],
"description": "Representation of a volume resource.",
"properties": {
"properties": {
"$ref": "#/definitions/VolumeModel",
"description": "Properties of a volume.",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"VolumeList": {
"description": "Pageable list of storage volumes.",
"properties": {
"nextLink": {
"description": "URI to the next page.",
"type": "string"
},
"value": {
"description": "List of storage volumes.",
"items": {
"$ref": "#/definitions/Volume"
},
"type": "array"
}
},
"type": "object"
},
"VolumeModel": {
"description": "Properties of a volume.",
"properties": {
"action": {
"description": "Detailed recommended action for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Detailed description for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.",
"readOnly": true,
"type": "string"
},
"healthStatus": {
"description": "Health status of the volume.",
"readOnly": true,
"type": "string"
},
"operationalStatus": {
"description": "Operational status of the volume.",
"readOnly": true,
"type": "string"
},
"remainingCapacityGB": {
"description": "Remaining capacity in GB of the volume.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"repairStatus": {
"description": "Repair status of the volume. Empty if no repair job running, something like 'Running, 90%' when repairing.",
"readOnly": true,
"type": "string"
},
"totalCapacityGB": {
"description": "Total capacity in GB of the volume.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"volumeLabel": {
"description": "Volume label.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
}
}