Tenant Configuration - Deploy

Služba:

API Management

Verze rozhraní API:

2024-05-01

Tato operace použije změny ze zadané větve Git do konfigurační databáze. Jedná se o dlouhotrvající operaci, která může trvat několik minut.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
configurationName	path	True	configurationIdName	Identifikátor operace konfigurace Gitu.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.branch	True	string	Název větve Git, ze které se má konfigurace nasadit do konfigurační databáze.
properties.force		boolean	Hodnota vynucující odstranění předplatných produktů, které jsou v této aktualizaci odstraněny.

Odpovědi

Name	Typ	Description
200 OK	OperationResultContract	Výsledek použití změn z větve Gitu do databáze
202 Accepted		Přijato: Hlavička umístění obsahuje adresu URL, kde je možné zkontrolovat stav dlouhotrvající operace. Hlavičky location: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementTenantConfigurationDeploy

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
AsyncOperationStatus	Stav asynchronní operace
configurationIdName	Identifikátor operace konfigurace Gitu.
DeployConfigurationParameters	Nasazení kontraktu konfigurace tenanta
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorFieldContract	Kontrakt pole chyby
ErrorResponse	Chybová odpověď
ErrorResponseBody	Kontrakt textu chyby
OperationResultContract	Výsledky dlouhotrvající operace Gitu
OperationResultLogItemContract	Protokol vytvářené, aktualizované nebo odstraněné entity

AsyncOperationStatus

Výčet

Stav asynchronní operace

Hodnota	Description
Failed
InProgress
Started
Succeeded

configurationIdName

Výčet

Identifikátor operace konfigurace Gitu.

Hodnota	Description
configuration

DeployConfigurationParameters

Objekt

Nasazení kontraktu konfigurace tenanta

Name	Typ	Description
properties.branch	string	Název větve Git, ze které se má konfigurace nasadit do konfigurační databáze.
properties.force	boolean	Hodnota vynucující odstranění předplatných produktů, které jsou v této aktualizaci odstraněny.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorFieldContract

Objekt

Kontrakt pole chyby

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti
message	string	Lidské čitelné znázornění chyby na úrovni vlastností
target	string	Název vlastnosti.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ErrorResponseBody

Objekt

Kontrakt textu chyby

Name	Typ	Description
code	string	Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
details	ErrorFieldContract[]	Seznam neplatnýchpolích
message	string	Čitelné znázornění chyby člověkem

OperationResultContract

Objekt

Výsledky dlouhotrvající operace Gitu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.actionLog	OperationResultLogItemContract[]	Tato vlastnost je-li poskytována pouze jako součást operace TenantConfiguration_Validate. Obsahuje protokol entit, které se v rámci operace TenantConfiguration_Deploy aktualizují, vytvoří nebo odstraní.
properties.error	ErrorResponseBody	Kontrakt textu chyby
properties.id	string	Identifikátor výsledku operace.
properties.resultInfo	string	Volitelné informace o výsledku.
properties.started	string (date-time)	Počáteční čas asynchronní operace. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.status	AsyncOperationStatus	Stav asynchronní operace
properties.updated	string (date-time)	Čas poslední aktualizace asynchronní operace Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

OperationResultLogItemContract

Objekt

Protokol vytvářené, aktualizované nebo odstraněné entity

Name	Typ	Description
action	string	Akce, jako je vytvoření, aktualizace nebo odstranění
objectKey	string	Identifikátor entity, která se vytváří, aktualizuje nebo odstraní.
objectType	string	Typ kontraktu entity.