Deployments - Validate

Ссылка

Служба:: Resource Management

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

Проверяет, является ли указанный шаблон синтаксически правильным и будет ли он принят Azure Resource Manager.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate?api-version=2021-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
deploymentName	path	True	string	Имя развертывания. Шаблон регулярного выражения: `^[-\w\._]+$`
resourceGroupName	path	True	string	Имя группы ресурсов, в который будет развернут шаблон. Регистр букв в имени не учитывается. Шаблон регулярного выражения: `^[-\w\._]+$`
subscriptionId	path	True	string	Идентификатор подписки Microsoft Azure.
api-version	query	True	string	Версия API, используемая для данной операции.

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

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

Ответы

Имя	Тип	Описание
200 OK	DeploymentValidateResult	ОК . Возвращает результат проверки.
202 Accepted		Принято — запрос принят для обработки, и операция будет выполнена асинхронно.
400 Bad Request	DeploymentValidateResult	Возвращает результат проверки.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Определения

Имя	Описание
Alias	Тип псевдонима.
AliasPath	Тип путей для псевдонима.
AliasPathAttributes	Атрибуты маркера, на который ссылается путь псевдонима.
AliasPathMetadata
AliasPathTokenType	Тип маркера, на который ссылается путь псевдонима.
AliasPattern	Тип шаблона для пути псевдонима.
AliasPatternType	Тип шаблона псевдонима
AliasType	Тип псевдонима.
ApiProfile
BasicDependency	Информация о зависимостях развертывания.
CloudError	Ответ об ошибке для запроса на управление ресурсами.
DebugSetting	Параметр отладки.
Dependency	Информация о зависимостях развертывания.
Deployment	Параметры операции развертывания.
DeploymentMode	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В инкрементном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В режиме Завершения ресурсы развертываются, а существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании полного режима, так как вы можете случайно удалить ресурсы.
DeploymentProperties	Свойства развертывания.
DeploymentPropertiesExtended	Свойства развертывания с дополнительными сведениями.
DeploymentValidateResult	Информация из ответа подтверждения развертывания шаблона.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Сообщение об ошибке
ExpressionEvaluationOptions	Указывает, вычисляются ли выражения шаблона в область родительского или вложенного шаблона.
ExpressionEvaluationOptionsScopeType	Область, который будет использоваться для оценки параметров, переменных и функций во вложенном шаблоне.
OnErrorDeployment	Развертывание при возникновении ошибки.
OnErrorDeploymentExtended	Развертывание по поведению ошибок с дополнительными сведениями.
OnErrorDeploymentType	Тип поведения развертывания при ошибке. Возможные значения: LastSuccessful и SpecificDeployment.
ParametersLink	Сущность, представляющая ссылку на параметры развертывания.
Provider	Информация о поставщике ресурсов.
ProviderAuthorizationConsentState	Состояние согласия авторизации поставщика.
ProviderExtendedLocation	Расширенное расположение поставщика.
ProviderResourceType	Тип ресурса, управляемый поставщиком ресурсов.
ProvisioningState	Обозначает состояние подготовки.
ResourceReference	Модель идентификатора ресурса.
TemplateLink	Сущность, представляющая ссылку на шаблон.
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

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

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

AliasPathMetadata

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

AliasPathTokenType

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

Имя	Тип	Описание
Any	string	Тип токена может быть любым.
Array	string	Тип токена — array.
Boolean	string	Тип токена — логический.
Integer	string	Тип токена — integer.
NotSpecified	string	Тип маркера не указан.
Number	string	Тип токена — число.
Object	string	Тип токена — object.
String	string	Тип токена — string.

AliasPattern

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

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

AliasPatternType

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

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

AliasType

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

Имя	Тип	Описание
Mask	string	Значение псевдонима — secret.
NotSpecified	string	Тип псевдонима неизвестен (то же самое, что тип псевдонима не указан).
PlainText	string	Значение псевдонима не является секретным.

ApiProfile

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

BasicDependency

Информация о зависимостях развертывания.

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

CloudError

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

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

DebugSetting

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

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

Dependency

Информация о зависимостях развертывания.

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

Deployment

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

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

DeploymentMode

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

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

DeploymentProperties

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

Имя	Тип	Описание
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 или свойство шаблона, но не оба.

DeploymentPropertiesExtended

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

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

DeploymentValidateResult

Информация из ответа подтверждения развертывания шаблона.

Имя	Тип	Описание
error	ErrorResponse	Сообщение об ошибке Ошибка проверки развертывания.
properties	DeploymentPropertiesExtended	Свойства развертывания шаблона.

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.

OnErrorDeploymentExtended

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

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

OnErrorDeploymentType

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

Имя	Тип	Описание
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

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

Provider

Информация о поставщике ресурсов.

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

ProviderAuthorizationConsentState

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

Имя	Тип	Описание
Consented	string
NotRequired	string
NotSpecified	string
Required	string

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

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

Имя	Тип	Описание
Accepted	string
Canceled	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Ready	string
Running	string
Succeeded	string
Updating	string

ResourceReference

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса.

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, но не оба.

ZoneMapping

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

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