Endpoints - Suspend

Služba:: Azure AI Services

Verze rozhraní API:: 2026-01-01

Pozastaví koncový bod identifikovaný daným ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	ID zdroje, které by mělo být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID monitoru stavu pro danou operaci. Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není totožný s předchozím požadavkem, selže s 400 špatným požadavkem.

Odpovědi

Name	Typ	Description
202 Accepted	Endpoint	Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Id: string Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

202 Accepted

Endpoint

Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Hlavičky

Operation-Id: string
Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Suspend an endpoint

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Endpoint	Objekt koncového bodu
EndpointKind	Typ koncových stran
EndpointProperties	Vlastnosti koncových zařízení
Status	Stav zdroje.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

Endpoint

Objekt

Objekt koncového bodu

Name	Typ	Description
createdDateTime	string (date-time)	Časové razítko při vytvoření objektu. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Popis koncového bodu
displayName	string minLength: 1	Název koncového bodu
id	string (uuid)	Endpoint Id
lastActionDateTime	string (date-time)	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz 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 prostředku
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID prostředku
properties	EndpointProperties	Vlastnosti koncových zařízení
status	Status	Stav zdroje.

EndpointKind

Výčet

Typ koncových stran

Hodnota	Description
HighPerformance	HighPerformance
FastResume	FastResume

EndpointProperties

Objekt

Vlastnosti koncových zařízení

Name	Typ	Description
kind	EndpointKind	Typ koncových stran

Status

Výčet

Stav zdroje.

Hodnota	Description
NotStarted	Není zahájeno
Running	Running
Succeeded	Úspěch
Failed	Nezdařilo se
Disabling	Zakázání
Disabled	Disabled