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


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

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

string

Имя развертывания.

Шаблон регулярного выражения: ^[-\w\._\(\)]+$

groupId
path True

string

Идентификатор группы управления.

api-version
query True

string

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

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

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

string

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

properties True

DeploymentWhatIfProperties

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

Ответы

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

WhatIfOperationResult

ОК. Возвращает состояние операции What-If

202 Accepted

Принято — возвращает URL-адрес в заголовке Location для запроса состояния длительной операции.

Заголовки

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

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

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

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

Определения

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

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

CloudError

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

DebugSetting

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

DeploymentMode

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

DeploymentWhatIfProperties

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

DeploymentWhatIfSettings

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

ErrorAdditionalInfo

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

ErrorResponse

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

ExpressionEvaluationOptions

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

ExpressionEvaluationOptionsScopeType

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

OnErrorDeployment

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

OnErrorDeploymentType

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

ParametersLink

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

PropertyChangeType

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

ScopedDeploymentWhatIf

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

TemplateLink

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

WhatIfChange

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

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

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

DebugSetting

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

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

string

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

DeploymentMode

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

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

string

Incremental

string

DeploymentWhatIfProperties

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

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

DebugSetting

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

expressionEvaluationOptions

ExpressionEvaluationOptions

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

mode

DeploymentMode

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

onErrorDeployment

OnErrorDeployment

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

parameters

object

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

parametersLink

ParametersLink

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

template

object

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

templateLink

TemplateLink

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

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

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

ScopedDeploymentWhatIf

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

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

string

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

properties

DeploymentWhatIfProperties

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

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

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

string

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

id

string

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

queryString

string

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

relativePath

string

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

uri

string

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

WhatIfChange

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

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

object

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

before

object

Snapshot ресурса перед выполнением развертывания.

changeType

ChangeType

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

delta

WhatIfPropertyChange[]

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

resourceId

string

Идентификатор ресурса

unsupportedReason

string

Объяснение того, почему ресурс не поддерживается приложением "Что если".

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