Endpoints - Create

Dienst:: Azure AI Services

API-Version:: 2026-01-01

Erstellt einen neuen Endpunkt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Endpunkt-ID
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID des Statusmonitors für die Operation. Wenn der Operation-Id-Header mit einer bestehenden Operation übereinstimmt und die Anfrage nicht identisch mit der vorherigen Anfrage ist, schlägt sie mit einer 400 Bad Request fehl.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
modelId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
description		string	Endpunktbeschreibung
displayName		string minLength: 1	Endpunktname
properties		EndpointProperties	Endpunkteigenschaften
status		Status	Status einer Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	Endpoint	Die Anforderung ist erfolgreich. Header Operation-Location: string
201 Created	Endpoint	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt. Header Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

Endpoint

Die Anforderung ist erfolgreich.

Header

Operation-Location: string

201 Created

Endpoint

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.

Header

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Create an endpoint

Beispielanforderung

HTTP

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


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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Endpoint	Endpunktobjekt
EndpointKind	Endpunkttyp
EndpointProperties	Endpunkteigenschaften
Status	Status einer Ressource.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

Endpoint

Objekt

Endpunktobjekt

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Endpunktbeschreibung
displayName	string minLength: 1	Endpunktname
id	string (uuid)	Endpunkt-ID
lastActionDateTime	string (date-time)	Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe 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]$	Ressourcen-ID
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
properties	EndpointProperties	Endpunkteigenschaften
status	Status	Status einer Ressource.

EndpointKind

Enumeration

Endpunkttyp

Wert	Beschreibung
HighPerformance	HighPerformance
FastResume	FastResume

EndpointProperties

Objekt

Endpunkteigenschaften

Name	Typ	Beschreibung
kind	EndpointKind	Endpunkttyp

Status

Enumeration

Status einer Ressource.

Wert	Beschreibung
NotStarted	Nicht gestartet
Running	Laufen
Succeeded	Erfolgreich
Failed	gescheitert
Disabling	Deaktivieren
Disabled	Deaktiviert