Deployments - What If At Subscription Scope

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

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

Parametry identyfikatora URI

Name In Required Type Description
deploymentName
path True
  • string

Nazwa wdrożenia.

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

subscriptionId
path True
  • string

Identyfikator Microsoft Azure subskrypcji.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Required Type Description
properties True

Właściwości wdrożenia.

location
  • string

Lokalizacja do przechowywania danych wdrożenia.

Odpowiedzi

Name Type Description
200 OK

OK — zwraca What-If stanu operacji

202 Accepted

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

Headers

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

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

Zabezpieczenia

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 personifikować konto użytkownika

Przykłady

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

Definicje

ChangeType

Typ zmiany, która zostanie wniesiena do zasobu podczas wykonywania wdrożenia.

CloudError

Odpowiedź o błędzie dla żą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 Ukończenie zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu Ukończenie, ponieważ zasoby mogą zostać niezamierzonie usunięte.

DeploymentWhatIf

Parametry operacji what-if wdrożenia.

DeploymentWhatIfProperties

Właściwości what-if wdrożenia.

DeploymentWhatIfSettings

Ustawienia What-If operacji 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, czy szablonu zagnieżdżonych.

ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w zagnieżdżonych szablonach.

OnErrorDeployment

Wdrażanie po zachowaniu błędu.

OnErrorDeploymentType

Typ zachowania wdrożenia dla 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 zmienia się.

TemplateLink

Jednostka reprezentująca odwołanie do szablonu.

WhatIfChange

Informacje o pojedynczej zmianie zasobu przewidywanej przez What-If operacji.

WhatIfOperationResult

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

WhatIfPropertyChange

Przewidywana zmiana właściwości zasobu.

WhatIfResultFormat

Format wyników What-If danych

ChangeType

Typ zmiany, która zostanie wniesiena do zasobu podczas wykonywania wdrożenia.

Name Type Description
Create
  • string

Zasób nie istnieje w bieżącym stanie, ale jest obecny w żądanym stanie. Zasób zostanie utworzony podczas wykonywania 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żenie 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 podczas wykonywania wdrożenia.

Modify
  • string

Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożenie po wykonaniu wdrożenia. Właściwości zasobu zmienią się.

NoChange
  • string

Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożenie po wykonaniu wdrożenia. Właściwości zasobu nie zmienią się.

Unsupported
  • string

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

CloudError

Odpowiedź o błędzie dla żądania zarządzania zasobami.

Name Type Description
error

Odpowiedź na błąd
Często spotykana odpowiedź o błędzie dla wszystkich Azure Resource Manager API zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również format odpowiedzi na błąd OData).

DebugSetting

Ustawienie debugowania.

Name Type Description
detailLevel
  • string

Określa typ informacji do zalogowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent rozdzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji, które są przekazywanie podczas wdrażania. Dzięki rejestrowaniu informacji o żądaniu lub odpowiedzi można 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 Ukończenie zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu Ukończenie, ponieważ zasoby mogą zostać niezamierzonie usunięte.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentWhatIf

Parametry operacji what-if wdrożenia.

Name Type Description
location
  • string

Lokalizacja do przechowywania danych wdrożenia.

properties

Właściwości wdrożenia.

DeploymentWhatIfProperties

Właściwości what-if wdrożenia.

Name Type Description
debugSetting

Ustawienie debugowania wdrożenia.

expressionEvaluationOptions

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

mode

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 Ukończenie zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu Ukończenie, ponieważ zasoby mogą zostać niezamierzonie usunięte.

onErrorDeployment

Wdrożenie po zachowaniu błędu.

parameters
  • object

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

parametersLink

URI pliku parametrów. Ten element umożliwia połączenie z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub parameters, ale nie obu.

template
  • object

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

templateLink

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

whatIfSettings

Opcjonalne What-If operacji konfiguracji.

DeploymentWhatIfSettings

Ustawienia What-If operacji wdrażania.

Name Type Description
resultFormat

Format wyników What-If danych

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Typ dodatkowych informacji.

ErrorResponse

Odpowiedź na błąd

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

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, czy szablonu zagnieżdżonych.

Name Type Description
scope

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w zagnieżdżonych szablonach.

ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w zagnieżdżonych szablonach.

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

OnErrorDeployment

Wdrażanie po zachowaniu błędu.

Name Type Description
deploymentName
  • string

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

type

Typ zachowania wdrożenia dla błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

OnErrorDeploymentType

Typ zachowania wdrożenia dla błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type Description
contentVersion
  • string

Jeśli jest dołączony, musi być zgodne z contentversion w szablonie.

uri
  • string

URI pliku parametrów.

PropertyChangeType

Typ właściwości zmienia się.

Name Type Description
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 podczas wykonywania wdrożenia.

Delete
  • string

Właściwość istnieje w bieżącym stanie i nie ma żądanego stanu. 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.

Name Type Description
contentVersion
  • string

Jeśli jest dołączony, musi być zgodne z contentversion w szablonie.

id
  • string

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

queryString
  • string

Ciąg zapytania (na przykład token sygnatury dostępu współdzielonego), który ma być używany z szablonemLink URI.

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 elementem TemplateSpec, spowoduje to odwołanie do artefaktu w parametrze TemplateSpec. Jeśli element nadrzędny został połączony z wartością URI, wdrożenie podrzędne będzie kombinacją nadrzędnych i względnych URI ścieżki

uri
  • string

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

WhatIfChange

Informacje o pojedynczej zmianie zasobu przewidywanej przez What-If operacji.

Name Type Description
after
  • object

Przewidywana migawka zasobu po wykonaniu wdrożenia.

before
  • object

Migawka zasobu przed wykonaniem wdrożenia.

changeType

Typ zmiany, która zostanie wniesiena do zasobu podczas wykonywania wdrożenia.

delta

Przewidywane zmiany właściwości zasobów.

resourceId
  • string

Identyfikator zasobu

unsupportedReason
  • string

Wyjaśnienie, dlaczego zasób nie jest obsługiwany przez usługę What-If.

WhatIfOperationResult

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

Name Type Description
error

Odpowiedź na błąd
Błąd, gdy What-If operacja nie powiedzie się.

properties.changes

Lista zmian zasobów przewidywanych przez What-If operacji.

status
  • string

Stan operacji What-If.

WhatIfPropertyChange

Przewidywana zmiana właściwości zasobu.

Name Type Description
after
  • object

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

before
  • object

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

children

Zagnieżdżone zmiany właściwości.

path
  • string

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

propertyChangeType

Typ właściwości zmienia się.

WhatIfResultFormat

Format wyników What-If danych

Name Type Description
FullResourcePayloads
  • string
ResourceIdOnly
  • string