Tenant Configuration - Deploy

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Den här åtgärden tillämpar ändringar från den angivna Git-grenen på konfigurationsdatabasen. 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/deploy?api-version=2024-05-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
configurationName	path	True	configurationIdName	Identifieraren för Git-konfigurationsåtgärden.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	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 till produkter som tas bort i den här uppdateringen.

Svar

Name	Typ	Description
200 OK	OperationResultContract	Resultatet av att tillämpa ändringar från Git-grenen på databasen.
202 Accepted		Accepterad: Platsrubriken innehåller url:en där status för den tidskrävande åtgärden kan kontrolleras. Sidhuvuden location: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

OperationResultContract

Resultatet av att tillämpa ändringar från Git-grenen på databasen.

202 Accepted

Accepterad: Platsrubriken innehåller url:en där status för den tidskrävande åtgärden kan kontrolleras.

Sidhuvuden

location: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementTenantConfigurationDeploy

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Statuskod:: 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'"
    }
  }
}

Definitioner

Name	Description
AsyncOperationStatus	Status för en asynkron åtgärd.
configurationIdName	Identifieraren för Git-konfigurationsåtgärden.
DeployConfigurationParameters	Distribuera klientkonfigurationskontrakt.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorFieldContract	Kontrakt för felfält.
ErrorResponse	Felsvar
ErrorResponseBody	Fel på brödtextkontrakt.
OperationResultContract	Git-åtgärdsresultat som körs länge.
OperationResultLogItemContract	Logg över entiteten som skapas, uppdateras eller tas bort.

AsyncOperationStatus

Uppräkning

Status för en asynkron åtgärd.

Värde	Description
Failed
InProgress
Started
Succeeded

configurationIdName

Uppräkning

Identifieraren för Git-konfigurationsåtgärden.

Värde	Description
configuration

DeployConfigurationParameters

Objekt

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 till produkter som tas bort i den här uppdateringen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorFieldContract

Objekt

Kontrakt för felfält.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ErrorResponseBody

Objekt

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	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
message	string	Mänsklig läsbar representation av felet.

OperationResultContract

Objekt

Git-åtgärdsresultat som körs länge.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.actionLog	OperationResultLogItemContract[]	Den här egenskapen om den endast tillhandahålls som en del av åtgärden TenantConfiguration_Validate. Den innehåller loggen de entiteter som ska uppdateras/skapas/tas bort som en del av den TenantConfiguration_Deploy åtgärden.
properties.error	ErrorResponseBody	Kontrakt för feltext
properties.id	string	Åtgärdsresultatidentifierare.
properties.resultInfo	string	Valfri resultatinformation.
properties.started	string (date-time)	Starttid för en asynkron åtgärd. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.status	AsyncOperationStatus	Status för en asynkron åtgärd.
properties.updated	string (date-time)	Senaste uppdateringstid för en asynkron åtgärd. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Objekt

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.

Dela via

Tenant Configuration - Deploy

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementTenantConfigurationDeploy

Exempelbegäran

Exempelsvar

Definitioner

AsyncOperationStatus

configurationIdName

DeployConfigurationParameters

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

Ytterligare resurser