Tenant Configuration - Save
Эта операция создает фиксацию с текущим моментальным снимком конфигурации в указанной ветви в репозитории. Это длительная операция и может занять несколько минут.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2024-05-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
configuration
|
path | True |
Идентификатор операции конфигурации Git. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не учитывает регистр. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Имя службы управления API. |
subscription
|
path | True |
string (uuid) |
Идентификатор целевой подписки. Значение должно быть UUID. |
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.branch | True |
string |
Имя ветви Git, в которой необходимо зафиксировать текущий моментальный снимок конфигурации. |
properties.force |
boolean |
Значение, если значение true, текущая база данных конфигурации фиксируется в репозитории Git, даже если репозиторий Git имеет более новые изменения, которые будут перезаписаны. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Результат создания фиксации в репозитории. |
|
202 Accepted |
Принято. Заголовок расположения содержит URL-адрес, в котором можно проверить состояние длительной операции. Заголовки location: string |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementTenantConfigurationSave
Образец запроса
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"
}
}
Пример ответа
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
{
"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 |
Контракт поля ошибки. |
Error |
Ответ на ошибку |
Error |
Контракт текста ошибки. |
Operation |
Длительные результаты операции Git. |
Operation |
Журнал создаваемой, обновленной или удаленной сущности. |
Save |
Сохраните сведения о контракте конфигурации клиента. |
AsyncOperationStatus
Состояние асинхронной операции.
Значение | Описание |
---|---|
Failed | |
InProgress | |
Started | |
Succeeded |
configurationIdName
Идентификатор операции конфигурации Git.
Значение | Описание |
---|---|
configuration |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойств. |
message |
string |
Удобочитаемое пользователем представление ошибки уровня свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
ErrorResponseBody
Контракт текста ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе. |
details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
message |
string |
Читаемое человеком представление ошибки. |
OperationResultContract
Длительные результаты операции Git.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /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 (date-time) |
Время начала асинхронной операции. Дата соответствует следующему формату: |
properties.status |
Состояние асинхронной операции. |
|
properties.updated |
string (date-time) |
Время последнего обновления асинхронной операции. Дата соответствует следующему формату: |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Журнал создаваемой, обновленной или удаленной сущности.
Имя | Тип | Описание |
---|---|---|
action |
string |
Действие, например create/update/delete. |
objectKey |
string |
Идентификатор создаваемой или обновленной или удаленной сущности. |
objectType |
string |
Тип контракта сущности. |
SaveConfigurationParameter
Сохраните сведения о контракте конфигурации клиента.
Имя | Тип | Описание |
---|---|---|
properties.branch |
string |
Имя ветви Git, в которой необходимо зафиксировать текущий моментальный снимок конфигурации. |
properties.force |
boolean |
Значение, если значение true, текущая база данных конфигурации фиксируется в репозитории Git, даже если репозиторий Git имеет более новые изменения, которые будут перезаписаны. |