Deployments - Create Or Update At Tenant Scope

Служба:: Resource Management

Версия API:: 2025-04-01

Развертывает ресурсы в области клиента.
Шаблон и параметры можно указать непосредственно в запросе или связать с JSON-файлами.

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?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	DeploymentProperties	Свойства развертывания.
tags		object	Теги развертывания

Ответы

Имя	Тип	Описание
200 OK	DeploymentExtended	Операция обновления ресурса 'DeploymentExtended' успешно прошла
201 Created	DeploymentExtended	Операция создания ресурса 'DeploymentExtended' успешно выполнена Заголовки Location: string Retry-After: integer
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

DeploymentExtended

Операция обновления ресурса 'DeploymentExtended' успешно прошла

201 Created

DeploymentExtended

Операция создания ресурса 'DeploymentExtended' успешно выполнена

Заголовки

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	олицетворения учетной записи пользователя

Примеры

Create deployment at tenant scope.

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

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2025-04-01

{
  "location": "eastus",
  "properties": {
    "mode": "Incremental",
    "parameters": {},
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    }
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}


import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.ScopedDeployment;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdateAtTenantScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentAtTenant.json
     */
    /**
     * Sample code: Create deployment at tenant scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createDeploymentAtTenantScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdateAtTenantScope(
            "tenant-dep01",
            new ScopedDeployment().withLocation("eastus")
                .withProperties(new DeploymentProperties()
                    .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                    .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL))
                .withTags(mapOf("tagKey1", "fakeTokenPlaceholder", "tagKey2", "fakeTokenPlaceholder")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_at_tenant.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.deployments.begin_create_or_update_at_tenant_scope(
        deployment_name="tenant-dep01",
        parameters={
            "location": "eastus",
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            },
            "tags": {"tagKey1": "tag-value-1", "tagKey2": "tag-value-2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtTenant.json
if __name__ == "__main__":
    main()

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

package armdeployments_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/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05809299e74fc16df7badbab3fb29e25da59f7d2/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtTenant.json
func ExampleDeploymentsClient_BeginCreateOrUpdateAtTenantScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtTenantScope(ctx, "tenant-dep01", armdeployments.ScopedDeployment{
		Location: to.Ptr("eastus"),
		Properties: &armdeployments.DeploymentProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	}, 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.DeploymentExtended = armdeployments.DeploymentExtended{
	// 	Name: to.Ptr("tenant-dep01"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/providers/Microsoft.Resources/deployments/tenant-dep01"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armdeployments.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armdeployments.Dependency{
	// 			{
	// 				DependsOn: []*armdeployments.BasicDependency{
	// 					{
	// 						ID: to.Ptr("/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
	// 						ResourceName: to.Ptr("policy-definition-name"),
	// 						ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
	// 				}},
	// 				ID: to.Ptr("/providers/Microsoft.Authorization/policyAssignments/location-lock"),
	// 				ResourceName: to.Ptr("location-lock"),
	// 				ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
	// 		}},
	// 		Duration: to.Ptr("PT1.2970875S"),
	// 		Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armdeployments.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Authorization"),
	// 				ResourceTypes: []*armdeployments.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							nil},
	// 							ResourceType: to.Ptr("policyDefinitions"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								nil},
	// 								ResourceType: to.Ptr("policyAssignments"),
	// 						}},
	// 					},
	// 					{
	// 						Namespace: to.Ptr("Microsoft.Resources"),
	// 						ResourceTypes: []*armdeployments.ProviderResourceType{
	// 							{
	// 								Locations: []*string{
	// 									to.Ptr("eastus")},
	// 									ResourceType: to.Ptr("deployments"),
	// 							}},
	// 					}},
	// 					ProvisioningState: to.Ptr(armdeployments.ProvisioningStateSucceeded),
	// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.789Z"); return t}()),
	// 				},
	// 				Tags: map[string]*string{
	// 					"tagKey1": to.Ptr("tag-value-1"),
	// 					"tagKey2": to.Ptr("tag-value-2"),
	// 				},
	// 			}
}

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

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtTenant.json
 */
async function createDeploymentAtTenantScope() {
  const deploymentName = "tenant-dep01";
  const parameters = {
    location: "eastus",
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
    tags: { tagKey1: "tag-value-1", tagKey2: "tag-value-2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential);
  const result = await client.deployments.beginCreateOrUpdateAtTenantScopeAndWait(
    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

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

Код состояния:: 200

{
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "location": "eastus",
  "properties": {
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceName": "policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceName": "location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments"
      }
    ],
    "duration": "PT1.2970875S",
    "mode": "Incremental",
    "parameters": {},
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "locations": [
              null
            ],
            "resourceType": "policyDefinitions"
          },
          {
            "locations": [
              null
            ],
            "resourceType": "policyAssignments"
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "locations": [
              "eastus"
            ],
            "resourceType": "deployments"
          }
        ]
      }
    ],
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Код состояния:: 201

{
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "location": "eastus",
  "properties": {
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceName": "policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceName": "location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments"
      }
    ],
    "duration": "PT1.2970875S",
    "mode": "Incremental",
    "parameters": {},
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "locations": [
              null
            ],
            "resourceType": "policyDefinitions"
          },
          {
            "locations": [
              null
            ],
            "resourceType": "policyAssignments"
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "locations": [
              "eastus"
            ],
            "resourceType": "deployments"
          }
        ]
      }
    ],
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Определения

Имя	Описание
Alias	Тип псевдонима.
AliasPath	Тип путей для псевдонима.
AliasPathAttributes	Атрибуты маркера, к которому ссылается путь псевдонима.
AliasPathMetadata
AliasPathTokenType	Тип маркера, на который ссылается путь псевдонима.
AliasPattern	Тип шаблона для пути псевдонима.
AliasPatternType	Тип шаблона псевдонима
AliasType	Тип псевдонима.
ApiProfile
BasicDependency	Сведения о зависимости развертывания.
CloudError	Ответ об ошибке для запроса на управление ресурсами.
createdByType	Тип удостоверения, создавшего ресурс.
DebugSetting	Параметр отладки.
Dependency	Сведения о зависимости развертывания.
DeploymentDiagnosticsDefinition
DeploymentExtended	Сведения о развертывании.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Внешние входные данные развертывания для параметризации.
DeploymentExternalInputDefinition	Определение внешних входных данных развертывания для параметризации.
DeploymentMode	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.
DeploymentParameter	Параметр развертывания для шаблона.
DeploymentProperties	Свойства развертывания.
DeploymentPropertiesExtended	Свойства развертывания с дополнительными сведениями.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа на ошибку OData.)
ExpressionEvaluationOptions	Указывает, оцениваются ли выражения шаблона в области родительского шаблона или вложенного шаблона.
ExpressionEvaluationOptionsScopeType	Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.
ExtensionConfigPropertyType
KeyVaultParameterReference	Azure Key Vault parameter reference.
KeyVaultReference	Azure Key Vault reference.
Level	Обозначает дополнительный уровень ответа.
OnErrorDeployment	Развертывание по поведению ошибок.
OnErrorDeploymentExtended	Развертывание по поведению ошибок с дополнительными сведениями.
OnErrorDeploymentType	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.
ParametersLink	Сущность, представляющая ссылку на параметры развертывания.
Provider	Сведения о поставщике ресурсов.
ProviderAuthorizationConsentState	Состояние согласия на авторизацию поставщика.
ProviderExtendedLocation	Расширенное расположение поставщика.
ProviderResourceType	Тип ресурса, управляемый поставщиком ресурсов.
ProvisioningState	Обозначает состояние подготовки.
ResourceReference	Модель идентификатора ресурса.
ScopedDeployment	Параметры операции развертывания.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TemplateLink	Сущность, представляющая ссылку на шаблон.
ValidationLevel	Уровень проверки, выполняемой при развертывании.
ZoneMapping

Alias

Объект

Тип псевдонима.

Имя	Тип	Описание
defaultMetadata	AliasPathMetadata	Метаданные пути псевдонима по умолчанию. Применяется к пути по умолчанию и к любому пути псевдонима, у которых нет метаданных
defaultPath	string	Путь по умолчанию для псевдонима.
defaultPattern	AliasPattern	Шаблон по умолчанию для псевдонима.
name	string	Имя псевдонима.
paths	AliasPath[]	Пути для псевдонима.
type	AliasType	Тип псевдонима.

AliasPath

Объект

Тип путей для псевдонима.

Имя	Тип	Описание
apiVersions	string[]	Версии API.
metadata	AliasPathMetadata	Метаданные пути псевдонима. Если отсутствует, вернитесь к метаданным по умолчанию псевдонима.
path	string	Путь псевдонима.
pattern	AliasPattern	Шаблон для пути псевдонима.

AliasPathAttributes

Перечисление

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

Значение	Описание
None	Маркер, на который ссылается путь псевдонима, не имеет атрибутов.
Modifiable	Маркер, на который ссылается путь псевдонима, можно изменить с помощью политик с эффектом "изменить".

AliasPathMetadata

Объект

Имя	Тип	Описание
attributes	AliasPathAttributes	Атрибуты маркера, к которому ссылается путь псевдонима.
type	AliasPathTokenType	Тип маркера, на который ссылается путь псевдонима.

AliasPathTokenType

Перечисление

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

Значение	Описание
NotSpecified	Тип токена не указан.
Any	Тип токена может быть любым.
String	Тип токена — строка.
Object	Тип токена — объект.
Array	Тип токена — массив.
Integer	Тип токена является целым числом.
Number	Тип токена — число.
Boolean	Тип токена является логическим.

AliasPattern

Объект

Тип шаблона для пути псевдонима.

Имя	Тип	Описание
phrase	string	Фраза шаблона псевдонима.
type	AliasPatternType	Тип шаблона псевдонима
variable	string	Переменная шаблона псевдонима.

AliasPatternType

Перечисление

Тип шаблона псевдонима

Значение	Описание
NotSpecified	NotSpecified не допускается.
Extract	Извлечение является единственным допустимым значением.

AliasType

Перечисление

Тип псевдонима.

Значение	Описание
NotSpecified	Тип псевдонима неизвестен (так же, как и не предоставляющий тип псевдонима).
PlainText	Значение псевдонима не является секретом.
Mask	Значение псевдонима — секрет.

ApiProfile

Объект

Имя	Тип	Описание
apiVersion	string	Версия API.
profileVersion	string	Версия профиля.

BasicDependency

Объект

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

Имя	Тип	Описание
id	string	Идентификатор зависимости.
resourceName	string	Имя ресурса зависимостей.
resourceType	string	Тип ресурса зависимостей.

CloudError

Объект

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

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

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DebugSetting

Объект

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

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

Dependency

Объект

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

Имя	Тип	Описание
dependsOn	BasicDependency[]	Список зависимостей.
id	string	Идентификатор зависимости.
resourceName	string	Имя ресурса зависимостей.
resourceType	string	Тип ресурса зависимостей.

DeploymentDiagnosticsDefinition

Объект

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
level	Level	Обозначает дополнительный уровень ответа.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

DeploymentExtended

Объект

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	расположение развертывания.
name	string	Имя ресурса
properties	DeploymentPropertiesExtended	Свойства развертывания.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
tags	object	Теги развертывания
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

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		Входное значение параметра .

DeploymentProperties

Объект

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

Имя	Тип	Описание
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	Уровень проверки развертывания

DeploymentPropertiesExtended

Объект

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

Имя	Тип	Описание
correlationId	string	Идентификатор корреляции развертывания.
debugSetting	DebugSetting	Параметр отладки развертывания.
dependencies	Dependency[]	Список зависимостей развертывания.
diagnostics	DeploymentDiagnosticsDefinition[]	Содержит диагностическую информацию, собранную в процессе проверки.
duration	string	Длительность развертывания шаблона.
error	ErrorResponse	Ошибка развертывания.
extensions	DeploymentExtensionDefinition[]	Расширения, используемые в этом развертывании.
mode	DeploymentMode	Режим развертывания. Возможные значения— добавочные и полные.
onErrorDeployment	OnErrorDeploymentExtended	Развертывание по поведению ошибок.
outputResources	ResourceReference[]	Массив подготовленных ресурсов.
outputs		Пары "ключ-значение", представляющие выходные данные развертывания.
parameters		Параметры развертывания.
parametersLink	ParametersLink	Универсальный код ресурса (URI), ссылающийся на параметры.
providers	Provider[]	Список поставщиков ресурсов, необходимых для развертывания.
provisioningState	ProvisioningState	Обозначает состояние подготовки.
templateHash	string	Хэш, созданный для шаблона.
templateLink	TemplateLink	Универсальный код ресурса (URI), ссылающийся на шаблон.
timestamp	string (date-time)	Метка времени развертывания шаблона.
validatedResources	ResourceReference[]	Массив проверенных ресурсов.
validationLevel	ValidationLevel	Уровень проверки развертывания

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.

OnErrorDeploymentExtended

Объект

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

Имя	Тип	Описание
deploymentName	string	Развертывание, используемое в случае ошибки.
provisioningState	string	Состояние подготовки для развертывания ошибок.
type	OnErrorDeploymentType	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

OnErrorDeploymentType

Перечисление

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

Значение	Описание
LastSuccessful	ПоследнийУспешный
SpecificDeployment	Конкретное развертывание

ParametersLink

Объект

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

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

Provider

Объект

Сведения о поставщике ресурсов.

Имя	Тип	Описание
id	string	Идентификатор поставщика.
namespace	string	Пространство имен поставщика ресурсов.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Состояние согласия на авторизацию поставщика.
registrationPolicy	string	Политика регистрации поставщика ресурсов.
registrationState	string	Состояние регистрации поставщика ресурсов.
resourceTypes	ProviderResourceType[]	Коллекция типов ресурсов поставщика.

ProviderAuthorizationConsentState

Перечисление

Состояние согласия на авторизацию поставщика.

Значение	Описание
NotSpecified	Не указано
Required	Обязательный
NotRequired	NotRequired
Consented	Согласие

ProviderExtendedLocation

Объект

Расширенное расположение поставщика.

Имя	Тип	Описание
extendedLocations	string[]	Расширенные расположения для расположения Azure.
location	string	Расположение Azure.
type	string	Тип расширенного расположения.

ProviderResourceType

Объект

Тип ресурса, управляемый поставщиком ресурсов.

Имя	Тип	Описание
aliases	Alias[]	Псевдонимы, поддерживаемые этим типом ресурса.
apiProfiles	ApiProfile[]	Профили API для поставщика ресурсов.
apiVersions	string[]	Версия API.
capabilities	string	Дополнительные возможности, предоставляемые этим типом ресурсов.
defaultApiVersion	string	Версия API по умолчанию.
locationMappings	ProviderExtendedLocation[]	Сопоставления расположений, поддерживаемые этим типом ресурса.
locations	string[]	Коллекция расположений, в которых можно создать этот тип ресурса.
properties	object	Свойства.
resourceType	string	Тип ресурса.
zoneMappings	ZoneMapping[]

ProvisioningState

Перечисление

Обозначает состояние подготовки.

Значение	Описание
NotSpecified	Не указано
Accepted	Акцептировано
Running	Бег
Ready	Ready
Creating	Создавать
Created	Создано
Deleting	Удаление
Deleted	Удалено
Canceled	Отменено
Failed	Неудача
Succeeded	Succeeded
Updating	Обновление

ResourceReference

Объект

Модель идентификатора ресурса.

Имя	Тип	Описание
apiVersion	string	Версия API, с которой был развернут ресурс.
extension	DeploymentExtensionDefinition	Расширение, с которым был развернут ресурс.
id	string	Полностью квалифицированный идентификатор ресурса Azure.
identifiers		Расширяемые идентификаторы ресурсов.
resourceType	string	Тип ресурса.

ScopedDeployment

Объект

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

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

systemData

Объект

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

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TemplateLink

Объект

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

Имя	Тип	Описание
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 для каждого ресурса.

ZoneMapping

Объект

Имя	Тип	Описание
location	string	Расположение сопоставления зоны.
zones	string[]