Deployments - What If At Subscription Scope

サブスクリプションのスコープで実行された場合に、デプロイによって行われる変更を返します。

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

URI パラメーター

Name In Required Type Description
deploymentName
path True
  • string

デプロイの名前。

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Required Type Description
properties True

配置プロパティです。

location
  • string

配置データを格納する場所。

応答

Name Type Description
200 OK

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

202 Accepted

受諾-実行時間の長い操作の状態を照会する Location ヘッダーの URL を返します。

Headers

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

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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

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

定義

ChangeType

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

CloudError

リソース管理要求に対するエラー応答。

DebugSetting

デバッグ設定。

DeploymentMode

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

DeploymentWhatIf

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

DeploymentWhatIfProperties

配置の What-if プロパティ。

DeploymentWhatIfSettings

配置 What-If 操作設定です。

ErrorAdditionalInfo

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

ErrorResponse

エラー応答

ExpressionEvaluationOptions

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

ExpressionEvaluationOptionsScopeType

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

OnErrorDeployment

エラー動作時の配置。

OnErrorDeploymentType

エラー動作の種類の配置。 使用可能な値は、LastSuccessful と固有の配置です。

ParametersLink

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

PropertyChangeType

プロパティ変更の型。

TemplateLink

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

WhatIfChange

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

WhatIfOperationResult

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

WhatIfPropertyChange

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

WhatIfResultFormat

What-If の結果の形式

ChangeType

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

Name Type Description
Create
  • string

現在の状態にはリソースが存在しますが、必要な状態に存在します。 リソースは、デプロイの実行時に作成されます。

Delete
  • string

リソースは現在の状態に存在し、目的の状態から欠落しています。 リソースは、デプロイの実行時に削除されます。

Deploy
  • string

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

Ignore
  • string

リソースは現在の状態に存在し、目的の状態から欠落しています。 リソースは、デプロイの実行時にデプロイまたは変更されません。

Modify
  • string

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

NoChange
  • string

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

Unsupported
  • string

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

CloudError

リソース管理要求に対するエラー応答。

Name Type Description
error

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

DebugSetting

デバッグ設定。

Name Type Description
detailLevel
  • string

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

DeploymentMode

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

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentWhatIf

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

Name Type Description
location
  • string

配置データを格納する場所。

properties

配置プロパティです。

DeploymentWhatIfProperties

配置の What-if プロパティ。

Name Type Description
debugSetting

配置のデバッグ設定。

expressionEvaluationOptions

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

mode

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

onErrorDeployment

エラー動作時の配置。

parameters
  • object

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

parametersLink

パラメーターファイルの URI。 既存のパラメーターファイルにリンクするには、この要素を使用します。 ParametersLink プロパティと parameters プロパティのどちらかを使用しますが、両方は使用しません。

template
  • object

テンプレートコンテンツ。 この要素は、テンプレート構文を既存のテンプレートへのリンクではなく、要求で直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 TemplateLink プロパティとテンプレートプロパティのどちらかを使用しますが、両方は使用しません。

templateLink

テンプレートの URI。 TemplateLink プロパティとテンプレートプロパティのどちらかを使用しますが、両方は使用しません。

whatIfSettings

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

DeploymentWhatIfSettings

配置 What-If 操作設定です。

Name Type Description
resultFormat

What-If の結果の形式

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorResponse

エラー応答

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ExpressionEvaluationOptions

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

Name Type Description
scope

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

ExpressionEvaluationOptionsScopeType

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

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

OnErrorDeployment

エラー動作時の配置。

Name Type Description
deploymentName
  • string

エラーが発生した場合に使用する配置。

type

エラー動作の種類の配置。 使用可能な値は、LastSuccessful と固有の配置です。

OnErrorDeploymentType

エラー動作の種類の配置。 使用可能な値は、LastSuccessful と固有の配置です。

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type Description
contentVersion
  • string

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

uri
  • string

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

PropertyChangeType

プロパティ変更の型。

Name Type Description
Array
  • string

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

Create
  • string

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

Delete
  • string

プロパティは現在の状態に存在し、目的の状態から欠落しています。 デプロイが実行されると削除されます。

Modify
  • string

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

NoEffect
  • string

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

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

Name Type Description
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つのリソースの変更に関する情報。

Name Type Description
after
  • object

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

before
  • object

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

changeType

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

delta

リソースプロパティの予測される変更。

resourceId
  • string

Resource ID

unsupportedReason
  • string

リソースがサポートされていない理由についての説明。

WhatIfOperationResult

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

Name Type Description
error

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

properties.changes

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

status
  • string

What-If 操作の状態です。

WhatIfPropertyChange

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

Name Type Description
after
  • object

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

before
  • object

配置が実行される前の プロパティの値。

children

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

path
  • string

プロパティのパスです。

propertyChangeType

プロパティ変更の型。

WhatIfResultFormat

What-If の結果の形式

Name Type Description
FullResourcePayloads
  • string
ResourceIdOnly
  • string