Deployments - What If
Vrátí změny, které provede nasazení, pokud se spustí v oboru skupiny prostředků.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
Název nasazení. Vzor regulárního výrazu: |
resource
|
path | True |
string |
Název skupiny prostředků, do které se šablona nasadí. V názvu se rozlišují malá a velká písmena. Vzor regulárního výrazu: |
subscription
|
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 |
Vlastnosti nasazení. |
|
location |
string |
Umístění pro uložení dat nasazení. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
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
|
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
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 resource group scope
Ukázkový požadavek
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"
}
}
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"
}
}
}
]
}
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
Definice
Name | Description |
---|---|
Change |
Typ změny, která se provede v prostředku při spuštění nasazení. |
Cloud |
Chybová odpověď pro žádost o správu prostředků. |
Debug |
Nastavení ladění |
Deployment |
Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky. |
Deployment |
Parametry operace Citlivostní analýza nasazení. |
Deployment |
Vlastnosti citlivostní analýzy nasazení |
Deployment |
Nasazení What-If nastavení operace. |
Error |
Další informace o chybě správy prostředků |
Error |
Odpověď na chybu |
Expression |
Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony. |
Expression |
Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně. |
On |
Nasazení při chybovém chování. |
On |
Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment. |
Parameters |
Entita představující odkaz na parametry nasazení |
Property |
Typ vlastnosti se změní. |
Template |
Entita představující odkaz na šablonu |
What |
Informace o změně jednoho prostředku předpovězené operací What-If |
What |
Výsledek operace What-If. Obsahuje seznam předpověděných změn a odkaz url pro přístup k další sadě výsledků. |
What |
Predikovaná změna vlastnosti prostředku |
What |
Formát výsledků What-If |
ChangeType
Typ změny, která se provede v prostředku při spuštění nasazení.
Name | Typ | Description |
---|---|---|
Create |
string |
Prostředek neexistuje v aktuálním stavu, ale je v požadovaném stavu. Prostředek se vytvoří při spuštění nasazení. |
Delete |
string |
Prostředek existuje v aktuálním stavu a chybí v požadovaném stavu. Prostředek se odstraní při spuštění nasazení. |
Deploy |
string |
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 mohou nebo nemusí změnit. |
Ignore |
string |
Prostředek existuje v aktuálním stavu a chybí v požadovaném stavu. Při spuštění nasazení se prostředek nenasadí ani neupraví. |
Modify |
string |
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 |
string |
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 |
string |
What-If prostředek nepodporuje. |
CloudError
Chybová odpověď pro žádost o správu prostředků.
Name | Typ | Description |
---|---|---|
error |
Odpověď na chybu |
DebugSetting
Nastavení ladění
Name | Typ | Description |
---|---|---|
detailLevel |
string |
Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty jsou none, requestContent, responseContent nebo requestContent a responseContent oddělené čárkami. Výchozí hodnota je none. 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ě zveřejnit citlivá data, která se načítají 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 dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky.
Name | Typ | Description |
---|---|---|
Complete |
string |
|
Incremental |
string |
DeploymentWhatIf
Parametry operace Citlivostní analýza nasazení.
Name | Typ | Description |
---|---|---|
location |
string |
Umístění pro uložení dat nasazení. |
properties |
Vlastnosti nasazení. |
DeploymentWhatIfProperties
Vlastnosti citlivostní analýzy nasazení
Name | Typ | Description |
---|---|---|
debugSetting |
Nastavení ladění nasazení. |
|
expressionEvaluationOptions |
Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony. Platí jenom pro vnořené šablony. Pokud není zadán, výchozí hodnota je vnější. |
|
mode |
Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky. |
|
onErrorDeployment |
Chování nasazení při chybě. |
|
parameters |
object |
Páry název a hodnota, které definují parametry nasazení pro šablonu. Tento prvek použijete, když chcete zadat hodnoty parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti. Může to být JObject nebo dobře formátovaný řetězec JSON. |
parametersLink |
Identifikátor URI souboru parametrů. Tento prvek použijete k propojení s existujícím souborem parametrů. Použijte vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti. |
|
template |
object |
Obsah šablony. Tento prvek použijete, když chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být JObject nebo dobře formátovaný řetězec JSON. Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí. |
templateLink |
Identifikátor URI šablony Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí. |
|
whatIfSettings |
Volitelné What-If nastavení operace. |
DeploymentWhatIfSettings
Nasazení What-If nastavení operace.
Name | Typ | Description |
---|---|---|
resultFormat |
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 |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
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 rozsahu nadřazené šablony nebo vnořené šablony.
Name | Typ | Description |
---|---|---|
scope |
Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně. |
ExpressionEvaluationOptionsScopeType
Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.
Name | Typ | Description |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Nasazení při chybovém chování.
Name | Typ | Description |
---|---|---|
deploymentName |
string |
Nasazení, které se má použít v případě chyby. |
type |
Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment. |
OnErrorDeploymentType
Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.
Name | Typ | Description |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
Entita představující odkaz na parametry nasazení
Name | Typ | Description |
---|---|---|
contentVersion |
string |
Pokud je součástí, musí se shodovat s ContentVersion v šabloně. |
uri |
string |
Identifikátor URI souboru parametrů. |
PropertyChangeType
Typ vlastnosti se změní.
Name | Typ | Description |
---|---|---|
Array |
string |
Vlastnost je pole a obsahuje vnořené změny. |
Create |
string |
Vlastnost neexistuje v aktuálním stavu, ale je v požadovaném stavu. Vlastnost se vytvoří při spuštění nasazení. |
Delete |
string |
Vlastnost existuje v aktuálním stavu a v požadovaném stavu chybí. Při spuštění nasazení se odstraní. |
Modify |
string |
Vlastnost existuje v aktuálním i požadovaném stavu a liší se. Hodnota vlastnosti se změní při spuštění nasazení. |
NoEffect |
string |
Vlastnost nebude nastavena ani aktualizována. |
TemplateLink
Entita představující odkaz na šablonu
Name | Typ | Description |
---|---|---|
contentVersion |
string |
Pokud je součástí, musí se shodovat s ContentVersion v šabloně. |
id |
string |
ID prostředku specifikace šablony. Použijte buď vlastnost ID, nebo URI, ale ne obě. |
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í relativním k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v TemplateSpec. Pokud byl nadřazený objekt propojený pomocí identifikátoru URI, podřízené nasazení bude kombinací nadřazených a relativních identifikátorů URI. |
uri |
string |
Identifikátor URI šablony, která se má nasadit. Použijte vlastnost URI nebo ID, ale ne obě vlastnosti. |
WhatIfChange
Informace o změně jednoho prostředku předpovězené operací What-If
Name | Typ | Description |
---|---|---|
after |
object |
Predikovaný snímek prostředku po spuštění nasazení |
before |
object |
Snímek prostředku před spuštěním nasazení |
changeType |
Typ změny, která se provede v prostředku při spuštění nasazení. |
|
delta |
Predikované změny vlastností prostředku |
|
resourceId |
string |
ID prostředku |
unsupportedReason |
string |
Vysvětlení, proč what-If prostředek nepodporuje. |
WhatIfOperationResult
Výsledek operace What-If. Obsahuje seznam předpověděných změn a odkaz url pro přístup k další sadě výsledků.
Name | Typ | Description |
---|---|---|
error |
Odpověď na chybu |
|
properties.changes |
Seznam změn prostředků předpověděný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 |
Změny vnořených vlastností |
|
path |
string |
Cesta vlastnosti. |
propertyChangeType |
Typ vlastnosti se změní. |
WhatIfResultFormat
Formát výsledků What-If
Name | Typ | Description |
---|---|---|
FullResourcePayloads |
string |
|
ResourceIdOnly |
string |