Tenant Configuration - Validate

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Questa operazione convalida le modifiche nel ramo Git specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
configurationName	path	True	configurationIdName	Identificatore dell'operazione di configurazione Git.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.branch	True	string	Nome del ramo Git da cui distribuire la configurazione nel database di configurazione.
properties.force		boolean	Valore che impone l'eliminazione delle sottoscrizioni ai prodotti eliminati in questo aggiornamento.

Risposte

Nome	Tipo	Descrizione
200 OK	OperationResultContract	Risultato della convalida delle modifiche nel ramo Git specificato.
202 Accepted		Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata. Intestazioni location: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

OperationResultContract

Risultato della convalida delle modifiche nel ramo Git specificato.

202 Accepted

Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata.

Intestazioni

location: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementTenantConfigurationValidate

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/validate?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

Risposta di esempio

Codice di stato:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2024-05-01

Codice di stato:: 200

{
  "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": []
  }
}

Definizioni

Nome	Descrizione
AsyncOperationStatus	Stato di un'operazione asincrona.
configurationIdName	Identificatore dell'operazione di configurazione Git.
DeployConfigurationParameters	Distribuire il contratto di configurazione del tenant.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorFieldContract	Contratto campo errore.
ErrorResponse	Risposta di errore
ErrorResponseBody	Contratto corpo errore.
OperationResultContract	Risultati dell'operazione Git a esecuzione prolungata.
OperationResultLogItemContract	Log dell'entità creata, aggiornata o eliminata.

AsyncOperationStatus

Enumerazione

Stato di un'operazione asincrona.

Valore	Descrizione
Failed
InProgress
Started
Succeeded

configurationIdName

Enumerazione

Identificatore dell'operazione di configurazione Git.

Valore	Descrizione
configuration

DeployConfigurationParameters

Object

Distribuire il contratto di configurazione del tenant.

Nome	Tipo	Descrizione
properties.branch	string	Nome del ramo Git da cui distribuire la configurazione nel database di configurazione.
properties.force	boolean	Valore che impone l'eliminazione delle sottoscrizioni ai prodotti eliminati in questo aggiornamento.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorFieldContract

Object

Contratto campo errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ErrorResponseBody

Object

Contratto corpo errore.

Nome	Tipo	Descrizione
code	string	Codice di errore definito dal servizio. Questo codice funge da sotto-stato per il codice di errore HTTP specificato nella risposta.
details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
message	string	Rappresentazione leggibile dell'errore.

OperationResultContract

Object

Risultati dell'operazione Git a esecuzione prolungata.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.actionLog	OperationResultLogItemContract[]	Questa proprietà se specificata solo come parte dell'operazione di TenantConfiguration_Validate. Contiene il log delle entità che verranno aggiornate/create/eliminate come parte dell'operazione di TenantConfiguration_Deploy.
properties.error	ErrorResponseBody	Contratto corpo errore
properties.id	string	Identificatore del risultato dell'operazione.
properties.resultInfo	string	Informazioni sui risultati facoltative.
properties.started	string (date-time)	Ora di inizio di un'operazione asincrona. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.status	AsyncOperationStatus	Stato di un'operazione asincrona.
properties.updated	string (date-time)	Ora dell'ultimo aggiornamento di un'operazione asincrona. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Object

Log dell'entità creata, aggiornata o eliminata.

Nome	Tipo	Descrizione
action	string	Azione come creazione/aggiornamento/eliminazione.
objectKey	string	Identificatore dell'entità creata/aggiornata/eliminata.
objectType	string	Tipo di contratto di entità.

Condividi tramite

Tenant Configuration - Validate

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementTenantConfigurationValidate

Esempio di richiesta

Risposta di esempio

Definizioni

AsyncOperationStatus

configurationIdName

DeployConfigurationParameters

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

Risorse aggiuntive