Compartilhar via


Deployments - What If

Retorna alterações que serão feitas pela implantação se executadas no escopo do 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 URI

Nome Em Obrigatório Tipo Description
deploymentName
path True

string

O nome da implantação.

Padrão Regex: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

O nome do grupo de recursos no qual o modelo será implantado. O nome diferencia maiúsculas de minúsculas.

Padrão Regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

A ID da assinatura do Microsoft Azure.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties True

DeploymentWhatIfProperties

As propriedades de implantação.

location

string

O local para armazenar os dados de implantação.

Respostas

Nome Tipo Description
200 OK

WhatIfOperationResult

OK – retorna status de operação de What-If

202 Accepted

Aceito – retorna a URL no cabeçalho Local para consultar a operação de execução prolongada status.

Cabeçalhos

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

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Predict template changes at resource group scope

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ChangeType

Tipo de alteração que será feita no recurso quando a implantação for executada.

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

DebugSetting

A configuração de depuração.

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implantados sem excluir os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.

DeploymentWhatIf

Parâmetros de operação de teste de hipóteses de implantação.

DeploymentWhatIfProperties

Propriedades de teste de hipóteses de implantação.

DeploymentWhatIfSettings

Configurações de operação de What-If de implantação.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorResponse

Resposta de erro

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado.

ExpressionEvaluationOptionsScopeType

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

OnErrorDeployment

Implantação no comportamento de erro.

OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

ParametersLink

Entidade que representa a referência aos parâmetros de implantação.

PropertyChangeType

O tipo de alteração de propriedade.

TemplateLink

Entidade que representa a referência para o modelo.

WhatIfChange

Informações sobre uma única alteração de recurso prevista por What-If operação.

WhatIfOperationResult

Resultado da operação de What-If. Contém uma lista de alterações previstas e um link de URL para chegar ao próximo conjunto de resultados.

WhatIfPropertyChange

A alteração prevista para a propriedade do recurso.

WhatIfResultFormat

O formato dos resultados do What-If

ChangeType

Tipo de alteração que será feita no recurso quando a implantação for executada.

Nome Tipo Description
Create

string

O recurso não existe no estado atual, mas está presente no estado desejado. O recurso será criado quando a implantação for executada.

Delete

string

O recurso existe no estado atual e está ausente do estado desejado. O recurso será excluído quando a implantação for executada.

Deploy

string

O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso podem ou não ser alteradas.

Ignore

string

O recurso existe no estado atual e está ausente do estado desejado. O recurso não será implantado nem modificado quando a implantação for executada.

Modify

string

O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso serão alteradas.

NoChange

string

O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso não serão alteradas.

Unsupported

string

O recurso não tem suporte no What-If.

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Nome Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.)

DebugSetting

A configuração de depuração.

Nome Tipo Description
detailLevel

string

Especifica o tipo de informação a ser registrada para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é none. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log as informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais que são recuperados por meio de operações de implantação.

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implantados sem excluir os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.

Nome Tipo Description
Complete

string

Incremental

string

DeploymentWhatIf

Parâmetros de operação de teste de hipóteses de implantação.

Nome Tipo Description
location

string

O local para armazenar os dados de implantação.

properties

DeploymentWhatIfProperties

As propriedades de implantação.

DeploymentWhatIfProperties

Propriedades de teste de hipóteses de implantação.

Nome Tipo Description
debugSetting

DebugSetting

A configuração de depuração da implantação.

expressionEvaluationOptions

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será externo.

mode

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implantados sem excluir os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.

onErrorDeployment

OnErrorDeployment

A implantação no comportamento de erro.

parameters

object

Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada.

parametersLink

ParametersLink

O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos.

template

object

O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação, em vez de vincular a um modelo existente. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.

templateLink

TemplateLink

O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.

whatIfSettings

DeploymentWhatIfSettings

Configurações opcionais What-If operação.

DeploymentWhatIfSettings

Configurações de operação de What-If de implantação.

Nome Tipo Description
resultFormat

WhatIfResultFormat

O formato dos resultados do What-If

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorResponse

Resposta de erro

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorResponse[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado.

Nome Tipo Description
scope

ExpressionEvaluationOptionsScopeType

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

ExpressionEvaluationOptionsScopeType

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

Nome Tipo Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Implantação no comportamento de erro.

Nome Tipo Description
deploymentName

string

A implantação a ser usada em caso de erro.

type

OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

Nome Tipo Description
LastSuccessful

string

SpecificDeployment

string

Entidade que representa a referência aos parâmetros de implantação.

Nome Tipo Description
contentVersion

string

Se incluído, deve corresponder ao ContentVersion no modelo.

uri

string

O URI do arquivo de parâmetros.

PropertyChangeType

O tipo de alteração de propriedade.

Nome Tipo Description
Array

string

A propriedade é uma matriz e contém alterações aninhadas.

Create

string

A propriedade não existe no estado atual, mas está presente no estado desejado. A propriedade será criada quando a implantação for executada.

Delete

string

A propriedade existe no estado atual e está ausente do estado desejado. Ele será excluído quando a implantação for executada.

Modify

string

A propriedade existe no estado atual e desejado e é diferente. O valor da propriedade será alterado quando a implantação for executada.

NoEffect

string

A propriedade não será definida ou atualizada.

Entidade que representa a referência para o modelo.

Nome Tipo Description
contentVersion

string

Se incluído, deve corresponder ao ContentVersion no modelo.

id

string

A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas.

queryString

string

A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink.

relativePath

string

A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai tiver sido vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai foi vinculado a um URI, a implantação filho será uma combinação dos URIs pai e relativePath

uri

string

O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos.

WhatIfChange

Informações sobre uma única alteração de recurso prevista por What-If operação.

Nome Tipo Description
after

object

O instantâneo previsto do recurso após a implantação ser executada.

before

object

O instantâneo do recurso antes da implantação ser executada.

changeType

ChangeType

Tipo de alteração que será feita no recurso quando a implantação for executada.

delta

WhatIfPropertyChange[]

As alterações previstas nas propriedades do recurso.

resourceId

string

ID de Recurso

unsupportedReason

string

A explicação sobre por que o recurso não tem suporte no What-If.

WhatIfOperationResult

Resultado da operação de What-If. Contém uma lista de alterações previstas e um link de URL para chegar ao próximo conjunto de resultados.

Nome Tipo Description
error

ErrorResponse

Resposta de erro
Erro quando What-If operação falha.

properties.changes

WhatIfChange[]

Lista de alterações de recursos previstas por What-If operação.

status

string

Status da operação de What-If.

WhatIfPropertyChange

A alteração prevista para a propriedade do recurso.

Nome Tipo Description
after

object

O valor da propriedade após a implantação ser executada.

before

object

O valor da propriedade antes da implantação ser executada.

children

WhatIfPropertyChange[]

Alterações de propriedade aninhadas.

path

string

O caminho da propriedade.

propertyChangeType

PropertyChangeType

O tipo de alteração de propriedade.

WhatIfResultFormat

O formato dos resultados do What-If

Nome Tipo Description
FullResourcePayloads

string

ResourceIdOnly

string