Tenant Configuration - Deploy
Dieser Vorgang wendet Änderungen aus dem angegebenen Git-Branch auf die Konfigurationsdatenbank an. 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/deploy?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, von dem aus 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 |
Ergebnis der Anwendung von Änderungen vom Git-Branch auf die Datenbank. |
|
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
ApiManagementTenantConfigurationDeploy
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/deploy?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/5a1af4ae2a6d2e0b688d7517?api-version=2022-08-01
{
"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 |
---|---|
Async |
Status eines asynchronen Vorgangs. |
configuration |
Der Bezeichner des Git-Konfigurationsvorgangs. |
Deploy |
Bereitstellen des Mandantenkonfigurationsvertrags |
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. |
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 |
DeployConfigurationParameters
Bereitstellen des Mandantenkonfigurationsvertrags
Name | Typ | Beschreibung |
---|---|---|
properties.branch |
string |
Der Name des Git-Branchs, von dem aus 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. |
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. |