{ "swagger": "2.0", "info": { "title": "Azure Compute Limit API", "version": "2025-08-15", "description": "Microsoft Azure Compute Limit Resource Provider.", "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": "Operations" }, { "name": "GuestSubscriptions" }, { "name": "SharedLimits" } ], "paths": { "/providers/Microsoft.ComputeLimit/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List operations": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeLimit/locations/{location}/guestSubscriptions": { "get": { "operationId": "GuestSubscriptions_ListBySubscriptionLocationResource", "tags": [ "GuestSubscriptions" ], "description": "Lists all guest subscriptions in a location.", "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/LocationParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GuestSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List guest subscriptions for a scope": { "$ref": "./examples/GuestSubscriptions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeLimit/locations/{location}/guestSubscriptions/{guestSubscriptionId}": { "get": { "operationId": "GuestSubscriptions_Get", "tags": [ "GuestSubscriptions" ], "description": "Gets the properties of a guest subscription.", "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/LocationParameter" }, { "name": "guestSubscriptionId", "in": "path", "description": "The name of the GuestSubscription", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GuestSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a guest subscription": { "$ref": "./examples/GuestSubscriptions_Get.json" } } }, "put": { "operationId": "GuestSubscriptions_Create", "tags": [ "GuestSubscriptions" ], "description": "Adds a subscription as a guest to consume the compute limits shared by the host subscription.", "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/LocationParameter" }, { "name": "guestSubscriptionId", "in": "path", "description": "The name of the GuestSubscription", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/GuestSubscription" } } ], "responses": { "200": { "description": "Resource 'GuestSubscription' update operation succeeded", "schema": { "$ref": "#/definitions/GuestSubscription" } }, "201": { "description": "Resource 'GuestSubscription' create operation succeeded", "schema": { "$ref": "#/definitions/GuestSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a guest subscription": { "$ref": "./examples/GuestSubscriptions_Create.json" } } }, "delete": { "operationId": "GuestSubscriptions_Delete", "tags": [ "GuestSubscriptions" ], "description": "Deletes a subscription as a guest to stop consuming the compute limits shared by the host subscription.", "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/LocationParameter" }, { "name": "guestSubscriptionId", "in": "path", "description": "The name of the GuestSubscription", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a guest subscription": { "$ref": "./examples/GuestSubscriptions_Delete.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeLimit/locations/{location}/sharedLimits": { "get": { "operationId": "SharedLimits_ListBySubscriptionLocationResource", "tags": [ "SharedLimits" ], "description": "Lists all compute limits shared by the host subscription with its guest subscriptions.", "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/LocationParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedLimitListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all shared limits for a scope": { "$ref": "./examples/SharedLimits_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeLimit/locations/{location}/sharedLimits/{name}": { "get": { "operationId": "SharedLimits_Get", "tags": [ "SharedLimits" ], "description": "Gets the properties of a compute limit shared by the host subscription with its guest subscriptions.", "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/LocationParameter" }, { "name": "name", "in": "path", "description": "The name of the SharedLimit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedLimit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a shared limit": { "$ref": "./examples/SharedLimits_Get.json" } } }, "put": { "operationId": "SharedLimits_Create", "tags": [ "SharedLimits" ], "description": "Enables sharing of a compute limit by the host subscription with its guest subscriptions.", "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/LocationParameter" }, { "name": "name", "in": "path", "description": "The name of the SharedLimit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/SharedLimit" } } ], "responses": { "200": { "description": "Resource 'SharedLimit' update operation succeeded", "schema": { "$ref": "#/definitions/SharedLimit" } }, "201": { "description": "Resource 'SharedLimit' create operation succeeded", "schema": { "$ref": "#/definitions/SharedLimit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a shared limit": { "$ref": "./examples/SharedLimits_Create.json" } } }, "delete": { "operationId": "SharedLimits_Delete", "tags": [ "SharedLimits" ], "description": "Disables sharing of a compute limit by the host subscription with its guest subscriptions.", "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/LocationParameter" }, { "name": "name", "in": "path", "description": "The name of the SharedLimit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a shared limit": { "$ref": "./examples/SharedLimits_Delete.json" } } } } }, "definitions": { "Azure.ResourceManager.ResourceProvisioningState": { "type": "string", "description": "The provisioning state of a resource type.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ResourceProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "GuestSubscription": { "type": "object", "description": "Guest subscription that consumes shared compute limits.", "properties": { "properties": { "$ref": "#/definitions/GuestSubscriptionProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "GuestSubscriptionListResult": { "type": "object", "description": "The response of a GuestSubscription list operation.", "properties": { "value": { "type": "array", "description": "The GuestSubscription items on this page", "items": { "$ref": "#/definitions/GuestSubscription" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GuestSubscriptionProperties": { "type": "object", "description": "Properties for guest subscription.", "properties": { "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The provisioning state of the resource.", "readOnly": true } } }, "LimitName": { "type": "object", "description": "Properties of the limit name.", "properties": { "value": { "type": "string", "description": "The limit name." }, "localizedValue": { "type": "string", "description": "The localized limit name.", "readOnly": true } }, "required": [ "value" ] }, "SharedLimit": { "type": "object", "description": "Compute limits shared by the subscription.", "properties": { "properties": { "$ref": "#/definitions/SharedLimitProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SharedLimitListResult": { "type": "object", "description": "The response of a SharedLimit list operation.", "properties": { "value": { "type": "array", "description": "The SharedLimit items on this page", "items": { "$ref": "#/definitions/SharedLimit" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SharedLimitProperties": { "type": "object", "description": "Properties of the compute shared limit.", "properties": { "resourceName": { "$ref": "#/definitions/LimitName", "description": "The limit name properties.", "readOnly": true }, "limit": { "type": "integer", "format": "int32", "description": "The maximum permitted usage of the resource.", "readOnly": true }, "unit": { "type": "string", "description": "The quota units, such as Count.", "default": "Count", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The provisioning state of the resource.", "readOnly": true } } } }, "parameters": {} }