Tenant Configuration - Validate

Esta operación valida los cambios en la rama git especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
configurationName
path True

configurationIdName

Identificador de la operación de configuración de Git.

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName
path True

string

Nombre del servicio API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.branch True

string

Nombre de la rama de Git desde la que se va a implementar la configuración en la base de datos de configuración.

properties.force

boolean

Valor que exige la eliminación de suscripciones a productos que se eliminan en esta actualización.

Respuestas

Nombre Tipo Description
200 OK

OperationResultContract

Resultado de validar los cambios en la rama de Git especificada.

202 Accepted

Aceptado: el encabezado Location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración.

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre Description
AsyncOperationStatus

Estado de una operación asincrónica.

configurationIdName

Identificador de la operación de configuración de Git.

DeployConfigurationParameters

Implementar contrato de configuración de inquilinos.

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

ErrorResponseBody

Contrato cuerpo de error.

OperationResultContract

Resultados de la operación de Git de larga duración.

OperationResultLogItemContract

Registro de la entidad que se va a crear, actualizar o eliminar.

AsyncOperationStatus

Estado de una operación asincrónica.

Nombre Tipo Description
Failed

string

InProgress

string

Started

string

Succeeded

string

configurationIdName

Identificador de la operación de configuración de Git.

Nombre Tipo Description
configuration

string

DeployConfigurationParameters

Implementar contrato de configuración de inquilinos.

Nombre Tipo Description
properties.branch

string

Nombre de la rama de Git desde la que se va a implementar la configuración en la base de datos de configuración.

properties.force

boolean

Valor que exige la eliminación de suscripciones a productos que se eliminan en esta actualización.

ErrorFieldContract

Contrato de campo de error.

Nombre Tipo Description
code

string

Código de error de nivel de propiedad.

message

string

Representación legible del error de nivel de propiedad.

target

string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error.code

string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message

string

Representación legible del error.

ErrorResponseBody

Contrato cuerpo de error.

Nombre Tipo Description
code

string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

details

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

message

string

Representación legible del error.

OperationResultContract

Resultados de la operación de Git de larga duración.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nombre del recurso.

properties.actionLog

OperationResultLogItemContract[]

Esta propiedad solo se proporciona como parte de la operación de TenantConfiguration_Validate. Contiene el registro de las entidades que se actualizarán, crearán o eliminarán como parte de la operación de TenantConfiguration_Deploy.

properties.error

ErrorResponseBody

Contrato del cuerpo del error

properties.id

string

Identificador de resultado de la operación.

properties.resultInfo

string

Información de resultados opcional.

properties.started

string

Hora de inicio de una operación asincrónica. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.status

AsyncOperationStatus

Estado de una operación asincrónica.

properties.updated

string

Hora de la última actualización de una operación asincrónica. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Registro de la entidad que se va a crear, actualizar o eliminar.

Nombre Tipo Description
action

string

Acción como create/update/delete.

objectKey

string

Identificador de la entidad que se va a crear, actualizar o eliminar.

objectType

string

Tipo de contrato de entidad.