Sdílet prostřednictvím


Deployments - What If At Subscription Scope

Vrátí změny, které provede nasazení v rozsahu předplatného.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
deploymentName
path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Název nasazení.

subscriptionId
path True

string

ID předplatného Microsoft Azure.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
properties True

DeploymentWhatIfProperties

Vlastnosti nasazení.

location

string

Umístění pro uložení dat nasazení.

Odpovědi

Name Typ Description
200 OK

WhatIfOperationResult

OK – vrátí stav operace What-If.

202 Accepted

Přijato – vrátí adresu URL v hlavičce umístění pro dotaz na stav dlouhotrvající operace.

Hlavičky

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

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Predict template changes at subscription scope

Ukázkový požadavek

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": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Ukázková odpověď

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

Definice

Name Description
ChangeType

Typ změny, která se provede u prostředku při spuštění nasazení

CloudError

Odpověď na chybu žádosti o správu prostředků.

DebugSetting

Nastavení ladění.

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

DeploymentWhatIf

Parametry operace Citlivostní analýza nasazení

DeploymentWhatIfProperties

Vlastnosti citlivostní citlivosti nasazení

DeploymentWhatIfSettings

Nastavení operace What-If nasazení

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorResponse

Odpověď na chybu

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.

OnErrorDeployment

Nasazení při chování chyby

OnErrorDeploymentType

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

ParametersLink

Entita představující odkaz na parametry nasazení

PropertyChangeType

Typ vlastnosti se změní.

TemplateLink

Entita představující odkaz na šablonu.

WhatIfChange

Informace o jedné změně prostředku předpovězené operací What-If

WhatIfOperationResult

Výsledek operace What-If Obsahuje seznam předpovídané změny a odkaz na adresu URL, který se dostane k další sadě výsledků.

WhatIfPropertyChange

Predikovaná změna vlastnosti prostředku.

WhatIfResultFormat

Formát výsledků What-If

ChangeType

Typ změny, která se provede u prostředku při spuštění nasazení

Hodnota Description
Create

Prostředek v aktuálním stavu neexistuje, ale nachází se v požadovaném stavu. Prostředek se vytvoří při spuštění nasazení.

Delete

Prostředek existuje v aktuálním stavu a v požadovaném stavu chybí. Prostředek se odstraní při spuštění nasazení.

Deploy

Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se můžou nebo nemusí změnit.

Ignore

Prostředek existuje v aktuálním stavu a v požadovaném stavu chybí. Prostředek se při spuštění nasazení nenasadí ani nezmění.

Modify

Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se změní.

NoChange

Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se nezmění.

Unsupported

Prostředek není podporován nástrojem What-If.

CloudError

Odpověď na chybu žádosti o správu prostředků.

Name Typ Description
error

ErrorResponse

Odpověď na chybu
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

DebugSetting

Nastavení ladění.

Name Typ Description
detailLevel

string

Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty nejsou žádné, requestContent, responseContent nebo requestContent i responseContent oddělené čárkou. Výchozí hodnota není žádná. Při nastavování této hodnoty pečlivě zvažte typ informací, které předáváte během nasazování. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně vystavit citlivá data načtená prostřednictvím operací nasazení.

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

Hodnota Description
Complete
Incremental

DeploymentWhatIf

Parametry operace Citlivostní analýza nasazení

Name Typ Description
location

string

Umístění pro uložení dat nasazení.

properties

DeploymentWhatIfProperties

Vlastnosti nasazení.

DeploymentWhatIfProperties

Vlastnosti citlivostní citlivosti nasazení

Name Typ Description
debugSetting

DebugSetting

Nastavení ladění nasazení.

expressionEvaluationOptions

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony. Platí pouze pro vnořené šablony. Pokud není zadána, výchozí hodnota je vnější.

mode

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

onErrorDeployment

OnErrorDeployment

Nasazení při chování chyby.

parameters

object

Dvojice názvů a hodnot, které definují parametry nasazení pro šablonu. Tento prvek použijete, pokud chcete zadat hodnoty parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí. Může to být JObject nebo dobře formátovaný řetězec JSON.

parametersLink

ParametersLink

Identifikátor URI souboru parametrů. Tento prvek slouží k propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí.

template

object

Obsah šablony. Tento prvek použijete, pokud chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být řetězec JSON ve správném formátu nebo JObject. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.

templateLink

TemplateLink

Identifikátor URI šablony. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.

whatIfSettings

DeploymentWhatIfSettings

Volitelné nastavení operace What-If.

DeploymentWhatIfSettings

Nastavení operace What-If nasazení

Name Typ Description
resultFormat

WhatIfResultFormat

Formát výsledků What-If

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorResponse

Odpověď na chybu

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

ErrorResponse[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

Name Typ Description
scope

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.

Hodnota Description
Inner
NotSpecified
Outer

OnErrorDeployment

Nasazení při chování chyby

Name Typ Description
deploymentName

string

Nasazení, které se má použít v případě chyby.

type

OnErrorDeploymentType

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentType

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

Hodnota Description
LastSuccessful
SpecificDeployment

Entita představující odkaz na parametry nasazení

Name Typ Description
contentVersion

string

V případě zahrnutí se musí shodovat s ContentVersion v šabloně.

uri

string

Identifikátor URI souboru parametrů.

PropertyChangeType

Typ vlastnosti se změní.

Hodnota Description
Array

Vlastnost je pole a obsahuje vnořené změny.

Create

Vlastnost neexistuje v aktuálním stavu, ale je přítomna v požadovaném stavu. Vlastnost se vytvoří při spuštění nasazení.

Delete

Vlastnost existuje v aktuálním stavu a v požadovaném stavu chybí. Po spuštění nasazení se odstraní.

Modify

Vlastnost existuje v aktuálním i požadovaném stavu a je odlišná. Hodnota vlastnosti se změní při spuštění nasazení.

NoEffect

Vlastnost nebude nastavena ani aktualizována.

Entita představující odkaz na šablonu.

Name Typ Description
contentVersion

string

V případě zahrnutí se musí shodovat s ContentVersion v šabloně.

id

string

ID prostředku specifikace šablony. Použijte buď id, nebo vlastnost URI, ale ne obojí.

queryString

string

Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.

relativePath

string

Vlastnost relativePath lze použít k nasazení propojené šablony v umístění vzhledem k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v templateSpec. Pokud byl nadřazený objekt propojený s identifikátorem URI, bude podřízené nasazení kombinací nadřazených a relativních identifikátorů URI cesty.

uri

string

Identifikátor URI šablony, který se má nasadit. Použijte vlastnost identifikátoru URI nebo ID, ale ne obě.

WhatIfChange

Informace o jedné změně prostředku předpovězené operací What-If

Name Typ Description
after

object

Předpovězený snímek prostředku po spuštění nasazení

before

object

Snímek prostředku před spuštěním nasazení

changeType

ChangeType

Typ změny, která se provede u prostředku při spuštění nasazení

delta

WhatIfPropertyChange[]

Předpovězené změny vlastností prostředku.

resourceId

string

ID zdroje

unsupportedReason

string

Vysvětlení, proč prostředek není podporován službou What-If.

WhatIfOperationResult

Výsledek operace What-If Obsahuje seznam předpovídané změny a odkaz na adresu URL, který se dostane k další sadě výsledků.

Name Typ Description
error

ErrorResponse

Odpověď na chybu
Chyba při selhání operace What-If

properties.changes

WhatIfChange[]

Seznam změn prostředků predikovaných operací What-If

status

string

Stav operace What-If

WhatIfPropertyChange

Predikovaná změna vlastnosti prostředku.

Name Typ Description
after

object

Hodnota vlastnosti po spuštění nasazení.

before

object

Hodnota vlastnosti před spuštěním nasazení.

children

WhatIfPropertyChange[]

Vnořená vlastnost se změní.

path

string

Cesta vlastnosti.

propertyChangeType

PropertyChangeType

Typ vlastnosti se změní.

WhatIfResultFormat

Formát výsledků What-If

Hodnota Description
FullResourcePayloads
ResourceIdOnly