Endpoints - Suspend

Usługa:: Azure AI Services

Wersja interfejsu API:: 2026-01-01

Zawiesza punkt końcowy zidentyfikowany przez podany identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	ID zasobu, które powinno być UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikacja monitora statusu dla operacji. Jeśli nagłówek Operation-Id odpowiada istniejącej operacji, a żądanie nie jest identyczne z poprzednim, nie uda się z 400 Bad Request.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	Endpoint	Żądanie zostało przyjęte do przetworzenia, ale przetwarzanie nie zostało jeszcze zakończone. Nagłówki Operation-Id: string Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

202 Accepted

Endpoint

Żądanie zostało przyjęte do przetworzenia, ale przetwarzanie nie zostało jeszcze zakończone.

Nagłówki

Operation-Id: string
Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Suspend an endpoint

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Endpoint	Obiekt końcowy
EndpointKind	Rodzaj końcowy
EndpointProperties	Właściwości końcowe
Status	Status zasobu.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

Endpoint

Objekt

Obiekt końcowy

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Znacznik czasu utworzenia obiektu. Znacznik czasu jest kodowany jako format daty i godziny ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", patrz ).https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations
description	string	Opis końcowych punktów
displayName	string minLength: 1	Nazwa punktu końcowego
id	string (uuid)	Identyfikator końcowy
lastActionDateTime	string (date-time)	Znacznik czasu wpisania aktualnego statusu. Znacznik czasu jest kodowany jako format daty i godziny ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", patrz ).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]$	Identyfikator zasobu
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
properties	EndpointProperties	Właściwości końcowe
status	Status	Status zasobu.

EndpointKind

Wyliczenie

Rodzaj końcowy

Wartość	Opis
HighPerformance	HighPerformance
FastResume	FastResume

EndpointProperties

Objekt

Właściwości końcowe

Nazwa	Typ	Opis
kind	EndpointKind	Rodzaj końcowy

Status

Wyliczenie

Status zasobu.

Wartość	Opis
NotStarted	Nierozpoczęty
Running	Bieganie
Succeeded	Powodzenie
Failed	Niepowodzenie
Disabling	Wyłączanie
Disabled	Wyłączony