UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 8.95 kB
{"openapi":"3.0.0","info":{"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.","title":"SqlManagementClient","version":"2015-05-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"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/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/usages.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"sql-usages","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/usages":{"get":{"description":"Gets all subscription usage metrics in a given location.","operationId":"SubscriptionUsages_ListByLocation","parameters":[{"description":"The name of the region where the resource is located.","in":"path","name":"locationName","required":true,"schema":{"type":"string"},"examples":{"List subscription usages in the given location.":{"value":"WestUS"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the subscription location usages.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUsageListResult"},"examples":{"List subscription usages in the given location.":{"$ref":"#/components/examples/List_subscription_usages_in_the_given_location."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidLocation - An invalid location was specified."}},"tags":["SubscriptionUsages"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/usages/{usageName}":{"get":{"description":"Gets a subscription usage metric.","operationId":"SubscriptionUsages_Get","parameters":[{"description":"The name of the region where the resource is located.","in":"path","name":"locationName","required":true,"schema":{"type":"string"},"examples":{"Get specific subscription usage in the given location.":{"value":"WestUS"}}},{"description":"Name of usage metric to return.","in":"path","name":"usageName","required":true,"schema":{"type":"string"},"examples":{"Get specific subscription usage in the given location.":{"value":"ServerQuota"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved particular subscription location usage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUsage"},"examples":{"Get specific subscription usage in the given location.":{"$ref":"#/components/examples/Get_specific_subscription_usage_in_the_given_location."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidLocation - An invalid location was specified."}},"tags":["SubscriptionUsages"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_subscription_usages_in_the_given_location.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/Onebox/usages/ServerQuota","name":"ServerQuota","properties":{"currentValue":1,"displayName":"Regional Server Quota for West US","limit":20,"unit":"Count"},"type":"Microsoft.Sql/locations/usages"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/Onebox/usages/SubscriptionFreeDatabaseCount","name":"SubscriptionFreeDatabaseCount","properties":{"currentValue":0,"displayName":"Free Database Count per Subscription for West US","limit":1,"unit":"Count"},"type":"Microsoft.Sql/locations/usages"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/Onebox/usages/SubscriptionFreeDatabaseDaysLeft","name":"SubscriptionFreeDatabaseDaysLeft","properties":{"currentValue":365,"displayName":"Free to Basic Database Upgrade count-down in West US","limit":365,"unit":"Count"},"type":"Microsoft.Sql/locations/usages"}]}},"Get_specific_subscription_usage_in_the_given_location.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/Onebox/usages/ServerQuota","name":"ServerQuota","properties":{"currentValue":1,"displayName":"Regional Server Quota for West US","limit":20,"unit":"Count"},"type":"Microsoft.Sql/locations/usages"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List subscription usages in the given location.":{"value":"2015-05-01-preview"},"Get specific subscription usage in the given location.":{"value":"2015-05-01-preview"}}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ManagedInstanceNameParameter":{"description":"The name of the managed instance.","in":"path","name":"managedInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineContainerNameParameter":{"description":"The name of the SqlVirtualMachineContainer.","in":"path","name":"sqlVirtualMachineContainerName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineInstanceNameParameter":{"description":"The name of the SqlVirtualMachineInstance.","in":"path","name":"sqlVirtualMachineInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List subscription usages in the given location.":{"value":"00000000-1111-2222-3333-444444444444"},"Get specific subscription usage in the given location.":{"value":"00000000-1111-2222-3333-444444444444"}}},"VirtualClusterNameParameter":{"description":"The name of the virtual cluster.","in":"path","name":"virtualClusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"SubscriptionUsage":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Usage Metric of a Subscription in a Location.","properties":{"properties":{"$ref":"#/components/schemas/SubscriptionUsageProperties"}},"type":"object"},"SubscriptionUsageListResult":{"description":"A list of subscription usage metrics in a location.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/SubscriptionUsage"},"readOnly":true,"type":"array"}},"type":"object"},"SubscriptionUsageProperties":{"description":"Properties of a subscription usage.","properties":{"currentValue":{"description":"Current value of the metric.","format":"double","readOnly":true,"type":"number"},"displayName":{"description":"User-readable name of the metric.","readOnly":true,"type":"string"},"limit":{"description":"Boundary value of the metric.","format":"double","readOnly":true,"type":"number"},"unit":{"description":"Unit of the metric.","readOnly":true,"type":"string"}},"type":"object"}}}}