Udostępnij za pośrednictwem


Deployments - What If

Zwraca zmiany, które zostaną wprowadzone przez wdrożenie, jeśli zostaną wykonane w zakresie grupy zasobów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
deploymentName
path True

string

Nazwa wdrożenia.

Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

Nazwa grupy zasobów, w ramach których zostanie wdrożony szablon. W nazwie jest uwzględniana wielkość liter.

Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Identyfikator subskrypcji platformy Microsoft Azure.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Wymagane Typ Opis
properties True

DeploymentWhatIfProperties

Właściwości wdrożenia.

location

string

Lokalizacja do przechowywania danych wdrożenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

WhatIfOperationResult

OK — zwraca stan operacji What-If

202 Accepted

Zaakceptowane — zwraca adres URL w nagłówku Location, aby wysłać zapytanie o długotrwały stan operacji.

Nagłówki

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

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Predict template changes at resource group scope

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ChangeType

Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

DebugSetting

Ustawienie debugowania.

DeploymentMode

Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Zachowaj ostrożność podczas korzystania z trybu pełnego, ponieważ możesz przypadkowo usunąć zasoby.

DeploymentWhatIf

Parametry operacji warunkowej wdrażania.

DeploymentWhatIfProperties

Właściwości warunkowe wdrożenia.

DeploymentWhatIfSettings

Ustawienia operacji What-If wdrażania.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorResponse

Odpowiedź na błąd

ExpressionEvaluationOptions

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego.

ExpressionEvaluationOptionsScopeType

Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

OnErrorDeployment

Wdrażanie w przypadku zachowania błędu.

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

ParametersLink

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

PropertyChangeType

Typ właściwości ulega zmianie.

TemplateLink

Jednostka reprezentująca odwołanie do szablonu.

WhatIfChange

Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If.

WhatIfOperationResult

Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników.

WhatIfPropertyChange

Przewidywana zmiana właściwości zasobu.

WhatIfResultFormat

Format wyników What-If

ChangeType

Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.

Nazwa Typ Opis
Create

string

Zasób nie istnieje w bieżącym stanie, ale jest obecny w żądanym stanie. Zasób zostanie utworzony po wykonaniu wdrożenia.

Delete

string

Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Zasób zostanie usunięty po wykonaniu wdrożenia.

Deploy

string

Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożony po wykonaniu wdrożenia. Właściwości zasobu mogą, ale nie muszą ulec zmianie.

Ignore

string

Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Zasób nie zostanie wdrożony ani zmodyfikowany po wykonaniu wdrożenia.

Modify

string

Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie wdrożony ponownie po wykonaniu wdrożenia. Właściwości zasobu zostaną zmienione.

NoChange

string

Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożony po wykonaniu wdrożenia. Właściwości zasobu nie zostaną zmienione.

Unsupported

string

Zasób nie jest obsługiwany przez funkcję What-If.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

DebugSetting

Ustawienie debugowania.

Nazwa Typ Opis
detailLevel

string

Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkiem. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie wziąć pod uwagę typ przekazywanych informacji podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania.

DeploymentMode

Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Zachowaj ostrożność podczas korzystania z trybu pełnego, ponieważ możesz przypadkowo usunąć zasoby.

Nazwa Typ Opis
Complete

string

Incremental

string

DeploymentWhatIf

Parametry operacji warunkowej wdrażania.

Nazwa Typ Opis
location

string

Lokalizacja do przechowywania danych wdrożenia.

properties

DeploymentWhatIfProperties

Właściwości wdrożenia.

DeploymentWhatIfProperties

Właściwości warunkowe wdrożenia.

Nazwa Typ Opis
debugSetting

DebugSetting

Ustawienie debugowania wdrożenia.

expressionEvaluationOptions

ExpressionEvaluationOptions

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko zagnieżdżonych szablonów. Jeśli nie zostanie określona, wartość domyślna jest zewnętrzna.

mode

DeploymentMode

Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Zachowaj ostrożność podczas korzystania z trybu pełnego, ponieważ możesz przypadkowo usunąć zasoby.

onErrorDeployment

OnErrorDeployment

Wdrożenie w przypadku zachowania błędu.

parameters

object

Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON.

parametersLink

ParametersLink

Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu.

template

object

Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.

templateLink

TemplateLink

Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.

whatIfSettings

DeploymentWhatIfSettings

Opcjonalne ustawienia operacji What-If.

DeploymentWhatIfSettings

Ustawienia operacji What-If wdrażania.

Nazwa Typ Opis
resultFormat

WhatIfResultFormat

Format wyników What-If

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorResponse[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ExpressionEvaluationOptions

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego.

Nazwa Typ Opis
scope

ExpressionEvaluationOptionsScopeType

Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

ExpressionEvaluationOptionsScopeType

Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

Nazwa Typ Opis
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Wdrażanie w przypadku zachowania błędu.

Nazwa Typ Opis
deploymentName

string

Wdrożenie do użycia w przypadku błędu.

type

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

Nazwa Typ Opis
LastSuccessful

string

SpecificDeployment

string

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Nazwa Typ Opis
contentVersion

string

W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.

uri

string

Identyfikator URI pliku parametrów.

PropertyChangeType

Typ właściwości ulega zmianie.

Nazwa Typ Opis
Array

string

Właściwość jest tablicą i zawiera zagnieżdżone zmiany.

Create

string

Właściwość nie istnieje w bieżącym stanie, ale jest obecna w żądanym stanie. Właściwość zostanie utworzona po wykonaniu wdrożenia.

Delete

string

Właściwość istnieje w bieżącym stanie i brakuje jej w żądanym stanie. Zostanie on usunięty po wykonaniu wdrożenia.

Modify

string

Właściwość istnieje zarówno w bieżącym, jak i żądanym stanie i jest inna. Wartość właściwości zmieni się po wykonaniu wdrożenia.

NoEffect

string

Właściwość nie zostanie ustawiona ani zaktualizowana.

Jednostka reprezentująca odwołanie do szablonu.

Nazwa Typ Opis
contentVersion

string

W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.

id

string

Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu.

queryString

string

Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI templateLink.

relativePath

string

Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, odwołuje się to do artefaktu w szablonie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI elementu nadrzędnego i względnegopath

uri

string

Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu.

WhatIfChange

Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If.

Nazwa Typ Opis
after

object

Przewidywana migawka zasobu po wykonaniu wdrożenia.

before

object

Migawka zasobu przed wykonaniem wdrożenia.

changeType

ChangeType

Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.

delta

WhatIfPropertyChange[]

Przewidywane zmiany właściwości zasobu.

resourceId

string

Identyfikator zasobu

unsupportedReason

string

Wyjaśnienie, dlaczego zasób jest nieobsługiwany przez what-If.

WhatIfOperationResult

Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Błąd, gdy operacja What-If kończy się niepowodzeniem.

properties.changes

WhatIfChange[]

Lista zmian zasobów przewidywanych przez operację What-If.

status

string

Stan operacji What-If.

WhatIfPropertyChange

Przewidywana zmiana właściwości zasobu.

Nazwa Typ Opis
after

object

Wartość właściwości po wykonaniu wdrożenia.

before

object

Wartość właściwości przed wykonaniem wdrożenia.

children

WhatIfPropertyChange[]

Zmiany właściwości zagnieżdżone.

path

string

Ścieżka właściwości.

propertyChangeType

PropertyChangeType

Typ właściwości ulega zmianie.

WhatIfResultFormat

Format wyników What-If

Nazwa Typ Opis
FullResourcePayloads

string

ResourceIdOnly

string