Tenant Configuration - Deploy

Referentie

Service:: API Management

API-versie:: 2024-05-01

Met deze bewerking worden wijzigingen van de opgegeven Git-vertakking toegepast op de configuratiedatabase. Dit is een langdurige bewerking en kan enkele minuten duren.

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

URI-parameters

Name	In	Vereist	Type	Description
configurationName	path	True	configurationIdName	De id van de Git-configuratiebewerking.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
properties.branch	True	string	De naam van de Git-vertakking waaruit de configuratie moet worden geïmplementeerd in de configuratiedatabase.
properties.force		boolean	De waarde die afdwingt dat abonnementen worden verwijderd naar producten die in deze update worden verwijderd.

Antwoorden

Name	Type	Description
200 OK	OperationResultContract	Resultaat van het toepassen van wijzigingen van de Git-vertakking op de database.
202 Accepted		Geaccepteerd: De locatieheader bevat de URL waar de status van de langdurige bewerking kan worden gecontroleerd. Kopteksten location: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

OperationResultContract

Resultaat van het toepassen van wijzigingen van de Git-vertakking op de database.

202 Accepted

Geaccepteerd: De locatieheader bevat de URL waar de status van de langdurige bewerking kan worden gecontroleerd.

Kopteksten

location: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementTenantConfigurationDeploy

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AsyncOperationStatus	Status van een asynchrone bewerking.
configurationIdName	De id van de Git-configuratiebewerking.
DeployConfigurationParameters	Tenantconfiguratiecontract implementeren.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorFieldContract	Foutveldcontract.
ErrorResponse	Foutreactie
ErrorResponseBody	Contract fouttekst.
OperationResultContract	Langdurige Git-bewerkingsresultaten.
OperationResultLogItemContract	Logboek van de entiteit die wordt gemaakt, bijgewerkt of verwijderd.

AsyncOperationStatus

Inventarisatie

Status van een asynchrone bewerking.

Waarde	Description
Failed
InProgress
Started
Succeeded

configurationIdName

Inventarisatie

De id van de Git-configuratiebewerking.

Waarde	Description
configuration

DeployConfigurationParameters

Object

Tenantconfiguratiecontract implementeren.

Name	Type	Description
properties.branch	string	De naam van de Git-vertakking waaruit de configuratie moet worden geïmplementeerd in de configuratiedatabase.
properties.force	boolean	De waarde die afdwingt dat abonnementen worden verwijderd naar producten die in deze update worden verwijderd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorFieldContract

Object

Foutveldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Leesbare weergave van fout op eigenschapsniveau.
target	string	Eigenschapsnaam.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ErrorResponseBody

Object

Contract fouttekst.

Name	Type	Description
code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
details	ErrorFieldContract[]	De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.
message	string	Leesbare weergave van de fout.

OperationResultContract

Object

Langdurige Git-bewerkingsresultaten.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.actionLog	OperationResultLogItemContract[]	Deze eigenschap als deze alleen is opgegeven als onderdeel van de TenantConfiguration_Validate bewerking. Het bevat het logboek de entiteiten die worden bijgewerkt/gemaakt/verwijderd als onderdeel van de TenantConfiguration_Deploy bewerking.
properties.error	ErrorResponseBody	Contract voor hoofdtekst van fout
properties.id	string	Resultaat-id van bewerking.
properties.resultInfo	string	Optionele resultaatgegevens.
properties.started	string (date-time)	Begintijd van een asynchrone bewerking. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.status	AsyncOperationStatus	Status van een asynchrone bewerking.
properties.updated	string (date-time)	Laatste updatetijd van een asynchrone bewerking. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

OperationResultLogItemContract

Object

Logboek van de entiteit die wordt gemaakt, bijgewerkt of verwijderd.

Name	Type	Description
action	string	Actie zoals maken/bijwerken/verwijderen.
objectKey	string	Id van de entiteit die wordt gemaakt/bijgewerkt/verwijderd.
objectType	string	Het type entiteitscontract.

Delen via

Tenant Configuration - Deploy

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementTenantConfigurationDeploy

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AsyncOperationStatus

configurationIdName

DeployConfigurationParameters

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

Aanvullende resources