Endpoints - Suspend

サービス:

Azure AI Services

API バージョン:

2026-01-01

与えられたIDで識別されたエンドポイントを一時停止します。

POST {endpoint}/customvoice/endpoints/{id}:suspend?api-version=2026-01-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://eastus.api.cognitive.microsoft.com)。
id	path	True	string (uuid)	リソースIDはUUIDであるべきです。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	作戦のステータスモニターのID。 Operation-Id ヘッダーが既存の操作と一致し、リクエストが前のリクエストと同一でない場合、400 Bad Requestで失敗します。

応答

名前	型	説明
202 Accepted	Endpoint	要求は処理のために受け入れ済みですが、処理はまだ完了していません。 ヘッダー Operation-Id: string Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Suspend an endpoint

要求のサンプル

HTTP

POST {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb:suspend?api-version=2026-01-01

応答のサンプル

状態コード:

202

Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2026-01-01

{
  "description": "Endpoint for Jessica voice",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "modelId": "Jessica",
  "projectId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "Disabling"
}

定義

名前	説明
Azure.Core.Foundations.Error	エラー オブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。
Endpoint	エンドポイントオブジェクト
EndpointKind	エンドポイントの種類
EndpointProperties	エンドポイントの性質
Status	資源のステータス。

Azure.Core.Foundations.Error

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラー オブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

Endpoint

Object

エンドポイントオブジェクト

名前	型	説明
createdDateTime	string (date-time)	オブジェクトが作成されたタイムスタンプ。 タイムスタンプはISO 8601の日付と時間フォーマット(「YYYY-MM-DDThh:mm:ssZ」、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照)でエンコードされています。
description	string	エンドポイントの説明
displayName	string minLength: 1	エンドポイント名
id	string (uuid)	エンドポイントID
lastActionDateTime	string (date-time)	現在のステータスが入力されたタイムスタンプ。 タイムスタンプはISO 8601の日付と時間フォーマット(「YYYY-MM-DDThh:mm:ssZ」、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照)でエンコードされています。
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	リソース ID
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	リソース ID
properties	EndpointProperties	エンドポイントの性質
status	Status	資源のステータス。

EndpointKind

列挙

エンドポイントの種類

値	説明
HighPerformance	HighPerformance
FastResume	ファスト履歴書

EndpointProperties

Object

エンドポイントの性質

名前	型	説明
kind	EndpointKind	エンドポイントの種類

Status

列挙

資源のステータス。

値	説明
NotStarted	未開始
Running	Running
Succeeded	成功しました
Failed	失敗
Disabling	無効化
Disabled	Disabled