Tenant Configuration - Save
Dieser Vorgang erstellt einen Commit mit der aktuellen Konfiguration Momentaufnahme an den angegebenen Branch im Repository. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
configuration
|
path | True |
Der Bezeichner des Git-Konfigurationsvorgangs. |
|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.branch | True |
string |
Der Name des Git-Branchs, in dem die aktuelle Konfiguration Momentaufnahme. |
properties.force |
boolean |
Der Wert , wenn true, die aktuelle Konfigurationsdatenbank wird in das Git-Repository committet, auch wenn das Git-Repository neuere Änderungen aufweist, die überschrieben werden würden. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Ergebnis der Erstellung eines Commits im Repository. |
|
202 Accepted |
Akzeptiert: Der Speicherortheader enthält die URL, unter der die status des zeitintensiven Vorgangs überprüft werden kann. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
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": []
}
}
Definitionen
Name | Beschreibung |
---|---|
Async |
Status eines asynchronen Vorgangs. |
configuration |
Der Bezeichner des Git-Konfigurationsvorgangs. |
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
Error |
Fehler Textvertrag. |
Operation |
Ergebnisse von Git-Vorgängen mit langer Ausführungszeit. |
Operation |
Protokoll der Entität, die erstellt, aktualisiert oder gelöscht wird. |
Save |
Speichern Sie Details des Mandantenkonfigurationsvertrags. |
AsyncOperationStatus
Status eines asynchronen Vorgangs.
Name | Typ | Beschreibung |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Der Bezeichner des Git-Konfigurationsvorgangs.
Name | Typ | Beschreibung |
---|---|---|
configuration |
string |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
ErrorResponseBody
Fehler Textvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
message |
string |
Lesbare Darstellung des Fehlers. |
OperationResultContract
Ergebnisse von Git-Vorgängen mit langer Ausführungszeit.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.actionLog |
Diese Eigenschaft wird nur im Rahmen des TenantConfiguration_Validate-Vorgangs bereitgestellt. Sie enthält das Protokoll der Entitäten, die im Rahmen des TenantConfiguration_Deploy-Vorgangs aktualisiert/erstellt/gelöscht werden. |
|
properties.error |
Fehlertextvertrag |
|
properties.id |
string |
Vorgangsergebnisbezeichner. |
properties.resultInfo |
string |
Optionale Ergebnisinformationen. |
properties.started |
string |
Startzeit eines asynchronen Vorgangs. Das Datum entspricht dem folgenden Format: |
properties.status |
Status eines asynchronen Vorgangs. |
|
properties.updated |
string |
Zeitpunkt der letzten Aktualisierung eines asynchronen Vorgangs. Das Datum entspricht dem folgenden Format: |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Protokoll der Entität, die erstellt, aktualisiert oder gelöscht wird.
Name | Typ | Beschreibung |
---|---|---|
action |
string |
Aktion wie Erstellen/Aktualisieren/Löschen. |
objectKey |
string |
Bezeichner der Entität, die erstellt/aktualisiert/gelöscht wird. |
objectType |
string |
Der Typ des Entitätsvertrags. |
SaveConfigurationParameter
Speichern Sie Details des Mandantenkonfigurationsvertrags.
Name | Typ | Beschreibung |
---|---|---|
properties.branch |
string |
Der Name des Git-Branchs, in dem die aktuelle Konfiguration Momentaufnahme. |
properties.force |
boolean |
Der Wert , wenn true, die aktuelle Konfigurationsdatenbank wird in das Git-Repository committet, auch wenn das Git-Repository neuere Änderungen aufweist, die überschrieben werden würden. |