Endpoints - Suspend

Service:

Azure AI Services

API-versie:

2024-02-01-preview

Onderbreekt het eindpunt dat is geïdentificeerd door de opgegeven id.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	De resource-id, die UUID moet zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Geef hier uw spraakresourcesleutel op.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Id van de statusmonitor voor de bewerking. Als de Operation-Id header overeenkomt met een bestaande bewerking en de aanvraag niet identiek is aan de vorige aanvraag, mislukt deze met een 400 ongeldige aanvraag.

Antwoorden

Name	Type	Description
202 Accepted	Endpoint	Geaccepteerd Kopteksten Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier uw spraakresourcesleutel op.

Type: apiKey
In: header

Voorbeelden

Suspend an endpoint

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
Endpoint	Eindpuntobject
EndpointKind	Eindpunttype
EndpointProperties	Eindpunteigenschappen
Error	Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.
ErrorCode	Foutcode op het hoogste niveau
ErrorResponse	Foutreactie volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
Status	Status van een resource.

Endpoint

Object

Eindpuntobject

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	Beschrijving van eindpunt
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: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
properties	EndpointProperties	Eindpunteigenschappen
status	Status	Status van een resource.

EndpointKind

Inventarisatie

Eindpunttype

Waarde	Description
FastResume
HighPerformance

EndpointProperties

Object

Eindpunteigenschappen

Name	Type	Description
kind	EndpointKind	Eindpunttype

Error

Object

Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

Name	Type	Description
code	ErrorCode	Foutcode op het hoogste niveau
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
message	string	Foutbericht op het hoogste niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

ErrorCode

Inventarisatie

Foutcode op het hoogste niveau

Waarde	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

Foutreactie volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
error	Error	Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

InnerError

Object

Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).

Name	Type	Description
code	string	Gedetailleerde foutcode voor diagnostische gegevens.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
message	string	Gedetailleerd foutbericht.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

Status

Inventarisatie

Status van een resource.

Waarde	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded