Tenant Configuration - Save
Questa operazione crea un commit con lo snapshot di configurazione corrente nel ramo specificato nel repository. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
configuration
|
path | True |
Identificatore dell'operazione di configurazione Git. |
|
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
properties.branch | True |
string |
Nome del ramo Git in cui eseguire il commit dello snapshot di configurazione corrente. |
properties.force |
boolean |
Il valore se true, viene eseguito il commit del database di configurazione corrente nel repository Git, anche se il repository Git presenta modifiche più recenti che verrebbero sovrascritte. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Risultato della creazione di un commit nel repository. |
|
202 Accepted |
Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata. |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
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": []
}
}
Definizioni
Nome | Descrizione |
---|---|
Async |
Stato di un'operazione asincrona. |
configuration |
Identificatore dell'operazione di configurazione Git. |
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Error |
Contratto del corpo dell'errore. |
Operation |
Risultati dell'operazione Git a esecuzione prolungata. |
Operation |
Log dell'entità creata, aggiornata o eliminata. |
Save |
Salvare i dettagli del contratto di configurazione del tenant. |
AsyncOperationStatus
Stato di un'operazione asincrona.
Nome | Tipo | Descrizione |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Identificatore dell'operazione di configurazione Git.
Nome | Tipo | Descrizione |
---|---|---|
configuration |
string |
ErrorFieldContract
Contratto campo di errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
ErrorResponseBody
Contratto del corpo dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
message |
string |
Rappresentazione leggibile dell'errore. |
OperationResultContract
Risultati dell'operazione Git a esecuzione prolungata.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.actionLog |
Questa proprietà, se specificata solo come parte dell'operazione di TenantConfiguration_Validate. Contiene il log delle entità che verranno aggiornate/create/eliminate come parte dell'operazione di TenantConfiguration_Deploy. |
|
properties.error |
Contratto del corpo dell'errore |
|
properties.id |
string |
Identificatore del risultato dell'operazione. |
properties.resultInfo |
string |
Informazioni sui risultati facoltative. |
properties.started |
string |
Ora di inizio di un'operazione asincrona. La data è conforme al formato seguente: |
properties.status |
Stato di un'operazione asincrona. |
|
properties.updated |
string |
Ora dell'ultimo aggiornamento di un'operazione asincrona. La data è conforme al formato seguente: |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Log dell'entità creata, aggiornata o eliminata.
Nome | Tipo | Descrizione |
---|---|---|
action |
string |
Azione come creazione/aggiornamento/eliminazione. |
objectKey |
string |
Identificatore dell'entità creata/aggiornata/eliminata. |
objectType |
string |
Tipo di contratto di entità. |
SaveConfigurationParameter
Salvare i dettagli del contratto di configurazione del tenant.
Nome | Tipo | Descrizione |
---|---|---|
properties.branch |
string |
Nome del ramo Git in cui eseguire il commit dello snapshot di configurazione corrente. |
properties.force |
boolean |
Il valore se true, viene eseguito il commit del database di configurazione corrente nel repository Git, anche se il repository Git presenta modifiche più recenti che verrebbero sovrascritte. |