Partager via


Endpoints - Suspend

Suspend le point de terminaison identifié par l’ID donné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://eastus.api.cognitive.microsoft.com).

id
path True

string

uuid

ID de ressource, qui doit être UUID.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
Ocp-Apim-Subscription-Key True

string

Fournissez votre clé de ressource Speech ici.

Operation-Id

string

ID du moniteur d’état de l’opération. Si l’en-tête Operation-Id correspond à une opération existante et que la demande n’est pas identique à la demande précédente, elle échoue avec une requête incorrecte 400.

Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Réponses

Nom Type Description
202 Accepted

Endpoint

Accepté

En-têtes

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

ErrorResponse

Une erreur est survenue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de ressource Speech ici.

Type: apiKey
Dans: header

Exemples

Suspend an endpoint

Exemple de requête

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


Exemple de réponse

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"
}

Définitions

Nom Description
Endpoint

Objet Endpoint

EndpointKind

Type de point de terminaison

EndpointProperties

Propriétés du point de terminaison

Error

L’erreur de niveau supérieur suit les instructions relatives à l’API REST Microsoft Azure, disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

ErrorCode

Code d’erreur de niveau supérieur

ErrorResponse

La réponse d’erreur suit les instructions de l’API REST Microsoft Azure, disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

InnerError

L’erreur interne suit les instructions de l’API REST Microsoft Azure disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, l’erreur interne (cela peut être imbriqué).

Status

État d’une ressource.

Endpoint

Objet Endpoint

Nom Type Description
createdDateTime

string

Horodatage lors de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

Description du point de terminaison

displayName

string

Nom du point de terminaison

id

string

ID de point de terminaison

lastActionDateTime

string

Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

modelId

string

ID de la ressource

projectId

string

ID de la ressource

properties

EndpointProperties

Propriétés du point de terminaison

status

Status

État d’une ressource.

EndpointKind

Type de point de terminaison

Nom Type Description
FastResume

string

HighPerformance

string

EndpointProperties

Propriétés du point de terminaison

Nom Type Description
kind

EndpointKind

Type de point de terminaison

Error

L’erreur de niveau supérieur suit les instructions relatives à l’API REST Microsoft Azure, disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

Nom Type Description
code

ErrorCode

Code d’erreur de niveau supérieur

details

Error[]

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.

innererror

InnerError

L’erreur interne suit les instructions de l’API REST Microsoft Azure disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, l’erreur interne (cela peut être imbriqué).

message

string

Message d’erreur de niveau supérieur.

target

string

Source de l’erreur. Par exemple, il s’agirait de « model » ou de « model ID » en cas de modèle non valide.

ErrorCode

Code d’erreur de niveau supérieur

Nom Type Description
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

La réponse d’erreur suit les instructions de l’API REST Microsoft Azure, disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nom Type Description
error

Error

L’erreur de niveau supérieur suit les instructions relatives à l’API REST Microsoft Azure, disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

InnerError

L’erreur interne suit les instructions de l’API REST Microsoft Azure disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, l’erreur interne (cela peut être imbriqué).

Nom Type Description
code

string

Code d’erreur détaillé pour faciliter le diagnostic.

innererror

InnerError

L’erreur interne suit les instructions de l’API REST Microsoft Azure disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, l’erreur interne (cela peut être imbriqué).

message

string

Message d’erreur détaillé.

target

string

Source de l’erreur. Par exemple, il s’agirait de « model » ou de « model ID » en cas de modèle non valide.

Status

État d’une ressource.

Nom Type Description
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string