Endpoints - Suspend

Referência

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Suspende o ponto final identificado pelo ID especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string uuid	O ID do recurso, que deve ser UUID.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description

Ocp-Apim-Subscription-Key

True

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a sua chave de recurso de Voz aqui.
Operation-Id		string	ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um Pedido Incorreto 400. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Forneça a sua chave de recurso de Voz aqui.

Operation-Id

string

ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um Pedido Incorreto 400.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Respostas

Name	Tipo	Description
202 Accepted	Endpoint	Aceite Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro.

Name

Tipo

Description

202 Accepted

Endpoint

Aceite

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a sua chave de recurso de Voz aqui.

Type: apiKey
In: header

Exemplos

Suspend an endpoint

Sample Request

HTTP

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

Sample Response

Status code:: 202

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2023-12-01-preview
Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f

Response Body

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

Definições

Name	Description
Endpoint	Objeto de ponto final
EndpointKind	Tipo de ponto final
EndpointProperties	Propriedades do ponto final
Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.
ErrorCode	Código de erro de nível superior
ErrorResponse	A resposta ao erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
Status	Estado de um recurso.

Endpoint

Objeto de ponto final

Name	Tipo	Description
createdDateTime	string	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descrição do ponto final
displayName	string	Nome do ponto final
id	string	ID do Ponto Final
lastActionDateTime	string	O carimbo de data/hora em que o estado atual foi introduzido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId	string	ID do recurso
projectId	string	ID do recurso
properties	EndpointProperties	Propriedades do ponto final
status	Status	Estado de um recurso.

EndpointKind

Tipo de ponto final

Name	Tipo	Description
FastResume	string
HighPerformance	string

EndpointProperties

Propriedades do ponto final

Name	Tipo	Description
kind	EndpointKind	Tipo de ponto final

Error

O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

Name	Tipo	Description
code	ErrorCode	Código de erro de nível superior
details	Error[]	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
message	string	Mensagem de erro de nível superior.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "ID de modelo" em caso de modelo inválido.

ErrorCode

Código de erro de nível superior

Name	Tipo	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

A resposta ao erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Tipo	Description
error	Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

InnerError

O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).

Name	Tipo	Description
code	string	Código de erro detalhado para ajudar no diagnóstico.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
message	string	Mensagem de erro detalhada.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "ID de modelo" em caso de modelo inválido.

Status

Estado de um recurso.

Name	Tipo	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Share via

Endpoints - Suspend

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Suspend an endpoint

Sample Request

Sample Response

Definições

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Recursos adicionais