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

Tenant Configuration - Save

参考

服务:: API Management

API 版本:: 2024-05-01

此作使用当前配置快照创建到存储库中指定分支的提交。这是长时间运行的作，可能需要几分钟才能完成。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
configurationName	path	True	configurationIdName	Git 配置作的标识符。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
properties.branch	True	string	要在其中提交当前配置快照的 Git 分支的名称。
properties.force		boolean	如果为 true，则当前配置数据库会提交到 Git 存储库，即使 Git 存储库具有将覆盖的较新的更改也是如此。

响应

名称	类型	说明
200 OK	OperationResultContract	在存储库中创建提交的结果。
202 Accepted		已接受：位置标头包含可以检查长时间运行作的状态的 URL。标头 location: string
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

名称

类型

说明

200 OK

OperationResultContract

在存储库中创建提交的结果。

202 Accepted

已接受：位置标头包含可以检查长时间运行作的状态的 URL。

标头

location: string

Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementTenantConfigurationSave

示例请求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/save?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

示例响应

状态代码:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-05-01

状态代码:: 200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Succeeded",
    "started": "2021-04-13T00:31:14.94Z",
    "updated": "2021-04-13T00:31:27.59Z",
    "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.",
    "actionLog": []
  }
}

定义

名称	说明
AsyncOperationStatus	异步作的状态。
configurationIdName	Git 配置作的标识符。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应
ErrorResponseBody	错误正文协定。
OperationResultContract	长时间运行的 Git作结果。
OperationResultLogItemContract	正在创建、更新或删除的实体的日志。
SaveConfigurationParameter	保存租户配置协定详细信息。

AsyncOperationStatus

枚举

异步作的状态。

值	说明
Failed
InProgress
Started
Succeeded

configurationIdName

枚举

Git 配置作的标识符。

值	说明
configuration

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorFieldContract

Object

错误字段协定。

名称	类型	说明
code	string	属性级别错误代码。
message	string	属性级错误的人工可读表示形式。
target	string	属性名称。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ErrorResponseBody

Object

错误正文协定。

名称	类型	说明
code	string	服务定义的错误代码。此代码充当响应中指定的 HTTP 错误代码的子状态。
details	ErrorFieldContract[]	请求中发送的无效字段列表（如果出现验证错误）。
message	string	错误的人工可读表示形式。

OperationResultContract

Object

长时间运行的 Git作结果。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.actionLog	OperationResultLogItemContract[]	仅当作为TenantConfiguration_Validate作的一部分提供时，此属性。它包含将在TenantConfiguration_Deploy作中更新/创建/删除的实体的日志。
properties.error	ErrorResponseBody	错误正文协定
properties.id	string	作结果标识符。
properties.resultInfo	string	可选结果信息。
properties.started	string (date-time)	异步作的开始时间。日期符合以下格式：按 ISO 8601 标准指定的 `yyyy-MM-ddTHH:mm:ssZ`。
properties.status	AsyncOperationStatus	异步作的状态。
properties.updated	string (date-time)	异步作的上次更新时间。日期符合以下格式：按 ISO 8601 标准指定的 `yyyy-MM-ddTHH:mm:ssZ`。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

OperationResultLogItemContract

Object

正在创建、更新或删除的实体的日志。

名称	类型	说明
action	string	创建/更新/删除等作。
objectKey	string	正在创建/更新/删除的实体的标识符。
objectType	string	实体协定的类型。

SaveConfigurationParameter

Object

保存租户配置协定详细信息。

名称	类型	说明
properties.branch	string	要在其中提交当前配置快照的 Git 分支的名称。
properties.force	boolean	如果为 true，则当前配置数据库会提交到 Git 存储库，即使 Git 存储库具有将覆盖的较新的更改也是如此。

通过

Tenant Configuration - Save

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

ApiManagementTenantConfigurationSave

示例请求

示例响应

定义

AsyncOperationStatus

configurationIdName

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

SaveConfigurationParameter

其他资源