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 |
---|---|---|---|---|
deployment
|
path | True |
string |
Nazwa wdrożenia. Wzorzec wyrażenia regularnego: |
resource
|
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: |
subscription
|
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 |
Właściwości wdrożenia. |
|
location |
string |
Lokalizacja do przechowywania danych wdrożenia. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
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
|
|
Other Status Codes |
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 |
---|---|
Change |
Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia. |
Cloud |
Odpowiedź na błąd żądania zarządzania zasobami. |
Debug |
Ustawienie debugowania. |
Deployment |
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. |
Deployment |
Parametry operacji warunkowej wdrażania. |
Deployment |
Właściwości warunkowe wdrożenia. |
Deployment |
Ustawienia operacji What-If wdrażania. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Odpowiedź na błąd |
Expression |
Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. |
Expression |
Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. |
On |
Wdrażanie w przypadku zachowania błędu. |
On |
Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. |
Parameters |
Jednostka reprezentująca odwołanie do parametrów wdrożenia. |
Property |
Typ właściwości ulega zmianie. |
Template |
Jednostka reprezentująca odwołanie do szablonu. |
What |
Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If. |
What |
Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników. |
What |
Przewidywana zmiana właściwości zasobu. |
What |
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 |
Odpowiedź na błąd |
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 |
Właściwości wdrożenia. |
DeploymentWhatIfProperties
Właściwości warunkowe wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
debugSetting |
Ustawienie debugowania wdrożenia. |
|
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 |
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 |
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 |
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 |
Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. |
|
whatIfSettings |
Opcjonalne ustawienia operacji What-If. |
DeploymentWhatIfSettings
Ustawienia operacji What-If wdrażania.
Nazwa | Typ | Opis |
---|---|---|
resultFormat |
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 |
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 lub szablonu zagnieżdżonego.
Nazwa | Typ | Opis |
---|---|---|
scope |
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 |
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 |
ParametersLink
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. |
TemplateLink
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 |
Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia. |
|
delta |
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 |
Odpowiedź na błąd |
|
properties.changes |
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 |
Zmiany właściwości zagnieżdżone. |
|
path |
string |
Ścieżka właściwości. |
propertyChangeType |
Typ właściwości ulega zmianie. |
WhatIfResultFormat
Format wyników What-If
Nazwa | Typ | Opis |
---|---|---|
FullResourcePayloads |
string |
|
ResourceIdOnly |
string |