Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{

Check notice on line 1 in specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json

View workflow job for this annotation

GitHub Actions / TypeSpec Requirement

Your service description will soon be required to convert from OpenAPI to TypeSpec. See https://aka.ms/azsdk/typespec.
"swagger": "2.0",
"info": {
"title": "CognitiveServicesManagementClient",
Expand Down Expand Up @@ -1664,6 +1664,98 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/pause": {
"post": {
"tags": [
"Deployments"
],
"operationId": "Deployments_Pause",
"summary": "Pause a deployment",
"description": "Pauses inferencing on a deployment by setting the deploymentState to 'Paused' (see #/definitions/DeploymentProperties/properties/deploymentState). Only Standard, DataZoneStandard, and GlobalStandard SKUs support this operation. Inference requests to the paused deployment endpoint will receive HTTP 423 (Locked). This operation is idempotent.",
"x-ms-examples": {
"PauseDeployment": {
"$ref": "./examples/PauseDeployment.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/deploymentNameForActionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Deployment paused successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/resume": {
"post": {
"tags": [
"Deployments"
],
"operationId": "Deployments_Resume",
"summary": "Resume a deployment",
"description": "Resumes inferencing on a previously paused deployment by setting the deploymentState to 'Running' (see #/definitions/DeploymentProperties/properties/deploymentState). This operation is idempotent and can be safely called on already running deployments.",
"x-ms-examples": {
"ResumeDeployment": {
"$ref": "./examples/ResumeDeployment.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/deploymentNameForActionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Deployment resumed successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans": {
"get": {
"tags": [
Expand Down Expand Up @@ -8116,6 +8208,52 @@
"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": {
"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-nullable": true,
"x-ms-enum": {
"name": "ServiceTier",
"modelAsString": true,
"values": [
{
"value": "Default",
"description": "Default service tier meaning the request will be processed with the standard pricing and performance for the selected model."
},
{
"value": "Priority",
"description": "Priority service tier meaning the request will be processed with higher pricing and performance for the selected model."
}
]
}
},
"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-nullable": true,
"x-ms-enum": {
"name": "DeploymentState",
"modelAsString": true,
"values": [
{
"value": "Running",
"description": "The deployment is running and accepting inference requests."
},
{
"value": "Paused",
"description": "The deployment is paused and not accepting inference requests."
}
]
}
}
},
"description": "Properties of Cognitive Services account deployment."
Expand Down Expand Up @@ -11675,6 +11813,15 @@
"description": "The name of the deployment associated with the Cognitive Services Account",
"x-ms-parameter-location": "method"
},
"deploymentNameForActionParameter": {
"name": "deploymentName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
"description": "The name of the deployment for pause/resume actions",
"x-ms-parameter-location": "method"
},
"raiPolicyNameParameter": {
"name": "raiPolicyName",
"in": "path",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
"name": "ada",
"version": "1"
},
"serviceTier": "Default",
"deploymentState": "Running",
"provisioningState": "Succeeded"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
"name": "ada",
"version": "1"
},
"serviceTier": "Default",
"deploymentState": "Running",
"provisioningState": "Succeeded"
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"parameters": {
"api-version": "2025-10-01-preview",
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "resourceGroupName",
"accountName": "accountName",
"deploymentName": "deploymentName"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
"name": "deploymentName",
"type": "Microsoft.CognitiveServices/accounts/deployments",
"sku": {
"name": "Standard",
"capacity": 1
},
"properties": {
"model": {
"format": "OpenAI",
"name": "gpt-4",
"version": "0613"
},
"deploymentState": "Paused",
"provisioningState": "Succeeded"
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
"format": "OpenAI",
"name": "ada",
"version": "1"
}
},
"serviceTier": "Priority",
"deploymentState": "Running"
}
}
},
Expand All @@ -35,6 +37,8 @@
"name": "ada",
"version": "1"
},
"serviceTier": "Priority",
"deploymentState": "Running",
"provisioningState": "Succeeded"
}
}
Expand All @@ -54,6 +58,8 @@
"name": "ada",
"version": "1"
},
"serviceTier": "Priority",
"deploymentState": "Running",
"provisioningState": "Accepted"
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"parameters": {
"api-version": "2025-10-01-preview",
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "resourceGroupName",
"accountName": "accountName",
"deploymentName": "deploymentName"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
"name": "deploymentName",
"type": "Microsoft.CognitiveServices/accounts/deployments",
"sku": {
"name": "Standard",
"capacity": 1
},
"properties": {
"model": {
"format": "OpenAI",
"name": "gpt-4",
"version": "0613"
},
"deploymentState": "Running",
"provisioningState": "Succeeded"
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
"name": "ada",
"version": "1"
},
"serviceTier": "Priority",
"deploymentState": "Paused",
"provisioningState": "Succeeded"
}
}
Expand Down
Loading