Partilhar via


Deployments - What If At Management Group Scope

Devolve as alterações que serão efetuadas pela implementação se forem executadas no âmbito do grupo de gestão.

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

Parâmetros do URI

Name Em Necessário Tipo Description
deploymentName
path True

string

O nome da implementação.

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

groupId
path True

string

O ID do grupo de gestão.

api-version
query True

string

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

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A localização para armazenar os dados de implementação.

properties True

DeploymentWhatIfProperties

As propriedades de implementação.

Respostas

Name Tipo Description
200 OK

WhatIfOperationResult

OK - Devolve What-If estado da operação

202 Accepted

Aceite – devolve o URL no cabeçalho Localização para consultar o estado da operação de execução prolongada.

Cabeçalhos

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

CloudError

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Predict template changes at management group scope

Pedido de amostra

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGruop/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2021-04-01

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

Resposta da amostra

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
        "changeType": "Modify",
        "before": {
          "apiVersion": "2019-06-01",
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
          "type": "Microsoft.Authorization/policyAssignments",
          "name": "myPolicyAssignment",
          "location": "westus2",
          "properties": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
            "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
            "enforcementMode": "Default"
          }
        },
        "after": {
          "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
          "changeType": "Modify",
          "before": {
            "apiVersion": "2019-06-01",
            "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
            "type": "Microsoft.Authorization/policyAssignments",
            "name": "myPolicyAssignment",
            "location": "westus2",
            "properties": {
              "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
              "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
              "enforcementMode": "DoNotEnforce"
            }
          },
          "delta": [
            {
              "path": "properties.enforcementMode",
              "propertyChangeType": "Modify",
              "before": "Default",
              "after": "DoNotEnforce"
            }
          ]
        }
      },
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
        "changeType": "Create",
        "after": {
          "apiVersion": "2019-06-01",
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
          "type": "Microsoft.Authorization/policyAssignments",
          "name": "myPolicyAssignment2",
          "location": "westus2",
          "properties": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
            "scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
            "enforcementMode": "Default"
          }
        }
      }
    ]
  }
}
Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definições

Name Description
ChangeType

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

CloudError

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

DebugSetting

A definição de depuração.

DeploymentMode

O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados 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 completo, uma vez que pode eliminar recursos involuntariamente.

DeploymentWhatIfProperties

Propriedades what-if da implementação.

DeploymentWhatIfSettings

Implementação What-If definições de operação.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorResponse

Resposta a Erros

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal 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 do 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 implementação.

PropertyChangeType

O tipo de alteração de propriedade.

ScopedDeploymentWhatIf

Parâmetros de operação What-if da Implementação.

TemplateLink

Entidade que representa a referência ao modelo.

WhatIfChange

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

WhatIfOperationResult

Resultado da operação de What-If. Contém uma lista de alterações previstas e uma ligação de URL para aceder 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á efetuada ao recurso quando a implementação for executada.

Name Tipo Description
Create

string

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

Delete

string

O recurso existe no estado atual e está em falta no estado pretendido. O recurso será eliminado quando a implementação for executada.

Deploy

string

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

Ignore

string

O recurso existe no estado atual e está em falta no estado pretendido. O recurso não será implementado nem modificado quando a implementação for executada.

Modify

string

O recurso existe no estado atual e no estado pretendido e será reimplementado quando a implementação for executada. As propriedades do recurso serão alteradas.

NoChange

string

O recurso existe no estado atual e no estado pretendido e será reimplementado quando a implementação for executada. As propriedades do recurso não serão alteradas.

Unsupported

string

O recurso não é suportado pelo What-If.

CloudError

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

Name Tipo Description
error

ErrorResponse

Resposta a Erros
Resposta de erro comum para todas as APIs Resource Manager do 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 depuração.

Name Tipo Description
detailLevel

string

Especifica o tipo de informações a registar para depuração. Os valores permitidos não são nenhum, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. A predefinição é Nenhum. Ao definir este valor, considere cuidadosamente o tipo de informação que está a transmitir durante a implementação. Ao registar informações sobre o pedido ou a resposta, pode potencialmente expor dados confidenciais obtidos através das operações de implementação.

DeploymentMode

O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados 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 completo, uma vez que pode eliminar recursos involuntariamente.

Name Tipo Description
Complete

string

Incremental

string

DeploymentWhatIfProperties

Propriedades what-if da implementação.

Name Tipo Description
debugSetting

DebugSetting

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

expressionEvaluationOptions

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado. Aplicável apenas a modelos aninhados. Se não for especificado, o valor predefinido é externo.

mode

DeploymentMode

O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados 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 completo, uma vez que pode eliminar recursos involuntariamente.

onErrorDeployment

OnErrorDeployment

A implementação no comportamento do erro.

parameters

object

Pares de nomes e valores que definem os parâmetros de implementação do modelo. Utilize este elemento quando pretender fornecer os valores de parâmetros diretamente no pedido em vez de ligar a um ficheiro de parâmetro existente. Utilize a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia JSON bem formada.

parametersLink

ParametersLink

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

template

object

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

templateLink

TemplateLink

O URI do modelo. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas.

whatIfSettings

DeploymentWhatIfSettings

Opcionais What-If definições de operação.

DeploymentWhatIfSettings

Implementação What-If definições de operação.

Name Tipo Description
resultFormat

WhatIfResultFormat

O formato dos resultados do What-If

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name 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 no âmbito do modelo principal ou do modelo aninhado.

Name Tipo Description
scope

ExpressionEvaluationOptionsScopeType

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 Tipo Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Implementação no comportamento do erro.

Name Tipo Description
deploymentName

string

A implementação a ser utilizada em caso de erro.

type

OnErrorDeploymentType

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 Tipo Description
LastSuccessful

string

SpecificDeployment

string

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

Name Tipo Description
contentVersion

string

Se estiver incluído, tem de corresponder ao ContentVersion no modelo.

uri

string

O URI do ficheiro de parâmetros.

PropertyChangeType

O tipo de alteração de propriedade.

Name 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 pretendido. A propriedade será criada quando a implementação for executada.

Delete

string

A propriedade existe no estado atual e está em falta no estado pretendido. Será eliminado quando a implementação for executada.

Modify

string

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

NoEffect

string

A propriedade não será definida ou atualizada.

ScopedDeploymentWhatIf

Parâmetros de operação What-if da Implementação.

Name Tipo Description
location

string

A localização para armazenar os dados de implementação.

properties

DeploymentWhatIfProperties

As propriedades de implementação.

Entidade que representa a referência ao modelo.

Name Tipo Description
contentVersion

string

Se estiver incluído, tem de corresponder ao ContentVersion no modelo.

id

string

O ID de recurso de uma Especificação de Modelo. Utilize a propriedade ID ou URI, mas não ambas.

queryString

string

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

relativePath

string

A propriedade relativePath pode ser utilizada para implementar um modelo ligado numa localização relativa ao principal. Se o modelo principal estiver ligado a um TemplateSpec, isto fará referência a um artefacto no TemplateSpec. Se o elemento principal tiver sido associado a um URI, a implementação subordinada será uma combinação dos URIs principal e relativePath

uri

string

O URI do modelo a implementar. Utilize a propriedade uri ou id, mas não ambas.

WhatIfChange

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

Name Tipo Description
after

object

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

before

object

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

changeType

ChangeType

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

delta

WhatIfPropertyChange[]

As alterações previstas às propriedades dos recursos.

resourceId

string

ID do Recurso

unsupportedReason

string

A explicação sobre o motivo pelo qual o recurso não é suportado pelo What-If.

WhatIfOperationResult

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

Name Tipo Description
error

ErrorResponse

Resposta a Erros
Erro ao What-If operação falhar.

properties.changes

WhatIfChange[]

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

status

string

Estado da operação de What-If.

WhatIfPropertyChange

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

Name Tipo Description
after

object

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

before

object

O valor da propriedade antes da implementaçã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

Name Tipo Description
FullResourcePayloads

string

ResourceIdOnly

string