次の方法で共有

Endpoints - Suspend

サービス:
Azure AI Services
API バージョン:
2024-02-01-preview

指定された ID で識別されるエンドポイントを中断します。

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

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://eastus.api.cognitive.microsoft.com)。
id
 path True

string (uuid)

リソース ID。UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

ここで Speech リソース キーを指定します。
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

ErrorResponse

エラーが発生しました。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

ここで Speech リソース キーを指定します。

型: apiKey
/: header

例

Suspend an endpoint

要求のサンプル

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

応答のサンプル

状態コード:
202 
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2024-02-01-preview
Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f
{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "Disabling",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名前 説明
Endpoint

Endpoint オブジェクト
EndpointKind

エンドポイントの種類
EndpointProperties

エンドポイントのプロパティ
Error

最上位レベルのエラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、エラー コード、メッセージ、詳細、ターゲットを含む最上位レベルのエラーと、よりわかりやすい詳細を含む内部エラーが含まれます。
ErrorCode

最上位のエラー コード
ErrorResponse

エラー応答は、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。
InnerError

内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
Status

リソースの状態。

Endpoint

Object

Endpoint オブジェクト

名前 型 説明
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
FastResume

EndpointProperties

Object

エンドポイントのプロパティ

名前 型 説明
kind

EndpointKind

エンドポイントの種類

Error

Object

最上位レベルのエラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、エラー コード、メッセージ、詳細、ターゲットを含む最上位レベルのエラーと、よりわかりやすい詳細を含む内部エラーが含まれます。

名前 型 説明
code

ErrorCode

最上位のエラー コード
details

Error[]

エラーや予想されるポリシーに関するその他のサポートの詳細。
innererror

InnerError

内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message

string

最上位レベルのエラー メッセージ。
target

string

エラーの原因。 たとえば、無効なモデルの場合は "model" または "model id" になります。

ErrorCode

列挙

最上位のエラー コード

値 説明
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

エラー応答は、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。

名前 型 説明
error

Error

最上位レベルのエラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、エラー コード、メッセージ、詳細、ターゲットを含む最上位レベルのエラーと、よりわかりやすい詳細を含む内部エラーが含まれます。

InnerError

Object

内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。

名前 型 説明
code

string

診断に役立つ詳細なエラー コード。
innererror

InnerError

内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message

string

詳細なエラー メッセージ。
target

string

エラーの原因。 たとえば、無効なモデルの場合は "model" または "model id" になります。

Status

列挙

リソースの状態。

値 説明
NotStarted
Running
Succeeded
Failed
Disabling
Disabled