你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Tenant Configuration - Save
此操作使用当前配置快照存储库中的指定分支创建提交。 这是一个长时间运行的操作,可能需要几分钟才能完成。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2022-08-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
configuration
|
path | True |
Git 配置操作的标识符。 |
|
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
service
|
path | True |
string |
API 管理服务的名称。 Regex pattern: |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
properties.branch | True |
string |
要在其中提交当前配置的 Git 分支的名称快照。 |
properties.force |
boolean |
如果值为 true,则当前配置数据库将提交到 Git 存储库,即使 Git 存储库具有将被覆盖的更新更改也是如此。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
在存储库中创建提交的结果。 |
|
202 Accepted |
接受:位置标头包含可在其中检查长时间运行的操作状态的 URL。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ApiManagementTenantConfigurationSave
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/save?api-version=2022-08-01
{
"properties": {
"branch": "master"
}
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2022-08-01
{
"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": []
}
}
定义
名称 | 说明 |
---|---|
Async |
异步操作的状态。 |
configuration |
Git 配置操作的标识符。 |
Error |
错误字段协定。 |
Error |
错误响应。 |
Error |
错误正文协定。 |
Operation |
长时间运行的 Git 操作结果。 |
Operation |
正在创建、更新或删除的实体的日志。 |
Save |
保存租户配置协定详细信息。 |
AsyncOperationStatus
异步操作的状态。
名称 | 类型 | 说明 |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Git 配置操作的标识符。
名称 | 类型 | 说明 |
---|---|---|
configuration |
string |
ErrorFieldContract
错误字段协定。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
属性级错误代码。 |
message |
string |
属性级错误的可读表示形式。 |
target |
string |
属性名称。 |
ErrorResponse
错误响应。
名称 | 类型 | 说明 |
---|---|---|
error.code |
string |
服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。 |
error.details |
在发生验证错误的情况下,在请求中发送的无效字段列表。 |
|
error.message |
string |
错误的用户可读表示形式。 |
ErrorResponseBody
错误正文协定。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。 |
details |
在发生验证错误的情况下,在请求中发送的无效字段列表。 |
|
message |
string |
错误的用户可读表示形式。 |
OperationResultContract
长时间运行的 Git 操作结果。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties.actionLog |
此属性(如果仅作为TenantConfiguration_Validate操作的一部分提供)。 它包含将在TenantConfiguration_Deploy操作过程中更新/创建/删除的实体的日志。 |
|
properties.error |
错误正文协定 |
|
properties.id |
string |
操作结果标识符。 |
properties.resultInfo |
string |
可选结果信息。 |
properties.started |
string |
异步操作的开始时间。 日期符合以下格式: |
properties.status |
异步操作的状态。 |
|
properties.updated |
string |
异步操作的上次更新时间。 日期符合以下格式: |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
OperationResultLogItemContract
正在创建、更新或删除的实体的日志。
名称 | 类型 | 说明 |
---|---|---|
action |
string |
创建/更新/删除等操作。 |
objectKey |
string |
正在创建/更新/删除的实体的标识符。 |
objectType |
string |
实体协定的类型。 |
SaveConfigurationParameter
保存租户配置协定详细信息。
名称 | 类型 | 说明 |
---|---|---|
properties.branch |
string |
要在其中提交当前配置的 Git 分支的名称快照。 |
properties.force |
boolean |
如果值为 true,则当前配置数据库将提交到 Git 存储库,即使 Git 存储库具有将被覆盖的更新更改也是如此。 |