Tenant Configuration - Save

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Ta operacja tworzy zatwierdzenie z bieżącą migawką konfiguracji do określonej gałęzi w repozytorium. Jest to długotrwała operacja i może potrwać kilka minut.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
configurationName	path	True	configurationIdName	Identyfikator operacji konfiguracji usługi Git.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.branch	True	string	Nazwa gałęzi Git, w której ma być zatwierdzana bieżąca migawka konfiguracji.
properties.force		boolean	Wartość w przypadku wartości true bieżąca baza danych konfiguracji jest zatwierdzana w repozytorium Git, nawet jeśli repozytorium Git ma nowsze zmiany, które zostaną zastąpione.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OperationResultContract	Wynik utworzenia zatwierdzenia w repozytorium.
202 Accepted		Zaakceptowane: nagłówek lokalizacji zawiera adres URL, pod którym można sprawdzić stan długotrwałej operacji. Nagłówki location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementTenantConfigurationSave

Przykładowe żądanie

HTTP

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"
  }
}

Przykładowa odpowiedź

Kod stanu:

202

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

Kod stanu:

200

{
  "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": []
  }
}

Definicje

Nazwa	Opis
AsyncOperationStatus	Stan operacji asynchronicznych.
configurationIdName	Identyfikator operacji konfiguracji usługi Git.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorFieldContract	Błąd Kontrakt pola.
ErrorResponse	Odpowiedź na błąd
ErrorResponseBody	Kontrakt treści błędu.
OperationResultContract	Długotrwałe wyniki operacji git.
OperationResultLogItemContract	Dziennik tworzonej, zaktualizowanej lub usuniętej jednostki.
SaveConfigurationParameter	Zapisz szczegóły umowy konfiguracji dzierżawy.

AsyncOperationStatus

Wyliczanie

Stan operacji asynchronicznych.

Wartość	Opis
Failed
InProgress
Started
Succeeded

configurationIdName

Wyliczanie

Identyfikator operacji konfiguracji usługi Git.

Wartość	Opis
configuration

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorFieldContract

Objekt

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ErrorResponseBody

Objekt

Kontrakt treści błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
details	ErrorFieldContract[]	Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
message	string	Czytelna dla człowieka reprezentacja błędu.

OperationResultContract

Objekt

Długotrwałe wyniki operacji git.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.actionLog	OperationResultLogItemContract[]	Ta właściwość, jeśli jest podana tylko w ramach operacji TenantConfiguration_Validate. Zawiera on dziennik jednostek, które zostaną zaktualizowane/utworzone/usunięte w ramach operacji TenantConfiguration_Deploy.
properties.error	ErrorResponseBody	Kontrakt treści błędu
properties.id	string	Identyfikator wyniku operacji.
properties.resultInfo	string	Opcjonalne informacje o wynikach.
properties.started	string (date-time)	Godzina rozpoczęcia operacji asynchronicznych. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
properties.status	AsyncOperationStatus	Stan operacji asynchronicznych.
properties.updated	string (date-time)	Czas ostatniej aktualizacji operacji asynchronicznych. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Objekt

Dziennik tworzonej, zaktualizowanej lub usuniętej jednostki.

Nazwa	Typ	Opis
action	string	Akcja, na przykład create/update/delete.
objectKey	string	Identyfikator tworzonej/aktualizowanej/usuniętej jednostki.
objectType	string	Typ kontraktu jednostki.

SaveConfigurationParameter

Objekt

Zapisz szczegóły umowy konfiguracji dzierżawy.

Nazwa	Typ	Opis
properties.branch	string	Nazwa gałęzi Git, w której ma być zatwierdzana bieżąca migawka konfiguracji.
properties.force	boolean	Wartość w przypadku wartości true bieżąca baza danych konfiguracji jest zatwierdzana w repozytorium Git, nawet jeśli repozytorium Git ma nowsze zmiany, które zostaną zastąpione.