Endpoints - Create

Crée un point de terminaison.

PUT {endpoint}/customvoice/endpoints/{id}?api-version=2026-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string (uri)

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)

Identifiant de terminaison

api-version
query True

string

minLength: 1

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

En-tête de la demande

Nom Obligatoire Type Description
Operation-Id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

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

Corps de la demande

Nom Obligatoire Type Description
modelId True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID de ressource

projectId True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID de ressource

description

string

Description du point de terminaison

displayName

string

minLength: 1

Nom du point de terminaison

properties

EndpointProperties

Propriétés du point d’arrivée

status

Status

Statut d’une ressource.

Réponses

Nom Type Description
200 OK

Endpoint

La demande a réussi.

En-têtes

Operation-Location: string

201 Created

Endpoint

La requête a réussi et une nouvelle ressource a été créée en conséquence.

En-têtes

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Create an endpoint

Exemple de requête

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


{
  "description": "Endpoint for Jessica voice",
  "modelId": "Jessica",
  "projectId": "Jessica"
}

Exemple de réponse

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?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": "NotStarted"
}
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?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": "NotStarted"
}

Définitions

Nom Description
Azure.Core.Foundations.Error

Objet d’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Endpoint

Objet point de terminaison

EndpointKind

Type de point final

EndpointProperties

Propriétés du point d’arrivée

Status

Statut d’une ressource.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.

details

Azure.Core.Foundations.Error[]

Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

message

string

Représentation lisible par l’homme de l’erreur.

target

string

Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

Azure.Core.Foundations.Error

Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.

innererror

Azure.Core.Foundations.InnerError

Erreur interne.

Endpoint

Objet point de terminaison

Nom Type Description
createdDateTime

string (date-time)

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

description

string

Description du point de terminaison

displayName

string

minLength: 1

Nom du point de terminaison

id

string (uuid)

Identifiant de terminaison

lastActionDateTime

string (date-time)

Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir 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 de ressource

projectId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID de ressource

properties

EndpointProperties

Propriétés du point d’arrivée

status

Status

Statut d’une ressource.

EndpointKind

Type de point final

Valeur Description
HighPerformance

HighPerformance

FastResume

FastResume

EndpointProperties

Propriétés du point d’arrivée

Nom Type Description
kind

EndpointKind

Type de point final

Status

Statut d’une ressource.

Valeur Description
NotStarted

NotStarted

Running

Course à pied

Succeeded

Réussi

Failed

Échec

Disabling

Désactivation

Disabled

Désactivé