Tenant Configuration - Deploy

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Esta operación aplica los cambios de la rama de Git especificada a la base de datos de configuración. 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/deploy?api-version=2024-05-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 minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta 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 aplicar los cambios de la rama de Git a la base de datos.
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. Encabezados location: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

OperationResultContract

Resultado de aplicar los cambios de la rama de Git a la base de datos.

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.

Encabezados

location: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementTenantConfigurationDeploy

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

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

Definiciones

Nombre	Description
AsyncOperationStatus	Estado de una operación asincrónica.
configurationIdName	Identificador de la operación de configuración de Git.
DeployConfigurationParameters	Implemente el contrato de configuración de inquilinos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
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

Enumeración

Estado de una operación asincrónica.

Valor	Description
Failed
InProgress
Started
Succeeded

configurationIdName

Enumeración

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

Valor	Description
configuration

DeployConfigurationParameters

Object

Implemente el 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.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorFieldContract

Object

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

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ErrorResponseBody

Object

Contrato cuerpo de error.

Nombre	Tipo	Description
code	string	Código de error definido por el servicio. Este código actúa como subestado para el 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

Object

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

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el 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 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 de cuerpo de error
properties.id	string	Identificador de resultado de la operación.
properties.resultInfo	string	Información de resultados opcional.
properties.started	string (date-time)	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 (date-time)	Hora de ú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 del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Object

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.

Compartir a través de

Tenant Configuration - Deploy

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementTenantConfigurationDeploy

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AsyncOperationStatus

configurationIdName

DeployConfigurationParameters

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

Recursos adicionales