{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-cognitive-services/json-schema/microsoft-cognitive-services-deployment-list-result-schema.json",
  "title": "DeploymentListResult",
  "description": "The list of cognitive services accounts operation response.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-cognitive-services-deployments-api-openapi.yml#/components/schemas/DeploymentListResult",
  "type": "object",
  "properties": {
    "nextLink": {
      "type": "string",
      "description": "The link used to get the next page of Deployment."
    },
    "value": {
      "type": "array",
      "description": "Gets the list of Cognitive Services accounts Deployment and their properties.",
      "items": {
        "$ref": "#/$defs/Deployment"
      },
      "readOnly": true
    }
  },
  "$defs": {
    "CallRateLimit": {
      "type": "object",
      "description": "The call rate limit Cognitive Services account.",
      "properties": {
        "count": {
          "type": "number",
          "format": "float",
          "description": "The count value of Call Rate Limit."
        },
        "renewalPeriod": {
          "type": "number",
          "format": "float",
          "description": "The renewal period in seconds of Call Rate Limit."
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ThrottlingRule"
          },
          "x-ms-identifiers": [
            "key"
          ]
        }
      }
    },
    "Deployment": {
      "type": "object",
      "description": "Cognitive Services account deployment.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/DeploymentProperties",
          "description": "Properties of Cognitive Services account deployment."
        },
        "sku": {
          "$ref": "#/$defs/Sku",
          "description": "The resource model definition representing SKU"
        },
        "etag": {
          "type": "string",
          "description": "Resource Etag.",
          "readOnly": true
        },
        "tags": {
          "type": "object",
          "description": "Resource tags.",
          "additionalProperties": {
            "type": "string"
          },
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
        }
      ]
    },
    "DeploymentCapacitySettings": {
      "type": "object",
      "description": "Internal use only.",
      "properties": {
        "designatedCapacity": {
          "type": "integer",
          "format": "int32",
          "description": "The designated capacity.",
          "minimum": 0
        },
        "priority": {
          "type": "integer",
          "format": "int32",
          "description": "The priority of this capacity setting.",
          "minimum": 0
        }
      }
    },
    "DeploymentModel": {
      "type": "object",
      "description": "Properties of Cognitive Services account deployment model.",
      "properties": {
        "publisher": {
          "type": "string",
          "description": "Deployment model publisher."
        },
        "format": {
          "type": "string",
          "description": "Deployment model format."
        },
        "name": {
          "type": "string",
          "description": "Deployment model name."
        },
        "version": {
          "type": "string",
          "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API."
        },
        "source": {
          "type": "string",
          "description": "Optional. Deployment model source ARM resource ID."
        },
        "sourceAccount": {
          "type": "string",
          "format": "arm-id",
          "description": "Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.CognitiveServices/accounts"
              }
            ]
          }
        },
        "callRateLimit": {
          "$ref": "#/$defs/CallRateLimit",
          "description": "The call rate limit Cognitive Services account.",
          "readOnly": true
        }
      }
    },
    "DeploymentModelVersionUpgradeOption": {
      "type": "string",
      "description": "Deployment model version upgrade option.",
      "enum": [
        "OnceNewDefaultVersionAvailable",
        "OnceCurrentVersionExpired",
        "NoAutoUpgrade"
      ],
      "x-ms-enum": {
        "name": "DeploymentModelVersionUpgradeOption",
        "modelAsString": true,
        "values": [
          {
            "name": "OnceNewDefaultVersionAvailable",
            "value": "OnceNewDefaultVersionAvailable"
          },
          {
            "name": "OnceCurrentVersionExpired",
            "value": "OnceCurrentVersionExpired"
          },
          {
            "name": "NoAutoUpgrade",
            "value": "NoAutoUpgrade"
          }
        ]
      }
    },
    "DeploymentProperties": {
      "type": "object",
      "description": "Properties of Cognitive Services account deployment.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/DeploymentProvisioningState",
          "description": "Gets the status of the resource at the time the operation was called.",
          "readOnly": true
        },
        "model": {
          "$ref": "#/$defs/DeploymentModel",
          "description": "Properties of Cognitive Services account deployment model."
        },
        "contextCacheContainerId": {
          "type": "string",
          "description": "The resource ID of the context cache container associated with this deployment."
        },
        "scaleSettings": {
          "$ref": "#/$defs/DeploymentScaleSettings",
          "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)"
        },
        "capabilities": {
          "type": "object",
          "description": "The capabilities.",
          "additionalProperties": {
            "type": "string"
          },
          "readOnly": true
        },
        "raiPolicyName": {
          "type": "string",
          "description": "The name of RAI policy."
        },
        "callRateLimit": {
          "$ref": "#/$defs/CallRateLimit",
          "description": "The call rate limit Cognitive Services account.",
          "readOnly": true
        },
        "rateLimits": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ThrottlingRule"
          },
          "readOnly": true,
          "x-ms-identifiers": [
            "key"
          ]
        },
        "versionUpgradeOption": {
          "$ref": "#/$defs/DeploymentModelVersionUpgradeOption",
          "description": "Deployment model version upgrade option."
        },
        "dynamicThrottlingEnabled": {
          "type": "boolean",
          "description": "If the dynamic throttling is enabled.",
          "readOnly": true
        },
        "currentCapacity": {
          "type": "integer",
          "format": "int32",
          "description": "The current capacity."
        },
        "capacitySettings": {
          "$ref": "#/$defs/DeploymentCapacitySettings",
          "description": "Internal use only."
        },
        "parentDeploymentName": {
          "type": "string",
          "description": "The name of parent deployment."
        },
        "spilloverDeploymentName": {
          "type": "string",
          "description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit."
        },
        "serviceTier": {
          "$ref": "#/$defs/ServiceTier",
          "description": "The service tier for the deployment. Determines the pricing and performance level for request processing. Use 'Default' for standard pricing or 'Priority' for higher-priority processing with premium pricing. Note: Pause operations are only supported on Standard, DataZoneStandard, and GlobalStandard SKUs."
        },
        "deploymentState": {
          "$ref": "#/$defs/DeploymentState",
          "description": "The state of the deployment. Controls whether the deployment is accepting inference requests. Use 'Running' for active deployments that process requests, or 'Paused' to temporarily stop inference while preserving the deployment configuration."
        },
        "routing": {
          "$ref": "#/$defs/DeploymentRouting",
          "description": "Routing configuration for the model-router deployment. This property is only applicable when the deployed model is 'model-router' version 2025-11-18 or later. Allows you to select the models subset for routing and the routing mode (balanced, quality, cost) for routing across all supported models or the model subset."
        }
      }
    },
    "DeploymentProvisioningState": {
      "type": "string",
      "description": "Gets the status of the resource at the time the operation was called.",
      "enum": [
        "Accepted",
        "Creating",
        "Deleting",
        "Moving",
        "Failed",
        "Succeeded",
        "Disabled",
        "Canceled"
      ],
      "x-ms-enum": {
        "name": "DeploymentProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Accepted",
            "value": "Accepted"
          },
          {
            "name": "Creating",
            "value": "Creating"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Moving",
            "value": "Moving"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Disabled",
            "value": "Disabled"
          },
          {
            "name": "Canceled",
            "value": "Canceled"
          }
        ]
      },
      "readOnly": true
    },
    "DeploymentRouting": {
      "type": "object",
      "description": "Routing configuration for the model-router deployment. Specifies how requests are routed across multiple models.",
      "properties": {
        "mode": {
          "type": "string",
          "description": "The model-router routing mode that determines how requests are distributed across models.",
          "default": "balanced",
          "enum": [
            "cost",
            "balanced",
            "quality"
          ],
          "x-ms-enum": {
            "name": "RoutingMode",
            "modelAsString": true,
            "values": [
              {
                "name": "Cost",
                "value": "cost",
                "description": "Route requests to minimize cost while meeting performance requirements."
              },
              {
                "name": "Balanced",
                "value": "balanced",
                "description": "Balance cost and quality when routing requests across models."
              },
              {
                "name": "Quality",
                "value": "quality",
                "description": "Route requests to maximize quality regardless of cost."
              }
            ]
          }
        },
        "models": {
          "type": "array",
          "description": "Optional. The list of model-router supported models that the model router can use to route requests across. If not specified, the model router will route to all available models specified in the model-router version.",
          "items": {
            "$ref": "#/$defs/DeploymentModel"
          },
          "x-ms-identifiers": [
            "name",
            "version"
          ]
        }
      }
    },
    "DeploymentScaleSettings": {
      "type": "object",
      "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)",
      "properties": {
        "scaleType": {
          "$ref": "#/$defs/DeploymentScaleType",
          "description": "Deployment scale type."
        },
        "capacity": {
          "type": "integer",
          "format": "int32",
          "description": "Deployment capacity."
        },
        "activeCapacity": {
          "type": "integer",
          "format": "int32",
          "description": "Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`.",
          "readOnly": true
        }
      }
    },
    "DeploymentScaleType": {
      "type": "string",
      "description": "Deployment scale type.",
      "enum": [
        "Standard",
        "Manual"
      ],
      "x-ms-enum": {
        "name": "DeploymentScaleType",
        "modelAsString": true,
        "values": [
          {
            "name": "Standard",
            "value": "Standard"
          },
          {
            "name": "Manual",
            "value": "Manual"
          }
        ]
      }
    },
    "DeploymentState": {
      "type": "string",
      "description": "The state of the deployment. Controls whether the deployment is accepting inference requests. Use 'Running' for active deployments that process requests, or 'Paused' to temporarily stop inference while preserving the deployment configuration.",
      "enum": [
        "Running",
        "Paused"
      ],
      "x-ms-enum": {
        "name": "DeploymentState",
        "modelAsString": true,
        "values": [
          {
            "name": "Running",
            "value": "Running",
            "description": "The deployment is running and accepting inference requests."
          },
          {
            "name": "Paused",
            "value": "Paused",
            "description": "The deployment is paused and not accepting inference requests."
          }
        ]
      }
    },
    "RequestMatchPattern": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "method": {
          "type": "string"
        }
      }
    },
    "ServiceTier": {
      "type": "string",
      "description": "The service tier for the deployment. Determines the pricing and performance level for request processing. Use 'Default' for standard pricing or 'Priority' for higher-priority processing with premium pricing. Note: Pause operations are only supported on Standard, DataZoneStandard, and GlobalStandard SKUs.",
      "enum": [
        "Default",
        "Priority"
      ],
      "x-ms-enum": {
        "name": "ServiceTier",
        "modelAsString": true,
        "values": [
          {
            "name": "Default",
            "value": "Default",
            "description": "Default service tier meaning the request will be processed with the standard pricing and performance for the selected model."
          },
          {
            "name": "Priority",
            "value": "Priority",
            "description": "Priority service tier meaning the request will be processed with higher pricing and performance for the selected model."
          }
        ]
      }
    },
    "Sku": {
      "type": "object",
      "description": "The resource model definition representing SKU",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the SKU. Ex - P3. It is typically a letter+number code"
        },
        "tier": {
          "$ref": "#/$defs/SkuTier",
          "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
        },
        "size": {
          "type": "string",
          "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
        },
        "family": {
          "type": "string",
          "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
        },
        "capacity": {
          "type": "integer",
          "format": "int32",
          "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
        }
      },
      "required": [
        "name"
      ]
    },
    "SkuTier": {
      "type": "string",
      "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
      "enum": [
        "Free",
        "Basic",
        "Standard",
        "Premium",
        "Enterprise"
      ],
      "x-ms-enum": {
        "name": "SkuTier",
        "modelAsString": true,
        "values": [
          {
            "name": "Free",
            "value": "Free"
          },
          {
            "name": "Basic",
            "value": "Basic"
          },
          {
            "name": "Standard",
            "value": "Standard"
          },
          {
            "name": "Premium",
            "value": "Premium"
          },
          {
            "name": "Enterprise",
            "value": "Enterprise"
          }
        ]
      }
    },
    "ThrottlingRule": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "renewalPeriod": {
          "type": "number",
          "format": "float"
        },
        "count": {
          "type": "number",
          "format": "float"
        },
        "minCount": {
          "type": "number",
          "format": "float"
        },
        "dynamicThrottlingEnabled": {
          "type": "boolean"
        },
        "matchPatterns": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RequestMatchPattern"
          },
          "x-ms-identifiers": [
            "path",
            "method"
          ]
        }
      }
    }
  }
}