你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Text Analysis Authoring - Swap Deployments

在两个现有部署之间互相交换。

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/:swap?api-version=2023-04-01

URI 参数

名称 必需 类型 说明
Endpoint
path True

string

支持的认知服务终结点 (例如 https://.api.cognitiveservices.azure.com).

projectName
path True

string

要使用的项目的名称。

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
firstDeploymentName True

string

表示第一个部署名称。

secondDeploymentName True

string

表示第二个部署名称。

响应

名称 类型 说明
202 Accepted

带有用于检查作业状态的 Operation-Location 标头的成功调用结果。

标头

operation-location: string

Other Status Codes

ErrorResponse

错误响应。

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。 与 Azure 基于角色的访问控制配对时,它可用于控制对Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限,以Azure Maps REST API。

若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一种解决方案,用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

  • 此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问的Azure Maps资源。 这可以从 地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

  • 目前,Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾,但不支持个人帐户。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

语言服务资源的订阅密钥。

类型: apiKey
在: header

示例

Successful Swap Deployments

示例请求

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/:swap?api-version=2023-04-01

{
  "firstDeploymentName": "production",
  "secondDeploymentName": "staging"
}

示例响应

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01

定义

名称 说明
Error

错误对象。

ErrorCode

用户可读的错误代码。

ErrorResponse

错误响应。

InnerErrorCode

用户可读的错误代码。

InnerErrorModel

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

TextAnalysisAuthoringSwapDeploymentsOptions

表示用于一起交换两个部署的选项。

Error

错误对象。

名称 类型 说明
code

ErrorCode

服务器定义的一组错误代码中的一个。

details

Error[]

有关导致此项报告错误的特定错误的详细信息数组。

innererror

InnerErrorModel

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

target

string

错误的目标。

ErrorCode

用户可读的错误代码。

名称 类型 说明
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

错误响应。

名称 类型 说明
error

Error

错误对象。

InnerErrorCode

用户可读的错误代码。

名称 类型 说明
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

名称 类型 说明
code

InnerErrorCode

服务器定义的一组错误代码中的一个。

details

object

错误详细信息。

innererror

InnerErrorModel

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误消息。

target

string

错误目标。

TextAnalysisAuthoringSwapDeploymentsOptions

表示用于一起交换两个部署的选项。

名称 类型 说明
firstDeploymentName

string

表示第一个部署名称。

secondDeploymentName

string

表示第二个部署名称。