AvailableWorkloadProfiles.json

{
  "swagger": "2.0",
  "info": {
    "version": "2022-11-01-preview",
    "title": "ContainerApps API Client"
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes": {
      "get": {
        "tags": [
          "AvailableWorkloadProfiles"
        ],
        "summary": "Get available workload profiles by location.",
        "description": "Get all available workload profiles for a location.",
        "operationId": "AvailableWorkloadProfiles_Get",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/AvailableWorkloadProfilesCollection"
            }
          },
          "default": {
            "description": "Error response.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "BillingMeters_Get": {
            "$ref": "./examples/AvailableWorkloadProfiles_Get.json"
          }
        }
      }
    }
  },
  "definitions": {
    "AvailableWorkloadProfile": {
      "description": "A workload profile with specific hardware configure to run container apps.",
      "type": "object",
      "allOf": [
        {
          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
        }
      ],
      "properties": {
        "location": {
          "type": "string",
          "description": "Region of the workload profile."
        },
        "properties": {
          "description": "Revision resource specific properties",
          "type": "object",
          "properties": {
            "category": {
              "description": "Used to categorize workload profiles.",
              "type": "string"
            },
            "applicability": {
              "type": "string",
              "description": "indicates whether the profile is default for the location.",
              "enum": [
                "LocationDefault",
                "Custom"
              ],
              "x-ms-enum": {
                "name": "Applicability",
                "modelAsString": true
              }
            },
            "cores": {
              "type": "integer",
              "format": "int32",
              "description": "Number of cores in CPU."
            },
            "memoryGiB": {
              "type": "integer",
              "format": "int32",
              "description": "Memory in GiB."
            },
            "displayName": {
              "type": "string",
              "description": "The everyday name of the workload profile."
            }
          }
        }
      }
    },
    "AvailableWorkloadProfilesCollection": {
      "description": "Collection of available workload profiles in the location.",
      "required": [
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "description": "Collection of workload profiles.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/AvailableWorkloadProfile"
          }
        },
        "nextLink": {
          "description": "Link to next page of resources.",
          "type": "string",
          "readOnly": true
        }
      }
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  }
}