Endpoints - Suspend

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-02-01-preview

Sospende l'endpoint identificato dall'ID specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://eastus.api.cognitive.microsoft.com).
id
 path True

string

uuid

ID risorsa, che deve essere UUID.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Ocp-Apim-Subscription-Key True

string

Specificare qui la chiave della risorsa Voce.
Operation-Id

string

ID del monitoraggio dello stato per l'operazione. Se l'intestazione Operation-Id corrisponde a un'operazione esistente e la richiesta non è identica alla richiesta precedente, avrà esito negativo con una richiesta non valida 400.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Risposte

Nome Tipo Descrizione
202 Accepted

Endpoint

Accettato

Intestazioni

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

Si è verificato un errore.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave della risorsa Voce.

Tipo: apiKey
In: header

Esempio

Suspend an endpoint

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
Endpoint

Oggetto Endpoint
EndpointKind

Tipo di endpoint
EndpointProperties

Proprietà dell'endpoint
Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.
ErrorCode

Codice di errore di primo livello
ErrorResponse

Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
Status

Stato di una risorsa.

Endpoint

Oggetto Endpoint

Nome Tipo Descrizione
createdDateTime

string

Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description

string

Descrizione dell'endpoint
displayName

string

Nome dell'endpoint
id

string

Endpoint Id
lastActionDateTime

string

Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId

string

ID risorsa
projectId

string

ID risorsa
properties

EndpointProperties

Proprietà dell'endpoint
status

Status

Stato di una risorsa.

EndpointKind

Tipo di endpoint

Nome Tipo Descrizione
FastResume

string

HighPerformance

string

EndpointProperties

Proprietà dell'endpoint

Nome Tipo Descrizione
kind

EndpointKind

Tipo di endpoint

Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

Nome Tipo Descrizione
code

ErrorCode

Codice di errore di primo livello
details

Error[]

Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innererror

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message

string

Messaggio di errore di primo livello.
target

string

Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

ErrorCode

Codice di errore di primo livello

Nome Tipo Descrizione
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome Tipo Descrizione
error

Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).

Nome Tipo Descrizione
code

string

Codice di errore dettagliato per facilitare la diagnostica.
innererror

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message

string

Messaggio di errore dettagliato.
target

string

Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

Status

Stato di una risorsa.

Nome Tipo Descrizione
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string