Deployments - What If

Devuelve los cambios que realizará la implementación si se ejecuta en el ámbito del grupo de recursos.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
deploymentName
path True

string

Nombre de la implementación.

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

Nombre del grupo de recursos en el que se implementará la plantilla. El nombre distingue mayúsculas de minúsculas.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Identificador de suscripción de Microsoft Azure.

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 True

DeploymentWhatIfProperties

Propiedades de implementación.

location

string

Ubicación para almacenar los datos de implementación.

Respuestas

Nombre Tipo Description
200 OK

WhatIfOperationResult

Aceptar: devuelve What-If estado de la operación.

202 Accepted

Aceptado: devuelve la dirección URL en el encabezado Location para consultar el estado de la operación de ejecución prolongada.

Headers

  • Location: string
  • Retry-After: string
Other Status Codes

CloudError

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

Seguridad

azure_auth

Flujo 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

Predict template changes at resource group scope

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment/whatIf?api-version=2021-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Sample Response

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
        "changeType": "Modify",
        "before": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myExistingIdentity",
          "location": "westus2"
        },
        "after": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myExistingIdentity",
          "location": "westus2",
          "tags": {
            "myNewTag": "my tag value"
          }
        },
        "delta": [
          {
            "path": "tags.myNewTag",
            "propertyChangeType": "Create",
            "after": "my tag value"
          }
        ]
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
        "changeType": "Create",
        "after": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myNewIdentity",
          "location": "eastus",
          "tags": {
            "myOtherNewTag": "another new tag value"
          }
        }
      }
    ]
  }
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definiciones

Nombre Description
ChangeType

Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.

CloudError

Una respuesta de error para una solicitud de administración de recursos.

DebugSetting

Configuración de depuración.

DeploymentMode

Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.

DeploymentWhatIf

Parámetros de operación what-if de implementación.

DeploymentWhatIfProperties

Propiedades what-if de implementación.

DeploymentWhatIfSettings

Configuración de la operación de What-If de implementación.

ErrorAdditionalInfo

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

ErrorResponse

Respuesta de error

ExpressionEvaluationOptions

Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.

ExpressionEvaluationOptionsScopeType

Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

OnErrorDeployment

Implementación en el comportamiento del error.

OnErrorDeploymentType

La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

ParametersLink

Entidad que representa la referencia a los parámetros de implementación.

PropertyChangeType

Tipo de cambio de propiedad.

TemplateLink

Entidad que representa la referencia a la plantilla.

WhatIfChange

Información sobre un único cambio de recursos previsto por What-If operación.

WhatIfOperationResult

Resultado de la operación de What-If. Contiene una lista de cambios previstos y un vínculo de dirección URL para llegar al siguiente conjunto de resultados.

WhatIfPropertyChange

Cambio previsto en la propiedad de recurso.

WhatIfResultFormat

Formato de los resultados de la What-If

ChangeType

Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.

Nombre Tipo Description
Create

string

El recurso no existe en el estado actual, pero está presente en el estado deseado. El recurso se creará cuando se ejecute la implementación.

Delete

string

El recurso existe en el estado actual y falta en el estado deseado. El recurso se eliminará cuando se ejecute la implementación.

Deploy

string

El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Es posible que las propiedades del recurso cambien o no.

Ignore

string

El recurso existe en el estado actual y falta en el estado deseado. El recurso no se implementará ni modificará cuando se ejecute la implementación.

Modify

string

El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Las propiedades del recurso cambiarán.

NoChange

string

El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Las propiedades del recurso no cambiarán.

Unsupported

string

El recurso no es compatible con What-If.

CloudError

Una respuesta de error para una solicitud de administración de recursos.

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

DebugSetting

Configuración de depuración.

Nombre Tipo Description
detailLevel

string

Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos no son ninguno, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado es none. Al establecer este valor, tenga en cuenta cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o la respuesta, se podrían exponer datos confidenciales que se recuperan en las operaciones de implementación.

DeploymentMode

Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.

Nombre Tipo Description
Complete

string

Incremental

string

DeploymentWhatIf

Parámetros de operación what-if de implementación.

Nombre Tipo Description
location

string

Ubicación para almacenar los datos de implementación.

properties

DeploymentWhatIfProperties

Propiedades de implementación.

DeploymentWhatIfProperties

Propiedades what-if de implementación.

Nombre Tipo Description
debugSetting

DebugSetting

Configuración de depuración de la implementación.

expressionEvaluationOptions

ExpressionEvaluationOptions

Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo.

mode

DeploymentMode

Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.

onErrorDeployment

OnErrorDeployment

Implementación en el comportamiento del error.

parameters

object

Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Use este elemento cuando desee proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada.

parametersLink

ParametersLink

Identificador URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas.

template

object

Contenido de la plantilla. Use este elemento cuando desee pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincularla a una plantilla existente. Puede ser una cadena JSON con formato correcto o JObject. Use la propiedad templateLink o la propiedad template, pero no ambas.

templateLink

TemplateLink

URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas.

whatIfSettings

DeploymentWhatIfSettings

Configuración opcional de la operación de What-If.

DeploymentWhatIfSettings

Configuración de la operación de What-If de implementación.

Nombre Tipo Description
resultFormat

WhatIfResultFormat

Formato de los resultados de la What-If

ErrorAdditionalInfo

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.

ErrorResponse

Respuesta de error

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorResponse[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ExpressionEvaluationOptions

Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.

Nombre Tipo Description
scope

ExpressionEvaluationOptionsScopeType

Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

ExpressionEvaluationOptionsScopeType

Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

Nombre Tipo Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Implementación en el comportamiento del error.

Nombre Tipo Description
deploymentName

string

Implementación que se va a usar en caso de error.

type

OnErrorDeploymentType

La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

OnErrorDeploymentType

La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

Nombre Tipo Description
LastSuccessful

string

SpecificDeployment

string

Entidad que representa la referencia a los parámetros de implementación.

Nombre Tipo Description
contentVersion

string

Si se incluye, debe coincidir con ContentVersion en la plantilla.

uri

string

Identificador URI del archivo de parámetros.

PropertyChangeType

Tipo de cambio de propiedad.

Nombre Tipo Description
Array

string

La propiedad es una matriz y contiene cambios anidados.

Create

string

La propiedad no existe en el estado actual, pero está presente en el estado deseado. La propiedad se creará cuando se ejecute la implementación.

Delete

string

La propiedad existe en el estado actual y falta en el estado deseado. Se eliminará cuando se ejecute la implementación.

Modify

string

La propiedad existe en el estado actual y deseado y es diferente. El valor de la propiedad cambiará cuando se ejecute la implementación.

NoEffect

string

La propiedad no se establecerá ni actualizará.

Entidad que representa la referencia a la plantilla.

Nombre Tipo Description
contentVersion

string

Si se incluye, debe coincidir con ContentVersion en la plantilla.

id

string

Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas.

queryString

string

Cadena de consulta (por ejemplo, un token de SAS) que se va a usar con el URI templateLink.

relativePath

string

La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, se hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado a un URI, la implementación secundaria será una combinación de los URI primarios y relativePath.

uri

string

URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas.

WhatIfChange

Información sobre un único cambio de recursos previsto por What-If operación.

Nombre Tipo Description
after

object

Instantánea prevista del recurso después de ejecutar la implementación.

before

object

Instantánea del recurso antes de ejecutar la implementación.

changeType

ChangeType

Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.

delta

WhatIfPropertyChange[]

Cambios previstos en las propiedades de recursos.

resourceId

string

Id. de recurso

unsupportedReason

string

Explicación sobre por qué el recurso no es compatible con What-If.

WhatIfOperationResult

Resultado de la operación de What-If. Contiene una lista de cambios previstos y un vínculo de dirección URL para llegar al siguiente conjunto de resultados.

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Error cuando se produce un error en la operación de What-If.

properties.changes

WhatIfChange[]

Lista de cambios de recursos previstos por What-If operación.

status

string

Estado de la operación de What-If.

WhatIfPropertyChange

Cambio previsto en la propiedad de recurso.

Nombre Tipo Description
after

object

Valor de la propiedad después de ejecutar la implementación.

before

object

Valor de la propiedad antes de ejecutar la implementación.

children

WhatIfPropertyChange[]

Cambios en la propiedad anidada.

path

string

Ruta de acceso de la propiedad.

propertyChangeType

PropertyChangeType

Tipo de cambio de propiedad.

WhatIfResultFormat

Formato de los resultados de la What-If

Nombre Tipo Description
FullResourcePayloads

string

ResourceIdOnly

string