Deployments - What If
Devolve as alterações que serão efetuadas pela implementação se forem executadas no âmbito 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
O nome da implementação. Padrão Regex: |
resource
|
path | True |
string |
O nome do grupo de recursos no qual o modelo será implementado. O nome não é sensível a maiúsculas e minúsculas. Padrão Regex: |
subscription
|
path | True |
string |
O ID da subscrição do Microsoft Azure. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
properties | True |
As propriedades de implementação. |
|
location |
string |
A localização para armazenar os dados de implementação. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK - Devolve What-If estado da operação |
|
202 Accepted |
Aceite - Devolve URL no cabeçalho Localização para consultar o estado da operação de execução prolongada. Cabeçalhos
|
|
Other Status Codes |
Resposta de erro que descreve a razão 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 resource group scope
Pedido de amostra
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 da amostra
{
"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
Name | Description |
---|---|
Change |
Tipo de alteração que será efetuada ao recurso quando a implementação for executada. |
Cloud |
Uma resposta de erro para um pedido de gestão de recursos. |
Debug |
A definição de depuração. |
Deployment |
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. |
Deployment |
Parâmetros da operação What-if da Implementação. |
Deployment |
Propriedades what-if da implementação. |
Deployment |
Implementação What-If definições de operação. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
Resposta a Erros |
Expression |
Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado. |
Expression |
O âmbito a ser utilizado para avaliação de parâmetros, variáveis e funções num modelo aninhado. |
On |
Implementação no comportamento de erro. |
On |
A implementação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. |
Parameters |
Entidade que representa a referência aos parâmetros de implementação. |
Property |
O tipo de propriedade é alterado. |
Template |
Entidade que representa a referência ao modelo. |
What |
Informações sobre uma única alteração de recursos prevista pela operação What-If. |
What |
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. |
What |
A alteração prevista para a propriedade do recurso. |
What |
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 ou 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 |
Resposta a Erros |
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 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 |
DeploymentWhatIf
Parâmetros da operação What-if da Implementação.
Name | Tipo | Description |
---|---|---|
location |
string |
A localização para armazenar os dados de implementação. |
properties |
As propriedades de implementação. |
DeploymentWhatIfProperties
Propriedades what-if da implementação.
Name | Tipo | Description |
---|---|---|
debugSetting |
A definição de depuração da implementação. |
|
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 |
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 |
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 quiser fornecer os valores dos 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 ambas. Pode ser um JObject ou uma cadeia JSON bem formada. |
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 ambas. |
|
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 um JObject ou uma cadeia JSON bem formada. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas. |
templateLink |
O URI do modelo. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas. |
|
whatIfSettings |
Definições opcionais da operação de What-If. |
DeploymentWhatIfSettings
Implementação What-If definições de operação.
Name | Tipo | Description |
---|---|---|
resultFormat |
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ções adicionais. |
ErrorResponse
Resposta a Erros
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
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 |
O âmbito a ser utilizado para avaliação de parâmetros, variáveis e funções num modelo aninhado. |
ExpressionEvaluationOptionsScopeType
O âmbito a ser utilizado para 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 de erro.
Name | Tipo | Description |
---|---|---|
deploymentName |
string |
A implementação a ser utilizada no caso 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 | Tipo | Description |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
Entidade que representa a referência aos parâmetros de implementação.
Name | Tipo | Description |
---|---|---|
contentVersion |
string |
Se estiver incluído, tem de corresponder a ContentVersion no modelo. |
uri |
string |
O URI do ficheiro de parâmetros. |
PropertyChangeType
O tipo de propriedade é alterado.
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 nem atualizada. |
TemplateLink
Entidade que representa a referência ao modelo.
Name | Tipo | Description |
---|---|---|
contentVersion |
string |
Se estiver incluído, tem de corresponder a ContentVersion no modelo. |
id |
string |
O ID de recurso de uma Especificação de Modelo. Utilize o ID ou a propriedade URI, mas não ambos. |
queryString |
string |
A cadeia de consulta (por exemplo, um token de SAS) a ser utilizada com o URI templateLink. |
relativePath |
string |
A propriedade relativePath pode ser utilizada para implementar um modelo ligado numa localização relativa ao principal. Se o modelo principal tiver sido associado 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 parentais 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 recursos prevista pela operação 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 |
Tipo de alteração que será efetuada ao recurso quando a implementação for executada. |
|
delta |
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 |
Resposta a Erros |
|
properties.changes |
Lista de alterações de recursos previstas pela operação What-If. |
|
status |
string |
Estado da operação 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 |
Alterações de propriedade aninhadas. |
|
path |
string |
O caminho da propriedade. |
propertyChangeType |
O tipo de propriedade é alterado. |
WhatIfResultFormat
O formato dos resultados do What-If
Name | Tipo | Description |
---|---|---|
FullResourcePayloads |
string |
|
ResourceIdOnly |
string |