Поделиться через


Deployments - What If At Tenant Scope

Возвращает изменения, которые будут вноситься развертыванием, если они выполняются в области группы клиентов.

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

Параметры URI

Имя В Обязательно Тип Описание
deploymentName
path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Название развертывания.

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
location True

string

Расположение для хранения данных развертывания.

properties True

DeploymentWhatIfProperties

Свойства развертывания.

Ответы

Имя Тип Описание
200 OK

WhatIfOperationResult

Операция Azure успешно завершена.

202 Accepted

Операция ресурса принята.

Заголовки

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

CloudError

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Predict template changes at management group scope

Образец запроса

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

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

Пример ответа

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

Определения

Имя Описание
ChangeType

Тип изменения, которое будет выполнено в ресурс при выполнении развертывания.

CloudError

Ответ об ошибке для запроса на управление ресурсами.

DebugSetting

Параметр отладки.

DeploymentDiagnosticsDefinition
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput

Внешние входные данные развертывания для параметризации.

DeploymentExternalInputDefinition

Определение внешних входных данных развертывания для параметризации.

DeploymentMode

Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.

DeploymentParameter

Параметр развертывания для шаблона.

DeploymentWhatIfProperties

Развертывание свойств What-if.

DeploymentWhatIfSettings

Параметры операции What-If развертывания.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа на ошибку OData.)

ExpressionEvaluationOptions

Указывает, оцениваются ли выражения шаблона в области родительского шаблона или вложенного шаблона.

ExpressionEvaluationOptionsScopeType

Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.

ExtensionConfigPropertyType
KeyVaultParameterReference

Azure Key Vault parameter reference.

KeyVaultReference

Azure Key Vault reference.

Level

Обозначает дополнительный уровень ответа.

OnErrorDeployment

Развертывание по поведению ошибок.

OnErrorDeploymentType

Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

ParametersLink

Сущность, представляющая ссылку на параметры развертывания.

PropertyChangeType

Тип изменения свойства.

ScopedDeploymentWhatIf

Развертывание параметров операции "Что если".

TemplateLink

Сущность, представляющая ссылку на шаблон.

ValidationLevel

Уровень проверки, выполняемой при развертывании.

WhatIfChange

Сведения об изменении одного ресурса, прогнозируемого операцией What-If.

WhatIfOperationResult

Результат операции What-If. Содержит список прогнозируемых изменений и URL-ссылку, чтобы перейти к следующему набору результатов.

WhatIfPropertyChange

Прогнозируемое изменение свойства ресурса.

WhatIfResultFormat

Формат результатов What-If

ChangeType

Тип изменения, которое будет выполнено в ресурс при выполнении развертывания.

Значение Описание
Create

Ресурс не существует в текущем состоянии, но присутствует в требуемом состоянии. Ресурс будет создан при выполнении развертывания.

Delete

Ресурс существует в текущем состоянии и отсутствует из требуемого состояния. Ресурс будет удален при выполнении развертывания.

Ignore

Ресурс существует в текущем состоянии и отсутствует из требуемого состояния. Ресурс не будет развернут или изменен при выполнении развертывания.

Deploy

Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса могут измениться или остаться без изменений.

NoChange

Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса не изменятся.

Modify

Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса изменятся.

Unsupported

Ресурс не поддерживается с помощью What-If.

CloudError

Ответ об ошибке для запроса на управление ресурсами.

Имя Тип Описание
error

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа на ошибку OData.)

DebugSetting

Параметр отладки.

Имя Тип Описание
detailLevel

string

Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания.

DeploymentDiagnosticsDefinition

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

level

Level

Обозначает дополнительный уровень ответа.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

DeploymentExtensionConfigItem

Имя Тип Описание
keyVaultReference

KeyVaultParameterReference

Ссылка Azure Key Vault использовалась для извлечения секретного значения свойства extension config.

type

ExtensionConfigPropertyType

Тип значения свойства конфигурации расширения.

value

Значение свойства config расширения.

DeploymentExtensionDefinition

Имя Тип Описание
alias

string

Псевдоним расширения, определенный в шаблоне развертывания.

config

<string,  DeploymentExtensionConfigItem>

Конфигурация расширения.

configId

string

Идентификатор конфигурации расширения. Он однозначно идентифицирует плоскость управления развертыванием в расширении.

name

string

Имя расширения.

version

string

Версия расширения.

DeploymentExternalInput

Внешние входные данные развертывания для параметризации.

Имя Тип Описание
value

Внешнее входное значение.

DeploymentExternalInputDefinition

Определение внешних входных данных развертывания для параметризации.

Имя Тип Описание
config

Конфигурация для внешнего входа.

kind

string

Вид внешнего ввода.

DeploymentMode

Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.

Значение Описание
Incremental

Добавочное

Complete

Завершено

DeploymentParameter

Параметр развертывания для шаблона.

Имя Тип Описание
expression

string

Входное выражение в параметр.

reference

KeyVaultParameterReference

Azure Key Vault parameter reference.

value

Входное значение параметра .

DeploymentWhatIfProperties

Развертывание свойств What-if.

Имя Тип Описание
debugSetting

DebugSetting

Параметр отладки развертывания.

expressionEvaluationOptions

ExpressionEvaluationOptions

Указывает, оцениваются ли выражения шаблона в области родительского шаблона или вложенного шаблона. Применимо только к вложенным шаблонам. Если не указано, значением по умолчанию является outer.

extensionConfigs

object

Конфигурации, используемые для расширений развертывания. Ключи этого объекта являются псевдонимами расширений развертывания, определенными в шаблоне развертывания.

externalInputDefinitions

<string,  DeploymentExternalInputDefinition>

Определения внешних входных данных, используемые внешними инструментами для определения ожидаемых внешних входных значений.

externalInputs

<string,  DeploymentExternalInput>

Внешние входные значения, используемые внешним инструментом для оценки параметров.

mode

DeploymentMode

Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.

onErrorDeployment

OnErrorDeployment

Развертывание по поведению ошибок.

parameters

<string,  DeploymentParameter>

Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON.

parametersLink

ParametersLink

Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.

template

Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба.

templateLink

TemplateLink

Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба.

validationLevel

ValidationLevel

Уровень проверки развертывания

whatIfSettings

DeploymentWhatIfSettings

Необязательные параметры операции What-If.

DeploymentWhatIfSettings

Параметры операции What-If развертывания.

Имя Тип Описание
resultFormat

WhatIfResultFormat

Формат результатов What-If

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа на ошибку OData.)

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorResponse[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ExpressionEvaluationOptions

Указывает, оцениваются ли выражения шаблона в области родительского шаблона или вложенного шаблона.

Имя Тип Описание
scope

ExpressionEvaluationOptionsScopeType

Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.

ExpressionEvaluationOptionsScopeType

Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.

Значение Описание
NotSpecified

Не указано

Outer

Внешняя часть

Inner

Внутренний

ExtensionConfigPropertyType

Значение Описание
String

Тип свойства, представляющий строковое значение.

Int

Тип свойства, представляющий целочисленное значение.

Bool

Тип свойства, представляющий логическое значение.

Array

Тип свойства, представляющий значение массива.

Object

Тип свойства, представляющий значение объекта.

SecureString

Тип свойства, представляющий безопасное строковое значение.

SecureObject

Тип свойства, представляющий значение безопасного объекта.

KeyVaultParameterReference

Azure Key Vault parameter reference.

Имя Тип Описание
keyVault

KeyVaultReference

Azure Key Vault reference.

secretName

string

Azure Key Vault secret name.

secretVersion

string

Azure Key Vault secret version.

KeyVaultReference

Azure Key Vault reference.

Имя Тип Описание
id

string

Azure Key Vault resource id.

Level

Обозначает дополнительный уровень ответа.

Значение Описание
Warning

Предупреждение

Info

Info

Error

Error

OnErrorDeployment

Развертывание по поведению ошибок.

Имя Тип Описание
deploymentName

string

Развертывание, используемое в случае ошибки.

type

OnErrorDeploymentType

Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

OnErrorDeploymentType

Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

Значение Описание
LastSuccessful

ПоследнийУспешный

SpecificDeployment

Конкретное развертывание

Сущность, представляющая ссылку на параметры развертывания.

Имя Тип Описание
contentVersion

string

Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.

uri

string

URI файла параметров.

PropertyChangeType

Тип изменения свойства.

Значение Описание
Create

Свойство не существует в текущем состоянии, но присутствует в требуемом состоянии. Свойство будет создано при выполнении развертывания.

Delete

Свойство существует в текущем состоянии и отсутствует из требуемого состояния. Она будет удалена при выполнении развертывания.

Modify

Свойство существует как в текущем, так и требуемом состоянии и отличается. Значение свойства изменится при выполнении развертывания.

Array

Свойство является массивом и содержит вложенные изменения.

NoEffect

Свойство не будет задано или обновлено.

ScopedDeploymentWhatIf

Развертывание параметров операции "Что если".

Имя Тип Описание
location

string

Расположение для хранения данных развертывания.

properties

DeploymentWhatIfProperties

Свойства развертывания.

Сущность, представляющая ссылку на шаблон.

Имя Тип Описание
contentVersion

string

Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.

id

string

Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба.

queryString

string

Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink.

relativePath

string

Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath.

uri

string

Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба.

ValidationLevel

Уровень проверки, выполняемой при развертывании.

Значение Описание
Template

Выполнен статический анализ шаблона.

Provider

Выполняется статический анализ шаблона и объявления ресурсов отправляются поставщикам ресурсов для семантической валидации. Проверяет, есть ли у вызывающего объекта разрешения на запись RBAC для каждого ресурса.

ProviderNoRbac

Выполняется статический анализ шаблона и объявления ресурсов отправляются поставщикам ресурсов для семантической валидации. Пропускает проверку того, что вызывающий объект имеет разрешения на запись RBAC для каждого ресурса.

WhatIfChange

Сведения об изменении одного ресурса, прогнозируемого операцией What-If.

Имя Тип Описание
after

Прогнозируемый моментальный снимок ресурса после выполнения развертывания.

before

Моментальный снимок ресурса перед выполнением развертывания.

changeType

ChangeType

Тип изменения, которое будет выполнено в ресурс при выполнении развертывания.

delta

WhatIfPropertyChange[]

Прогнозируемые изменения свойств ресурса.

deploymentId

string

Идентификатор ресурса развертывания, ответственного за это изменение.

extension

DeploymentExtensionDefinition

Расширение, с которым был развернут ресурс.

identifiers

Подмножество свойств, которые уникально идентифицируют расширяемый ресурс Bicep, потому что у него нет идентификатора ресурса, как у ресурса Azure.

resourceId

string

ИД ресурса

symbolicName

string

Символическое имя ресурса, ответственного за это изменение.

unsupportedReason

string

Объяснение того, почему ресурс не поддерживается с помощью What-If.

WhatIfOperationResult

Результат операции What-If. Содержит список прогнозируемых изменений и URL-ссылку, чтобы перейти к следующему набору результатов.

Имя Тип Описание
error

ErrorResponse

Ошибка при сбое операции What-If.

properties.changes

WhatIfChange[]

Список изменений ресурсов, прогнозируемых операцией What-If.

properties.diagnostics

DeploymentDiagnosticsDefinition[]

Список диагностик ресурсов, обнаруженных What-If операцией.

properties.potentialChanges

WhatIfChange[]

Список изменений ресурсов, прогнозируемых операцией What-If.

status

string

Состояние операции What-If.

WhatIfPropertyChange

Прогнозируемое изменение свойства ресурса.

Имя Тип Описание
after

Значение свойства после выполнения развертывания.

before

Значение свойства перед выполнением развертывания.

children

WhatIfPropertyChange[]

Изменения вложенного свойства.

path

string

Путь к свойству.

propertyChangeType

PropertyChangeType

Тип изменения свойства.

WhatIfResultFormat

Формат результатов What-If

Значение Описание
ResourceIdOnly

ResourceIdOnly

FullResourcePayloads

FullResourcePayloads