Tenant Configuration - Deploy

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Dieser Vorgang wendet Änderungen von der angegebenen Git-Verzweigung auf die Konfigurationsdatenbank an. Dies ist ein lange ausgeführter Vorgang und kann mehrere Minuten dauern.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
configurationName	path	True	configurationIdName	Der Bezeichner des Git-Konfigurationsvorgangs.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.branch	True	string	Der Name des Git-Zweigs, aus dem die Konfiguration in der Konfigurationsdatenbank bereitgestellt werden soll.
properties.force		boolean	Der Wert, der das Löschen von Abonnements für Produkte erzwingt, die in diesem Update gelöscht werden.

Antworten

Name	Typ	Beschreibung
200 OK	OperationResultContract	Ergebnis der Anwendung von Änderungen von Git Branch auf Datenbank.
202 Accepted		Akzeptiert: Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft werden kann. Header location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

OperationResultContract

Ergebnis der Anwendung von Änderungen von Git Branch auf Datenbank.

202 Accepted

Akzeptiert: Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft werden kann.

Header

location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementTenantConfigurationDeploy

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/deploy?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

Beispiel für eine Antwort

Statuscode:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2024-05-01

Statuscode:: 200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Failed",
    "started": "2017-11-26T17:06:54.303Z",
    "updated": "2017-11-26T17:07:21.777Z",
    "error": {
      "code": "ValidationError",
      "message": "File not found: 'api-management/configuration.json'"
    }
  }
}

Definitionen

Name	Beschreibung
AsyncOperationStatus	Status eines asynchronen Vorgangs.
configurationIdName	Der Bezeichner des Git-Konfigurationsvorgangs.
DeployConfigurationParameters	Mandantenkonfigurationsvertrag bereitstellen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorFieldContract	Fehlerfeld-Vertrag.
ErrorResponse	Fehlerantwort
ErrorResponseBody	Fehlertext-Vertrag.
OperationResultContract	Ergebnisse des Git-Vorgangs mit langer Ausführung.
OperationResultLogItemContract	Protokoll der Entität, die erstellt, aktualisiert oder gelöscht wird.

AsyncOperationStatus

Enumeration

Status eines asynchronen Vorgangs.

Wert	Beschreibung
Failed
InProgress
Started
Succeeded

configurationIdName

Enumeration

Der Bezeichner des Git-Konfigurationsvorgangs.

Wert	Beschreibung
configuration

DeployConfigurationParameters

Objekt

Mandantenkonfigurationsvertrag bereitstellen.

Name	Typ	Beschreibung
properties.branch	string	Der Name des Git-Zweigs, aus dem die Konfiguration in der Konfigurationsdatenbank bereitgestellt werden soll.
properties.force	boolean	Der Wert, der das Löschen von Abonnements für Produkte erzwingt, die in diesem Update gelöscht werden.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorFieldContract

Objekt

Fehlerfeld-Vertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Lesbare Darstellung des Fehlers auf Eigenschaftsebene.
target	string	Eigenschaftenname.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ErrorResponseBody

Objekt

Fehlertext-Vertrag.

Name	Typ	Beschreibung
code	string	Dienstdefinierter Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.
message	string	Lesbare Darstellung des Fehlers.

OperationResultContract

Objekt

Ergebnisse des Git-Vorgangs mit langer Ausführung.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.actionLog	OperationResultLogItemContract[]	Diese Eigenschaft wird nur als Teil 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	ErrorResponseBody	Fehlertextvertrag
properties.id	string	Vorgangsergebnis-ID.
properties.resultInfo	string	Optionale Ergebnisinformationen.
properties.started	string (date-time)	Startzeit eines asynchronen Vorgangs. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.status	AsyncOperationStatus	Status eines asynchronen Vorgangs.
properties.updated	string (date-time)	Zeitpunkt der letzten Aktualisierung eines asynchronen Vorgangs. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Objekt

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.

Freigeben über

Tenant Configuration - Deploy

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementTenantConfigurationDeploy

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AsyncOperationStatus

configurationIdName

DeployConfigurationParameters

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

Zusätzliche Ressourcen