Endpoints - Suspend
Schorst het eindpunt dat door de gegeven ID is geïdentificeerd.
POST {endpoint}/customvoice/endpoints/{id}:suspend?api-version=2026-01-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com). |
|
id
|
path | True |
string (uuid) |
De resource ID, die UUID zou moeten zijn. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Operation-Id |
string minLength: 3maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$ |
ID van de statusmonitor voor de operatie. Als de Operation-Id header overeenkomt met een bestaande bewerking en het verzoek niet identiek is aan het vorige verzoek, zal het falen met een 400 Bad Request. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten
|
|
| Other Status Codes |
Een onverwachte foutreactie. Kopteksten x-ms-error-code: string |
Beveiliging
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| https://cognitiveservices.azure.com/.default |
Voorbeelden
Suspend an endpoint
Voorbeeldaanvraag
POST {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb:suspend?api-version=2026-01-01
Voorbeeldrespons
Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?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": "Disabling"
}
Definities
| Name | Description |
|---|---|
|
Azure. |
Het foutobject. |
|
Azure. |
Een antwoord met foutdetails. |
|
Azure. |
Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Endpoint |
Eindobject |
|
Endpoint |
Eindpunt type |
|
Endpoint |
Eindpunteigenschappen |
| Status |
Status van een hulpbron. |
Azure.Core.Foundations.Error
Het foutobject.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| details |
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout. |
|
| innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
| message |
string |
Een leesbare weergave van de fout. |
| target |
string |
Het doel van de fout. |
Azure.Core.Foundations.ErrorResponse
Een antwoord met foutdetails.
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
Azure.Core.Foundations.InnerError
Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| innererror |
Interne fout. |
Endpoint
Eindobject
| Name | Type | Description |
|---|---|---|
| createdDateTime |
string (date-time) |
De tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
| description |
string |
Eindpuntbeschrijving |
| displayName |
string minLength: 1 |
Eindpuntnaam |
| id |
string (uuid) |
Eindpunt-ID |
| lastActionDateTime |
string (date-time) |
De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
| modelId |
string minLength: 3maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$ |
Resource-id |
| projectId |
string minLength: 3maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$ |
Resource-id |
| properties |
Eindpunteigenschappen |
|
| status |
Status van een hulpbron. |
EndpointKind
Eindpunt type
| Waarde | Description |
|---|---|
| HighPerformance |
HighPerformance |
| FastResume |
FastResume |
EndpointProperties
Eindpunteigenschappen
| Name | Type | Description |
|---|---|---|
| kind |
Eindpunt type |
Status
Status van een hulpbron.
| Waarde | Description |
|---|---|
| NotStarted |
Niet gestart |
| Running |
Hardlopen |
| Succeeded |
Geslaagd |
| Failed |
Mislukt |
| Disabling |
Uitschakelen |
| Disabled |
Disabled |