Endpoints - Create

Létrehoz egy új végpontot.

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

URI-paraméterek

Név In Kötelező Típus Description
endpoint
path True

string (uri)

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://eastus.api.cognitive.microsoft.com).

id
path True

string (uuid)

Endpoint Id

api-version
query True

string

minLength: 1

A művelethez használandó API-verzió.

Kérelem fejléce

Név Kötelező Típus Description
Operation-Id

string

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

Az operáció állapotmonitorjának azonosítója. Ha a Operation-Id fejléc egyezik egy meglévő művelettel, és a kérés nem egyezik meg az előző kéréssel, akkor egy 400 rossz kéréssel megbukik.

Kérelem törzse

Név Kötelező Típus Description
modelId True

string

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

Erőforrás-azonosító

projectId True

string

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

Erőforrás-azonosító

description

string

Végpont leírása

displayName

string

minLength: 1

Végpont neve

properties

EndpointProperties

Végpont tulajdonságok

status

Status

Egy erőforrás állapota.

Válaszok

Név Típus Description
200 OK

Endpoint

A kérés sikeres volt.

Fejlécek

Operation-Location: string

201 Created

Endpoint

A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Fejlécek

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név Description
https://cognitiveservices.azure.com/.default

Példák

Create an endpoint

Mintakérelem

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


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

Mintaválasz

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

Definíciók

Név Description
Azure.Core.Foundations.Error

A hibaobjektum.

Azure.Core.Foundations.ErrorResponse

Hibaadatokat tartalmazó válasz.

Azure.Core.Foundations.InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Azure REST API irányelvek szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Endpoint

Endpoint object

EndpointKind

Végpont típus

EndpointProperties

Végpont tulajdonságok

Status

Egy erőforrás állapota.

Azure.Core.Foundations.Error

A hibaobjektum.

Név Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.

details

Azure.Core.Foundations.Error[]

A jelentett hibához vezető konkrét hibák részleteinek tömbje.

innererror

Azure.Core.Foundations.InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

message

string

A hiba ember által olvasható ábrázolása.

target

string

A hiba célja.

Azure.Core.Foundations.ErrorResponse

Hibaadatokat tartalmazó válasz.

Név Típus Description
error

Azure.Core.Foundations.Error

A hibaobjektum.

Azure.Core.Foundations.InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Azure REST API irányelvek szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Név Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.

innererror

Azure.Core.Foundations.InnerError

Belső hiba.

Endpoint

Endpoint object

Név Típus Description
createdDateTime

string (date-time)

Az objektum létrehozásakor megadott időbélyeg. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

Végpont leírása

displayName

string

minLength: 1

Végpont neve

id

string (uuid)

Endpoint Id

lastActionDateTime

string (date-time)

Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd 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]$

Erőforrás-azonosító

projectId

string

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

Erőforrás-azonosító

properties

EndpointProperties

Végpont tulajdonságok

status

Status

Egy erőforrás állapota.

EndpointKind

Végpont típus

Érték Description
HighPerformance

HighPerformance

FastResume

FastResume

EndpointProperties

Végpont tulajdonságok

Név Típus Description
kind

EndpointKind

Végpont típus

Status

Egy erőforrás állapota.

Érték Description
NotStarted

Még nem kezdődött el

Running

Futás közben

Succeeded

Sikerült

Failed

Meghiúsult

Disabling

Letiltása

Disabled

Disabled