Deployments - What If At Management Group Scope
Возвращает изменения, которые будут вноситься развертыванием, если они выполняются в области группы управления.
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
deployment
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[-\w\._\(\)]+$ |
Имя развертывания. |
group
|
path | True |
string minLength: 1maxLength: 90 |
Идентификатор группы управления. |
api-version
|
query | True |
string |
Версия API, используемая для этой операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
location | True |
string |
Расположение для хранения данных развертывания. |
properties | True |
Свойства развертывания. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК. Возвращает состояние операции What-If |
|
202 Accepted |
Принято. Возвращает URL-адрес в заголовке расположения, чтобы запросить состояние длительной операции. Заголовки
|
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
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.Management/managementGroups/myManagementGruop/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
}
}
Пример ответа
{
"status": "Succeeded",
"properties": {
"changes": [
{
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"changeType": "Modify",
"before": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
"enforcementMode": "Default"
}
},
"after": {
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"changeType": "Modify",
"before": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
"enforcementMode": "DoNotEnforce"
}
},
"delta": [
{
"path": "properties.enforcementMode",
"propertyChangeType": "Modify",
"before": "Default",
"after": "DoNotEnforce"
}
]
}
},
{
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
"changeType": "Create",
"after": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment2",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
"enforcementMode": "Default"
}
}
}
]
}
}
Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
Определения
Имя | Описание |
---|---|
Change |
Тип изменения, которое будет выполнено в ресурс при выполнении развертывания. |
Cloud |
Ответ об ошибке для запроса на управление ресурсами. |
Debug |
Параметр отладки. |
Deployment |
Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы. |
Deployment |
Развертывание свойств What-if. |
Deployment |
Параметры операции What-If развертывания. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Ответ на ошибку |
Expression |
Указывает, вычисляются ли выражения шаблонов в пределах области родительского шаблона или вложенного шаблона. |
Expression |
Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне. |
On |
Развертывание по поведению ошибок. |
On |
Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment. |
Parameters |
Сущность, представляющая ссылку на параметры развертывания. |
Property |
Тип изменения свойства. |
Scoped |
Развертывание параметров операции "Что если". |
Template |
Сущность, представляющая ссылку на шаблон. |
What |
Сведения об изменении одного ресурса, прогнозируемого операцией What-If. |
What |
Результат операции What-If. Содержит список прогнозируемых изменений и URL-ссылку, чтобы перейти к следующему набору результатов. |
What |
Прогнозируемое изменение свойства ресурса. |
What |
Формат результатов What-If |
ChangeType
Тип изменения, которое будет выполнено в ресурс при выполнении развертывания.
Значение | Описание |
---|---|
Create |
Ресурс не существует в текущем состоянии, но присутствует в требуемом состоянии. Ресурс будет создан при выполнении развертывания. |
Delete |
Ресурс существует в текущем состоянии и отсутствует из требуемого состояния. Ресурс будет удален при выполнении развертывания. |
Deploy |
Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса могут или не могут изменяться. |
Ignore |
Ресурс существует в текущем состоянии и отсутствует из требуемого состояния. Ресурс не будет развернут или изменен при выполнении развертывания. |
Modify |
Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса изменятся. |
NoChange |
Ресурс существует в текущем состоянии и требуемом состоянии и будет повторно развернут при выполнении развертывания. Свойства ресурса не изменятся. |
Unsupported |
Ресурс не поддерживается с помощью What-If. |
CloudError
Ответ об ошибке для запроса на управление ресурсами.
Имя | Тип | Описание |
---|---|---|
error |
Ответ на ошибку |
DebugSetting
Параметр отладки.
Имя | Тип | Описание |
---|---|---|
detailLevel |
string |
Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания. |
DeploymentMode
Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.
Значение | Описание |
---|---|
Complete | |
Incremental |
DeploymentWhatIfProperties
Развертывание свойств What-if.
Имя | Тип | Описание |
---|---|---|
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 развертывания.
Имя | Тип | Описание |
---|---|---|
resultFormat |
Формат результатов What-If |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ExpressionEvaluationOptions
Указывает, вычисляются ли выражения шаблонов в пределах области родительского шаблона или вложенного шаблона.
Имя | Тип | Описание |
---|---|---|
scope |
Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне. |
ExpressionEvaluationOptionsScopeType
Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне.
Значение | Описание |
---|---|
Inner | |
NotSpecified | |
Outer |
OnErrorDeployment
Развертывание по поведению ошибок.
Имя | Тип | Описание |
---|---|---|
deploymentName |
string |
Развертывание, используемое в случае ошибки. |
type |
Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment. |
OnErrorDeploymentType
Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.
Значение | Описание |
---|---|
LastSuccessful | |
SpecificDeployment |
ParametersLink
Сущность, представляющая ссылку на параметры развертывания.
Имя | Тип | Описание |
---|---|---|
contentVersion |
string |
Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. |
uri |
string |
URI файла параметров. |
PropertyChangeType
Тип изменения свойства.
Значение | Описание |
---|---|
Array |
Свойство является массивом и содержит вложенные изменения. |
Create |
Свойство не существует в текущем состоянии, но присутствует в требуемом состоянии. Свойство будет создано при выполнении развертывания. |
Delete |
Свойство существует в текущем состоянии и отсутствует из требуемого состояния. Она будет удалена при выполнении развертывания. |
Modify |
Свойство существует как в текущем, так и требуемом состоянии и отличается. Значение свойства изменится при выполнении развертывания. |
NoEffect |
Свойство не будет задано или обновлено. |
ScopedDeploymentWhatIf
Развертывание параметров операции "Что если".
Имя | Тип | Описание |
---|---|---|
location |
string |
Расположение для хранения данных развертывания. |
properties |
Свойства развертывания. |
TemplateLink
Сущность, представляющая ссылку на шаблон.
Имя | Тип | Описание |
---|---|---|
contentVersion |
string |
Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. |
id |
string |
Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба. |
queryString |
string |
Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink. |
relativePath |
string |
Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath. |
uri |
string |
Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба. |
WhatIfChange
Сведения об изменении одного ресурса, прогнозируемого операцией What-If.
Имя | Тип | Описание |
---|---|---|
after |
object |
Прогнозируемый моментальный снимок ресурса после выполнения развертывания. |
before |
object |
Моментальный снимок ресурса перед выполнением развертывания. |
changeType |
Тип изменения, которое будет выполнено в ресурс при выполнении развертывания. |
|
delta |
Прогнозируемые изменения свойств ресурса. |
|
resourceId |
string |
ИД ресурса |
unsupportedReason |
string |
Объяснение того, почему ресурс не поддерживается с помощью What-If. |
WhatIfOperationResult
Результат операции What-If. Содержит список прогнозируемых изменений и URL-ссылку, чтобы перейти к следующему набору результатов.
Имя | Тип | Описание |
---|---|---|
error |
Ответ на ошибку |
|
properties.changes |
Список изменений ресурсов, прогнозируемых операцией What-If. |
|
status |
string |
Состояние операции What-If. |
WhatIfPropertyChange
Прогнозируемое изменение свойства ресурса.
Имя | Тип | Описание |
---|---|---|
after |
object |
Значение свойства после выполнения развертывания. |
before |
object |
Значение свойства перед выполнением развертывания. |
children |
Изменения вложенного свойства. |
|
path |
string |
Путь к свойству. |
propertyChangeType |
Тип изменения свойства. |
WhatIfResultFormat
Формат результатов What-If
Значение | Описание |
---|---|
FullResourcePayloads | |
ResourceIdOnly |