Deployments - What If At Tenant Scope

Ссылка

Service:: Resource Management

API Version:: 2021-04-01

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

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

Параметры URI

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

Имя	В	Обязательно	Тип	Описание
deploymentName	path	True	string	Имя развертывания. Regex pattern: `^[-\w\._\(\)]+$`
api-version	query	True	string	Версия API, используемая для данной операции.

deploymentName

path

True

string

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

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

api-version

query

True

string

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

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

Имя	Обязательно	Тип	Описание
location	True	string	Расположение для хранения данных развертывания.
properties	True	DeploymentWhatIfProperties	Свойства развертывания.

Ответы

Имя	Тип	Описание
200 OK	WhatIfOperationResult	ОК. Возвращает состояние операции What-If
202 Accepted		Принято — возвращает URL-адрес в заголовке Location для запроса состояния длительной операции. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

WhatIfOperationResult

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

202 Accepted

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

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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"
  }
}

package armresources_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json
func ExampleDeploymentsClient_BeginWhatIfAtTenantScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtTenantScope(ctx, "exampleDeploymentName", armresources.ScopedDeploymentWhatIf{
		Location: to.Ptr("eastus"),
		Properties: &armresources.DeploymentWhatIfProperties{
			Mode:         to.Ptr(armresources.DeploymentModeIncremental),
			Parameters:   map[string]any{},
			TemplateLink: &armresources.TemplateLink{},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WhatIfOperationResult = armresources.WhatIfOperationResult{
	// 	Properties: &armresources.WhatIfOperationProperties{
	// 		Changes: []*armresources.WhatIfChange{
	// 			{
	// 				After: map[string]any{
	// 					"name": "myManagementGroup",
	// 					"type": "Microsoft.Management/managementGroups",
	// 					"apiVersion": "2019-11-01",
	// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
	// 				},
	// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup"),
	// 		}},
	// 	},
	// 	Status: to.Ptr("Succeeded"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns changes that will be made by the deployment if executed at the scope of the tenant group.
 *
 * @summary Returns changes that will be made by the deployment if executed at the scope of the tenant group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json
 */
async function predictTemplateChangesAtManagementGroupScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const deploymentName = "exampleDeploymentName";
  const parameters = {
    location: "eastus",
    properties: { mode: "Incremental", parameters: {}, templateLink: {} },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginWhatIfAtTenantScopeAndWait(
    deploymentName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json
// this example is just showing the usage of "Deployments_WhatIfAtTenantScope" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmDeploymentResource created on azure
// for more information of creating ArmDeploymentResource, please refer to the document of ArmDeploymentResource
string scope = $"/";
string deploymentName = "exampleDeploymentName";
ResourceIdentifier armDeploymentResourceId = ArmDeploymentResource.CreateResourceIdentifier(scope, deploymentName);
ArmDeploymentResource armDeployment = client.GetArmDeploymentResource(armDeploymentResourceId);

// invoke the operation
ArmDeploymentWhatIfContent content = new ArmDeploymentWhatIfContent(new ArmDeploymentWhatIfProperties(ArmDeploymentMode.Incremental)
{
    TemplateLink = null,
    Parameters = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    }),
})
{
    Location = new AzureLocation("eastus"),
};
ArmOperation<WhatIfOperationResult> lro = await armDeployment.WhatIfAsync(WaitUntil.Completed, content);
WhatIfOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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"
        }
      }
    ]
  }
}

Status code:: 202

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

ParametersLink

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

Имя	Тип	Описание
contentVersion	string	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.
uri	string	Универсальный код ресурса (URI) файла параметров.

PropertyChangeType

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

Имя	Тип	Описание
Array	string	Свойство является массивом и содержит вложенные изменения.
Create	string	Свойство не существует в текущем состоянии, но присутствует в нужном состоянии. Свойство будет создано при выполнении развертывания.
Delete	string	Свойство существует в текущем состоянии и отсутствует в требуемом состоянии. Он будет удален при выполнении развертывания.
Modify	string	Свойство существует как в текущем, так и в требуемом состоянии и отличается. Значение свойства изменится при выполнении развертывания.
NoEffect	string	Свойство не будет задано или обновлено.

ScopedDeploymentWhatIf

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

Имя	Тип	Описание
location	string	Расположение для хранения данных развертывания.
properties	DeploymentWhatIfProperties	Свойства развертывания.

TemplateLink

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

Имя	Тип	Описание
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

Deployments - What If At Tenant Scope

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

Predict template changes at management group scope

Sample Request

Sample Response

Определения

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Дополнительные ресурсы