Tenant Configuration - Validate
Den här åtgärden verifierar ändringarna i den angivna Git-grenen. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/validate?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
configuration
|
path | True |
Identifieraren för Git-konfigurationsåtgärden. |
|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
properties.branch | True |
string |
Namnet på Git-grenen som konfigurationen ska distribueras från till konfigurationsdatabasen. |
properties.force |
boolean |
Värdet som framtvingar borttagning av prenumerationer på produkter som tas bort i den här uppdateringen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resultatet av valideringen av ändringarna i den angivna Git-grenen. |
|
202 Accepted |
Godkänt: Platsrubriken innehåller url:en där statusen för den långvariga åtgärden kan kontrolleras. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementTenantConfigurationValidate
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/validate?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/5a1af64e2a6d2e0b688d751e?api-version=2022-08-01
{
"id": "6074ec02093a9d0dac3d7345",
"type": "Microsoft.ApiManagement/service/tenant/operationResults",
"name": "6074ec02093a9d0dac3d7345",
"properties": {
"status": "Succeeded",
"started": "2021-04-13T00:55:30.62Z",
"updated": "2021-04-13T00:55:39.857Z",
"resultInfo": "Validation is successfull",
"actionLog": []
}
}
Definitioner
Name | Description |
---|---|
Async |
Status för en asynkron åtgärd. |
configuration |
Identifieraren för Git-konfigurationsåtgärden. |
Deploy |
Distribuera klientkonfigurationskontrakt. |
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Error |
Fel på brödtextkontrakt. |
Operation |
Långvariga Git-åtgärdsresultat. |
Operation |
Logg över entiteten som skapas, uppdateras eller tas bort. |
AsyncOperationStatus
Status för en asynkron åtgärd.
Name | Typ | Description |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Identifieraren för Git-konfigurationsåtgärden.
Name | Typ | Description |
---|---|---|
configuration |
string |
DeployConfigurationParameters
Distribuera klientkonfigurationskontrakt.
Name | Typ | Description |
---|---|---|
properties.branch |
string |
Namnet på Git-grenen som konfigurationen ska distribueras från till konfigurationsdatabasen. |
properties.force |
boolean |
Värdet som framtvingar borttagning av prenumerationer på produkter som tas bort i den här uppdateringen. |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
ErrorResponseBody
Fel på brödtextkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
message |
string |
Mänsklig läsbar representation av felet. |
OperationResultContract
Långvariga Git-åtgärdsresultat.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.actionLog |
Den här egenskapen tillhandahålls endast som en del av TenantConfiguration_Validate åtgärden. Den innehåller loggen de entiteter som ska uppdateras/skapas/tas bort som en del av den TenantConfiguration_Deploy åtgärden. |
|
properties.error |
Fel på brödtextkontrakt |
|
properties.id |
string |
Identifierare för åtgärdsresultat. |
properties.resultInfo |
string |
Valfri resultatinformation. |
properties.started |
string |
Starttid för en asynkron åtgärd. Datumet överensstämmer med följande format: |
properties.status |
Status för en asynkron åtgärd. |
|
properties.updated |
string |
Senaste uppdateringstid för en asynkron åtgärd. Datumet överensstämmer med följande format: |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Logg över entiteten som skapas, uppdateras eller tas bort.
Name | Typ | Description |
---|---|---|
action |
string |
Åtgärd som att skapa/uppdatera/ta bort. |
objectKey |
string |
Identifierare för entiteten som skapas/uppdateras/tas bort. |
objectType |
string |
Typen av entitetskontrakt. |