Deployments - What If At Subscription Scope

Devolução de alterações que serão es feitas pela implementação se executadas no âmbito da subscrição.

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

Parâmetros do URI

Name In Required Type Description
deploymentName
path True
  • string

O nome da implantação.

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

subscriptionId
path True
  • string

O Microsoft Azure ID de assinatura.

api-version
query True
  • string

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

Corpo do Pedido

Name Required Type Description
properties True

As propriedades de implantação.

location
  • string

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

Respostas

Name Type Description
200 OK

OK - Devolução What-If estado de funcionamento

202 Accepted

Aceite - Retorna URL no cabeçalho de localização para consulta para o estado de funcionamento de longa duração.

Headers

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

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

Segurança

azure_auth

Azure Active Directory Oauth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Predict template changes at subscription scope

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment/whatIf?api-version=2021-04-01
{
  "location": "westus",
  "properties": {
    "templateLink": "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"
          }
        }
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
        "changeType": "Create",
        "after": {
          "apiVersion": "2019-03-01",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
          "type": "Microsoft.Resources/resourceGroups",
          "name": "my-resource-group2",
          "location": "{location3}"
        }
      }
    ]
  }
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definições

ChangeType

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

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

DebugSetting

A definição de depurar.

DeploymentMode

O modo que é usado para implantar recursos. Este valor pode ser incremental ou completo. No modo Incremental, os recursos são implantados sem eliminar os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são mobilizados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o modo Complete, pois pode eliminar involuntariamente os recursos.

DeploymentWhatIf

Implantar os parâmetros de funcionamento.

DeploymentWhatIfProperties

Implantação De propriedades do Que se.

DeploymentWhatIfSettings

A implementação What-If as definições de operação.

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

ErrorResponse

Resposta a Erros

ExpressionEvaluationOptions

Especifica se as expressões do modelo são avaliadas no âmbito do modelo dos pais ou do modelo aninhado.

ExpressionEvaluationOptionsScopeType

O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

OnErrorDeployment

Implementação no comportamento de erro.

OnErrorDeploymentType

A implementaçã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 mudança de propriedade.

TemplateLink

Entidade que representa a referência ao modelo.

WhatIfChange

Informação sobre uma única mudança de recursos prevista What-If operação.

WhatIfOperationResult

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

WhatIfPropertyChange

A alteração prevista para a propriedade de recursos.

WhatIfResultFormat

O formato dos resultados What-If

ChangeType

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

Name Type Description
Create
  • string

O recurso não existe no estado atual, mas está presente no estado pretendido. 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á eliminado quando a implantação for executada.

Deploy
  • string

O recurso existe no estado atual e no estado pretendido e será redistribuído 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 ou modificado quando a implantação for executada.

Modify
  • string

O recurso existe no estado atual e no estado pretendido e será redistribuído quando a implantação for executada. As propriedades do recurso vão mudar.

NoChange
  • string

O recurso existe no estado atual e no estado pretendido e será redistribuído quando a implantação for executada. As propriedades do recurso não se alterarão.

Unsupported
  • string

O recurso não é suportado pelo E-Se.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name Type Description
error

Resposta a Erros
Resposta de erro comum para todas as APIs do Gestor de Recursos Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

DebugSetting

A definição de depurar.

Name Type Description
detailLevel
  • string

Especifica o tipo de informação para registar para depurar. Os valores permitidos não são nenhum, solicitarContent, respostaContent, ou ambos solicitarContent e respostaContent separados por uma vírgula. A predefinição é Nenhum. Ao definir este valor, considere cuidadosamente o tipo de informação que está a passar durante a implementação. Ao registar informações sobre o pedido ou resposta, pode potencialmente expor dados sensíveis que são recuperados através das operações de implantação.

DeploymentMode

O modo que é usado para implantar recursos. Este valor pode ser incremental ou completo. No modo Incremental, os recursos são implantados sem eliminar os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são mobilizados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o modo Complete, pois pode eliminar involuntariamente os recursos.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentWhatIf

Implantar os parâmetros de funcionamento.

Name Type Description
location
  • string

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

properties

As propriedades de implantação.

DeploymentWhatIfProperties

Implantação De propriedades do Que se.

Name Type Description
debugSetting

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

expressionEvaluationOptions

Especifica se as expressões do modelo são avaliadas no âmbito do modelo dos pais ou do modelo aninhado. Apenas aplicável aos modelos aninhados. Se não for especificado, o valor predefinido é exterior.

mode

O modo que é usado para implantar recursos. Este valor pode ser incremental ou completo. No modo Incremental, os recursos são implantados sem eliminar os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são mobilizados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o modo Complete, pois pode eliminar involuntariamente os recursos.

onErrorDeployment

A implementação do comportamento de erro.

parameters
  • object

Nome e pares de valor que definem os parâmetros de implementação para o modelo. Utilize este elemento quando pretender fornecer os valores dos parâmetros diretamente no pedido em vez de ligar a um ficheiro de parâmetros existente. Use a propriedade parametersLink ou a propriedade dos parâmetros, mas não ambos. Pode ser um JObject ou uma corda JSON bem formada.

parametersLink

O URI do ficheiro de parâmetros. Utilize este elemento para ligar a um ficheiro de parâmetros existente. Use a propriedade parametersLink ou a propriedade dos parâmetros, mas não ambos.

template
  • object

O conteúdo do modelo. Utilize este elemento quando pretender passar a sintaxe do modelo diretamente no pedido em vez de ligar a um modelo existente. Pode ser uma corda JObject ou JSON bem formada. Use a propriedade do modeloLink ou a propriedade do modelo, mas não ambos.

templateLink

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

whatIfSettings

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

DeploymentWhatIfSettings

A implementação What-If as definições de operação.

Name Type Description
resultFormat

O formato dos resultados What-If

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name Type Description
additionalInfo

O erro informação adicional.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

ExpressionEvaluationOptions

Especifica se as expressões do modelo são avaliadas no âmbito do modelo dos pais ou do modelo aninhado.

Name Type Description
scope

O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

ExpressionEvaluationOptionsScopeType

O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Implementação no comportamento de erro.

Name Type Description
deploymentName
  • string

A colocação a utilizar na caixa de erro.

type

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

OnErrorDeploymentType

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

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type Description
contentVersion
  • string

Se incluído, deve corresponder à Versão de Conteúdo no modelo.

uri
  • string

O URI do ficheiro de parâmetros.

PropertyChangeType

O tipo de mudança de propriedade.

Name Type 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 implementação for executada.

Delete
  • string

A propriedade existe no estado atual e está ausente do estado desejado. Será apagado quando a implantação for executada.

Modify
  • string

A propriedade existe em estado atual e desejado e é diferente. O valor do imóvel mudará quando a implantação for executada.

NoEffect
  • string

A propriedade não será definida ou atualizada.

Entidade que representa a referência ao modelo.

Name Type Description
contentVersion
  • string

Se incluído, deve corresponder à Versão de Conteúdo no modelo.

id
  • string

O id de recursos de uma especificação de modelo. Use a propriedade id ou uri, mas não ambos.

queryString
  • string

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

relativePath
  • string

A propriedade relativaPath pode ser usada para implementar um modelo ligado em um local relativo ao progenitor. Se o modelo dos pais foi ligado a um ModeloSpec, este irá referenciar um artefacto no ModeloSpec. Se o progenitor estivesse ligado a um URI, a colocação da criança será uma combinação dos URIs parentais e relativos

uri
  • string

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

WhatIfChange

Informação sobre uma única mudança de recursos prevista What-If operação.

Name Type Description
after
  • object

A imagem prevista do recurso após a execução da implantação.

before
  • object

A imagem do recurso antes da implantação é executada.

changeType

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

delta

As alterações previstas nas propriedades dos recursos.

resourceId
  • string

ID do Recurso

unsupportedReason
  • string

A explicação sobre o porquê do recurso não ser suportado pelo E-Se.

WhatIfOperationResult

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

Name Type Description
error

Resposta a Erros
Erro quando What-If operação falha.

properties.changes

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

status
  • string

Estado da operação What-If.

WhatIfPropertyChange

A alteração prevista para a propriedade de recursos.

Name Type Description
after
  • object

O valor do imóvel após a execução da implantação.

before
  • object

O valor do imóvel antes da implantação é executado.

children

Alterações de propriedade aninhada.

path
  • string

O caminho da propriedade.

propertyChangeType

O tipo de mudança de propriedade.

WhatIfResultFormat

O formato dos resultados What-If

Name Type Description
FullResourcePayloads
  • string
ResourceIdOnly
  • string