Deployments - What If At Tenant Scope

테넌트 그룹의 범위에서 실행되는 경우 배포에 의해 변경될 변경 내용을 반환합니다.

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

URI 매개 변수

Name In Required Type Description
deploymentName
path True
  • string

배포의 이름입니다.

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

api-version
query True
  • string

이 작업에 사용할 API 버전입니다.

요청 본문

Name Required Type Description
location True
  • string

배포 데이터를 저장할 위치입니다.

properties True

배포 속성입니다.

응답

Name Type Description
200 OK

확인 - What-If 작업 상태를 반환합니다.

202 Accepted

수락됨 - 장기 실행 작업 상태를 쿼리할 위치 헤더의 URL을 반환합니다.

Headers

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

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

Predict template changes at management group scope

Sample Request

POST https://management.azure.com/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Sample Response

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
        "changeType": "Create",
        "after": {
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
          "apiVersion": "2019-11-01",
          "type": "Microsoft.Management/managementGroups",
          "name": "myManagementGroup"
        }
      }
    ]
  }
}
Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

정의

ChangeType

배포가 실행될 때 리소스에 적용되는 변경 유형입니다.

CloudError

리소스 관리 요청에 대한 오류 응답입니다.

DebugSetting

디버그 설정입니다.

DeploymentMode

리소스를 배포하는 데 사용되는 모드입니다. 이 값은 증분 또는 완료일 수 있습니다. 증분 모드에서 리소스는 템플릿에 포함되지 않은 기존 리소스를 삭제하지 않고 배포됩니다. 완료 모드에서는 리소스가 배포되고 템플릿에 포함되지 않은 리소스 그룹의 기존 리소스가 삭제됩니다. 의도치 않게 리소스를 삭제할 수 있으므로 완료 모드를 사용할 때는 주의해야 합니다.

DeploymentWhatIfProperties

배포 What-if 속성입니다.

DeploymentWhatIfSettings

배포 What-If 작업 설정입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorResponse

오류 응답

ExpressionEvaluationOptions

부모 템플릿 또는 중첩된 템플릿의 범위 내에서 템플릿 식을 계산할지 여부를 지정합니다.

ExpressionEvaluationOptionsScopeType

중첩된 템플릿에서 매개 변수, 변수 및 함수를 평가하는 데 사용할 범위입니다.

OnErrorDeployment

오류 동작에 대한 배포입니다.

OnErrorDeploymentType

오류 동작 유형에 대한 배포입니다. 가능한 값은 LastSuccessful 및 SpecificDeployment입니다.

ParametersLink

배포 매개 변수에 대한 참조를 나타내는 엔터티입니다.

PropertyChangeType

속성 변경의 형식입니다.

ScopedDeploymentWhatIf

배포 What-if 작업 매개 변수.

TemplateLink

템플릿에 대한 참조를 나타내는 엔터티입니다.

WhatIfChange

What-If 작업에서 예측하는 단일 리소스 변경에 대한 정보입니다.

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, responseContent 또는 requestContent와 responseContent를 모두 쉼표로 구분합니다. 기본값은 none입니다. 이 값을 설정할 때 배포 중에 전달하는 정보 유형을 신중하게 고려합니다. 요청 또는 응답에 대한 정보를 로깅하게 되면 배포 작업을 통해 검색되는 중요한 데이터가 노출될 가능성이 있기 때문입니다.

DeploymentMode

리소스를 배포하는 데 사용되는 모드입니다. 이 값은 증분 또는 완료일 수 있습니다. 증분 모드에서 리소스는 템플릿에 포함되지 않은 기존 리소스를 삭제하지 않고 배포됩니다. 완료 모드에서는 리소스가 배포되고 템플릿에 포함되지 않은 리소스 그룹의 기존 리소스가 삭제됩니다. 의도치 않게 리소스를 삭제할 수 있으므로 완료 모드를 사용할 때는 주의해야 합니다.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentWhatIfProperties

배포 What-if 속성입니다.

Name Type Description
debugSetting

배포의 디버그 설정입니다.

expressionEvaluationOptions

부모 템플릿 또는 중첩된 템플릿의 범위 내에서 템플릿 식을 계산할지 여부를 지정합니다. 중첩된 템플릿에만 적용됩니다. 지정하지 않으면 기본값이 외부 값입니다.

mode

리소스를 배포하는 데 사용되는 모드입니다. 이 값은 증분 또는 완료일 수 있습니다. 증분 모드에서 리소스는 템플릿에 포함되지 않은 기존 리소스를 삭제하지 않고 배포됩니다. 완료 모드에서는 리소스가 배포되고 템플릿에 포함되지 않은 리소스 그룹의 기존 리소스가 삭제됩니다. 의도치 않게 리소스를 삭제할 수 있으므로 완료 모드를 사용할 때는 주의해야 합니다.

onErrorDeployment

오류 동작에 대한 배포입니다.

parameters
  • object

템플릿에 대한 배포 매개 변수를 정의하는 이름 및 값 쌍입니다. 기존 매개 변수 파일에 연결하지 않고 요청에서 직접 매개 변수 값을 제공하려는 경우 이 요소를 사용합니다. parametersLink 속성 또는 매개 변수 속성을 사용하지만 둘 다 사용하지는 않습니다. JObject 또는 잘 구성된 JSON 문자열일 수 있습니다.

parametersLink

매개 변수 파일의 URI입니다. 이 요소를 사용하여 기존 매개 변수 파일에 연결합니다. parametersLink 속성 또는 매개 변수 속성을 사용하지만 둘 다 사용하지는 않습니다.

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 및 SpecificDeployment입니다.

OnErrorDeploymentType

오류 동작 유형에 대한 배포입니다. 가능한 값은 LastSuccessful 및 SpecificDeployment입니다.

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

속성이 설정되거나 업데이트되지 않습니다.

ScopedDeploymentWhatIf

배포 What-if 작업 매개 변수.

Name Type Description
location
  • string

배포 데이터를 저장할 위치입니다.

properties

배포 속성입니다.

템플릿에 대한 참조를 나타내는 엔터티입니다.

Name Type Description
contentVersion
  • string

포함된 경우 템플릿의 ContentVersion과 일치해야 합니다.

id
  • string

템플릿 사양의 리소스 ID입니다. ID 또는 uri 속성을 사용하지만 둘 다 사용하지는 않습니다.

queryString
  • string

templateLink URI와 함께 사용할 쿼리 문자열(예: SAS 토큰)입니다.

relativePath
  • string

relativePath 속성을 사용하여 부모에 상대적인 위치에 연결된 템플릿을 배포할 수 있습니다. 부모 템플릿이 TemplateSpec과 연결된 경우 TemplateSpec의 아티팩트를 참조합니다. 부모가 URI와 연결된 경우 자식 배포는 부모 및 relativePath URI의 조합이 됩니다.

uri
  • string

배포할 템플릿의 URI입니다. URI 또는 ID 속성을 사용하지만 둘 다 사용하지는 않습니다.

WhatIfChange

What-If 작업에서 예측하는 단일 리소스 변경에 대한 정보입니다.

Name Type Description
after
  • object

배포가 실행된 후 리소스의 예측 스냅샷입니다.

before
  • object

배포가 실행되기 전에 리소스의 스냅샷입니다.

changeType

배포가 실행될 때 리소스에 적용되는 변경 유형입니다.

delta

리소스 속성에 대한 예측 변경 내용입니다.

resourceId
  • string

리소스 ID

unsupportedReason
  • string

What-If에서 리소스를 지원하지 않는 이유에 대한 설명입니다.

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