Endpoints - Suspend

Tjänst:

Cognitive Services - Custom Voice

API-version:

2023-12-01-preview

Pausar slutpunkten som identifieras av det angivna ID:t.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).
id	path	True	string uuid	Resurs-ID, som ska vara UUID.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.
Operation-Id		string	ID för statusövervakaren för åtgärden. Om Operation-Id-huvudet matchar en befintlig åtgärd och begäran inte är identisk med den tidigare begäran misslyckas den med en 400 Felaktig begäran. Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Svar

Name	Typ	Description
202 Accepted	Endpoint	Har godkänts Sidhuvuden Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

Suspend an endpoint

Sample request

HTTP

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

Sample response

Status code:

202

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2023-12-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"
}

Definitioner

Name	Description
Endpoint	Slutpunktsobjekt
EndpointKind	Typ av slutpunkt
EndpointProperties	Slutpunktsegenskaper
Error	Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.
ErrorCode	Felkod på den översta nivån
ErrorResponse	Felsvaret följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
Status	Status för en resurs.

Endpoint

Slutpunktsobjekt

Name	Typ	Description
createdDateTime	string	Tidsstämpeln när objektet skapades. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Beskrivning av slutpunkt
displayName	string	Slutpunktsnamn
id	string	Slutpunkts-ID
lastActionDateTime	string	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId	string	Resurs-ID
projectId	string	Resurs-ID
properties	EndpointProperties	Slutpunktsegenskaper
status	Status	Status för en resurs.

EndpointKind

Typ av slutpunkt

Name	Typ	Description
FastResume	string
HighPerformance	string

EndpointProperties

Slutpunktsegenskaper

Name	Typ	Description
kind	EndpointKind	Typ av slutpunkt

Error

Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name	Typ	Description
code	ErrorCode	Felkod på den översta nivån
details	Error[]	Ytterligare stödjande information om fel- och/eller förväntade principer.
innererror	InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Felmeddelande på den översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" om modellen är ogiltig.

ErrorCode

Felkod på den översta nivån

Name	Typ	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Felsvaret följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name	Typ	Description
code	string	Detaljerad felkod för att hjälpa till med diagnostiken.
innererror	InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Detaljerat felmeddelande.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" om modellen är ogiltig.

Status

Status för en resurs.

Name	Typ	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string