{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Usages" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/usages": { "get": { "operationId": "Usages_ListByInstancePool", "tags": [ "Usages" ], "description": "Gets all instance pool usage metrics", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "instancePoolName", "in": "path", "description": "The name of the instance pool to be retrieved.", "required": true, "type": "string" }, { "name": "expandChildren", "in": "query", "description": "Optional request parameter to include managed instance usages within the instance pool.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List instance pool usages expanded with children.": { "$ref": "./examples/ListInstancePoolUsageExpanded.json" }, "List instance pool usages.": { "$ref": "./examples/ListInstancePoolUsage.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "Name": { "type": "object", "description": "ARM Usage Name", "properties": { "value": { "type": "string", "description": "Usage name value" }, "localizedValue": { "type": "string", "description": "Usage name localized value." } } }, "Usage": { "type": "object", "description": "ARM usage.", "properties": { "id": { "type": "string", "description": "Resource ID.", "readOnly": true }, "name": { "$ref": "#/definitions/Name", "description": "Resource name.", "readOnly": true }, "type": { "type": "string", "description": "Resource type.", "readOnly": true }, "unit": { "type": "string", "description": "Usage unit.", "readOnly": true }, "currentValue": { "type": "integer", "format": "int32", "description": "Usage current value.", "readOnly": true }, "limit": { "type": "integer", "format": "int32", "description": "Usage limit.", "readOnly": true }, "requestedLimit": { "type": "integer", "format": "int32", "description": "Usage requested limit.", "readOnly": true } } }, "UsageListResult": { "type": "object", "description": "A list of usages.", "properties": { "value": { "type": "array", "description": "The Usage items on this page", "items": { "$ref": "#/definitions/Usage" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] } }, "parameters": {} }