Tenant Configuration - Save
Esta operación crea una confirmación con la instantánea de configuración actual en la rama especificada del repositorio. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
configuration
|
path | True |
Identificador de la operación de configuración de Git. |
|
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties.branch | True |
string |
Nombre de la rama de Git en la que se va a confirmar la instantánea de configuración actual. |
properties.force |
boolean |
El valor si es true, la base de datos de configuración actual se confirma en el repositorio de Git, incluso si el repositorio de Git tiene cambios más recientes que se sobrescribirían. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Resultado de la creación de una confirmación en el repositorio. |
|
202 Accepted |
Aceptado: el encabezado Location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
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": []
}
}
Definiciones
Nombre | Description |
---|---|
Async |
Estado de una operación asincrónica. |
configuration |
Identificador de la operación de configuración de Git. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Error |
Contrato cuerpo de error. |
Operation |
Resultados de la operación de Git de larga duración. |
Operation |
Registro de la entidad que se va a crear, actualizar o eliminar. |
Save |
Guarde los detalles del contrato de configuración de inquilinos. |
AsyncOperationStatus
Estado de una operación asincrónica.
Nombre | Tipo | Description |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Identificador de la operación de configuración de Git.
Nombre | Tipo | Description |
---|---|---|
configuration |
string |
ErrorFieldContract
Contrato de campo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error de nivel de propiedad. |
message |
string |
Representación legible del error de nivel de propiedad. |
target |
string |
Nombre de propiedad. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error.code |
string |
Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta. |
error.details |
La lista de campos no válidos que se envían en la solicitud, en caso de error de validación. |
|
error.message |
string |
Representación legible del error. |
ErrorResponseBody
Contrato cuerpo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta. |
details |
La lista de campos no válidos que se envían en la solicitud, en caso de error de validación. |
|
message |
string |
Representación legible del error. |
OperationResultContract
Resultados de la operación de Git de larga duración.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso. |
properties.actionLog |
Esta propiedad solo se proporciona como parte de la operación de TenantConfiguration_Validate. Contiene el registro de las entidades que se actualizarán, crearán o eliminarán como parte de la operación de TenantConfiguration_Deploy. |
|
properties.error |
Contrato del cuerpo del error |
|
properties.id |
string |
Identificador de resultado de la operación. |
properties.resultInfo |
string |
Información de resultados opcional. |
properties.started |
string |
Hora de inicio de una operación asincrónica. La fecha se ajusta al siguiente formato: |
properties.status |
Estado de una operación asincrónica. |
|
properties.updated |
string |
Hora de la última actualización de una operación asincrónica. La fecha se ajusta al siguiente formato: |
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Registro de la entidad que se va a crear, actualizar o eliminar.
Nombre | Tipo | Description |
---|---|---|
action |
string |
Acción como create/update/delete. |
objectKey |
string |
Identificador de la entidad que se va a crear, actualizar o eliminar. |
objectType |
string |
Tipo de contrato de entidad. |
SaveConfigurationParameter
Guarde los detalles del contrato de configuración de inquilinos.
Nombre | Tipo | Description |
---|---|---|
properties.branch |
string |
Nombre de la rama de Git en la que se va a confirmar la instantánea de configuración actual. |
properties.force |
boolean |
El valor si es true, la base de datos de configuración actual se confirma en el repositorio de Git, incluso si el repositorio de Git tiene cambios más recientes que se sobrescribirían. |