次の方法で共有


Deployments - What If

リソース グループのスコープで実行された場合にデプロイによって行われる変更を返します。

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

URI パラメーター

名前 / 必須 説明
deploymentName
path True

string

デプロイの名前。

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

resourceGroupName
path True

string

テンプレートがデプロイされるリソース グループの名前。 名前の大文字と小文字は区別されます。

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

subscriptionId
path True

string

Microsoft Azure サブスクリプション ID。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 必須 説明
properties True

DeploymentWhatIfProperties

配置プロパティです。

location

string

デプロイ データを格納する場所。

応答

名前 説明
200 OK

WhatIfOperationResult

OK - 操作の状態 What-If 返します

202 Accepted

受け入れ可能 - 実行時間の長い操作状態を照会する Url を Location ヘッダーに返します。

Headers

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

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

Predict template changes at resource group scope

Sample Request

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

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"
          }
        }
      }
    ]
  }
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

定義

名前 説明
ChangeType

デプロイの実行時にリソースに対して行われる変更の種類。

CloudError

リソース管理要求のエラー応答。

DebugSetting

デバッグ設定。

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

DeploymentWhatIf

デプロイの What-if 操作パラメーター。

DeploymentWhatIfProperties

デプロイの What-if プロパティ。

DeploymentWhatIfSettings

展開 What-If 操作の設定。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorResponse

エラー応答

ExpressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。

ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

OnErrorDeployment

エラー動作でのデプロイ。

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

ParametersLink

デプロイ パラメーターへの参照を表すエンティティ。

PropertyChangeType

プロパティの変更の種類。

TemplateLink

テンプレートへの参照を表すエンティティです。

WhatIfChange

What-If 操作によって予測される 1 つのリソース変更に関する情報。

WhatIfOperationResult

What-If 操作の結果。 予測された変更の一覧と、次の結果セットにアクセスするための URL リンクが含まれます。

WhatIfPropertyChange

リソース プロパティに対する予測された変更。

WhatIfResultFormat

What-If 結果の形式

ChangeType

デプロイの実行時にリソースに対して行われる変更の種類。

名前 説明
Create

string

リソースは現在の状態には存在しませんが、目的の状態にあります。 デプロイの実行時にリソースが作成されます。

Delete

string

リソースは現在の状態に存在し、目的の状態にありません。 デプロイの実行時にリソースが削除されます。

Deploy

string

リソースは現在の状態と目的の状態に存在し、デプロイの実行時に再デプロイされます。 リソースのプロパティは、変更される場合と変更されない場合があります。

Ignore

string

リソースは現在の状態に存在し、目的の状態にありません。 デプロイの実行時に、リソースはデプロイも変更もされません。

Modify

string

リソースは現在の状態と目的の状態に存在し、デプロイの実行時に再デプロイされます。 リソースのプロパティが変更されます。

NoChange

string

リソースは現在の状態と目的の状態に存在し、デプロイの実行時に再デプロイされます。 リソースのプロパティは変更されません。

Unsupported

string

リソースは What-If ではサポートされていません。

CloudError

リソース管理要求のエラー応答。

名前 説明
error

ErrorResponse

エラー応答
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

DebugSetting

デバッグ設定。

名前 説明
detailLevel

string

デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定する場合は、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログ記録すると、デプロイ操作で取得される重要なデータを公開する可能性があります。

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

名前 説明
Complete

string

Incremental

string

DeploymentWhatIf

デプロイの What-if 操作パラメーター。

名前 説明
location

string

デプロイ データを格納する場所。

properties

DeploymentWhatIfProperties

配置プロパティです。

DeploymentWhatIfProperties

デプロイの What-if プロパティ。

名前 説明
debugSetting

DebugSetting

デプロイのデバッグ設定。

expressionEvaluationOptions

ExpressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は outer です。

mode

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

onErrorDeployment

OnErrorDeployment

エラー時の展開の動作。

parameters

object

テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルへのリンクではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 JObject または整形式の JSON 文字列を指定できます。

parametersLink

ParametersLink

パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。

template

object

テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。

templateLink

TemplateLink

テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。

whatIfSettings

DeploymentWhatIfSettings

オプションの What-If 操作設定。

DeploymentWhatIfSettings

展開 What-If 操作の設定。

名前 説明
resultFormat

WhatIfResultFormat

What-If 結果の形式

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorResponse

エラー応答

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorResponse[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ExpressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。

名前 説明
scope

ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

名前 説明
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

エラー動作でのデプロイ。

名前 説明
deploymentName

string

エラー ケースで使用するデプロイ。

type

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

名前 説明
LastSuccessful

string

SpecificDeployment

string

デプロイ パラメーターへの参照を表すエンティティ。

名前 説明
contentVersion

string

含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。

uri

string

パラメーター ファイルの URI。

PropertyChangeType

プロパティの変更の種類。

名前 説明
Array

string

プロパティは配列であり、入れ子になった変更が含まれています。

Create

string

プロパティは現在の状態には存在しませんが、目的の状態にあります。 プロパティは、デプロイの実行時に作成されます。

Delete

string

プロパティは現在の状態に存在し、目的の状態にありません。 デプロイの実行時に削除されます。

Modify

string

プロパティは現在の状態と目的の状態の両方に存在し、異なります。 プロパティの値は、デプロイの実行時に変更されます。

NoEffect

string

プロパティは設定も更新もされません。

テンプレートへの参照を表すエンティティです。

名前 説明
contentVersion

string

含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。

id

string

テンプレート スペックのリソース ID。id プロパティまたは uri プロパティを使用しますが、両方は使用しないでください。

queryString

string

templateLink URI で使用するクエリ文字列 (SAS トークンなど)。

relativePath

string

relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートをデプロイできます。 親テンプレートが TemplateSpec とリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI とリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります

uri

string

デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。

WhatIfChange

What-If 操作によって予測される 1 つのリソース変更に関する情報。

名前 説明
after

object

デプロイが実行された後のリソースの予測スナップショット。

before

object

デプロイが実行される前のリソースのスナップショット。

changeType

ChangeType

デプロイの実行時にリソースに対して行われる変更の種類。

delta

WhatIfPropertyChange[]

リソース プロパティに対する予測された変更。

resourceId

string

リソース ID

unsupportedReason

string

リソースが What-If でサポートされていない理由に関する説明。

WhatIfOperationResult

What-If 操作の結果。 予測された変更の一覧と、次の結果セットにアクセスするための URL リンクが含まれます。

名前 説明
error

ErrorResponse

エラー応答
What-If 操作が失敗した場合にエラーが発生します。

properties.changes

WhatIfChange[]

What-If 操作によって予測されるリソース変更の一覧。

status

string

What-If 操作の状態。

WhatIfPropertyChange

リソース プロパティに対する予測された変更。

名前 説明
after

object

デプロイの実行後の プロパティの値。

before

object

デプロイが実行される前の プロパティの値。

children

WhatIfPropertyChange[]

入れ子になったプロパティの変更。

path

string

プロパティのパスです。

propertyChangeType

PropertyChangeType

プロパティの変更の種類。

WhatIfResultFormat

What-If 結果の形式

名前 説明
FullResourcePayloads

string

ResourceIdOnly

string