Deployments - Validate

Service:

Resource Management

API-versie:

2021-04-01

Valideert of de opgegeven sjabloon syntactisch juist is en wordt geaccepteerd door Azure Resource Manager..

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

URI-parameters

Name	In	Vereist	Type	Description
deploymentName	path	True	string	De naam van de implementatie. Regex-patroon: ^[-\w\._\(\)]+$
resourceGroupName	path	True	string	De naam van de resourcegroep waar de sjabloon naar wordt geïmplementeerd. De naam is niet hoofdlettergevoelig. Regex-patroon: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	De Microsoft Azure-abonnements-id.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
properties	True	DeploymentProperties	De implementatie-eigenschappen.
location		string	De locatie voor het opslaan van de implementatiegegevens.
tags		object	Implementatietags

Antwoorden

Name	Type	Description
200 OK	DeploymentValidateResult	OK: retourneert het validatieresultaat.
202 Accepted		Geaccepteerd: de aanvraag is geaccepteerd voor verwerking en de bewerking wordt asynchroon voltooid.
400 Bad Request	DeploymentValidateResult	Retourneert het validatieresultaat.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Definities

Name	Description
Alias	Het aliastype.
AliasPath	Het type van de paden voor alias.
AliasPathAttributes	De kenmerken van het token waarnaar het aliaspad verwijst.
AliasPathMetadata
AliasPathTokenType	Het type van het token waarnaar het aliaspad verwijst.
AliasPattern	Het type patroon voor een aliaspad.
AliasPatternType	Het type aliaspatroon
AliasType	Het type alias.
ApiProfile
BasicDependency	Informatie over implementatieafhankelijkheid.
CloudError	Een foutreactie voor een resourcebeheeraanvraag.
DebugSetting	De instelling voor foutopsporing.
Dependency	Informatie over implementatieafhankelijkheid.
Deployment	Parameters voor implementatiebewerking.
DeploymentMode	De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of Volledig zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig bij het gebruik van de volledige modus, omdat u onbedoeld resources kunt verwijderen.
DeploymentProperties	Implementatie-eigenschappen.
DeploymentPropertiesExtended	Implementatie-eigenschappen met aanvullende details.
DeploymentValidateResult	Informatie uit het antwoord voor het valideren van sjabloonimplementatie.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
ExpressionEvaluationOptions	Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.
ExpressionEvaluationOptionsScopeType	Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.
OnErrorDeployment	Implementatie op foutgedrag.
OnErrorDeploymentExtended	Implementatie bij foutgedrag met aanvullende details.
OnErrorDeploymentType	Het type implementatie op foutgedrag. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.
ParametersLink	Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.
Provider	Resourceprovidergegevens.
ProviderAuthorizationConsentState	De autorisatietoestemmingsstatus van de provider.
ProviderExtendedLocation	De uitgebreide locatie van de provider.
ProviderResourceType	Resourcetype dat wordt beheerd door de resourceprovider.
ProvisioningState	Hiermee wordt de status van de inrichting aangegeven.
ResourceReference	Het resource-id-model.
TemplateLink	Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.
ZoneMapping

Alias

Het aliastype.

Name	Type	Description
defaultMetadata	AliasPathMetadata	De metagegevens van het standaardaliaspad. Is van toepassing op het standaardpad en op elk aliaspad dat geen metagegevens bevat
defaultPath	string	Het standaardpad voor een alias.
defaultPattern	AliasPattern	Het standaardpatroon voor een alias.
name	string	De aliasnaam.
paths	AliasPath[]	De paden voor een alias.
type	AliasType	Het type alias.

AliasPath

Het type van de paden voor alias.

Name	Type	Description
apiVersions	string[]	De API-versies.
metadata	AliasPathMetadata	De metagegevens van het aliaspad. Als u ontbreekt, kunt u terugvallen op de standaardmetagegevens van de alias.
path	string	Het pad van een alias.
pattern	AliasPattern	Het patroon voor een aliaspad.

AliasPathAttributes

De kenmerken van het token waarnaar het aliaspad verwijst.

Name	Type	Description
Modifiable	string	Het token waarnaar het aliaspad verwijst, kan worden gewijzigd door beleidsregels met een 'wijzigen'-effect.
None	string	Het token waarnaar het aliaspad verwijst, heeft geen kenmerken.

AliasPathMetadata

Name	Type	Description
attributes	AliasPathAttributes	De kenmerken van het token waarnaar het aliaspad verwijst.
type	AliasPathTokenType	Het type van het token waarnaar het aliaspad verwijst.

AliasPathTokenType

Het type van het token waarnaar het aliaspad verwijst.

Name	Type	Description
Any	string	Het tokentype kan van alles zijn.
Array	string	Het tokentype is matrix.
Boolean	string	Het tokentype is booleaanse waarde.
Integer	string	Het tokentype is geheel getal.
NotSpecified	string	Het tokentype is niet opgegeven.
Number	string	Het tokentype is getal.
Object	string	Het tokentype is object.
String	string	Het tokentype is tekenreeks.

AliasPattern

Het type patroon voor een aliaspad.

Name	Type	Description
phrase	string	De aliaspatroonzin.
type	AliasPatternType	Het type aliaspatroon
variable	string	De aliaspatroonvariabele.

AliasPatternType

Het type aliaspatroon

Name	Type	Description
Extract	string	Extraheren is de enige toegestane waarde.
NotSpecified	string	NotSpecified is niet toegestaan.

AliasType

Het type alias.

Name	Type	Description
Mask	string	Aliaswaarde is geheim.
NotSpecified	string	Aliastype is onbekend (hetzelfde als het niet opgeven van aliastype).
PlainText	string	Aliaswaarde is niet geheim.

ApiProfile

Name	Type	Description
apiVersion	string	De API-versie.
profileVersion	string	De profielversie.

BasicDependency

Informatie over implementatieafhankelijkheid.

Name	Type	Description
id	string	De id van de afhankelijkheid.
resourceName	string	De naam van de afhankelijkheidsresource.
resourceType	string	Het resourcetype van de afhankelijkheid.

CloudError

Een foutreactie voor een resourcebeheeraanvraag.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de OData-foutreactieindeling.)

DebugSetting

De instelling voor foutopsporing.

Name	Type	Description
detailLevel	string	Hiermee geeft u het type informatie dat moet worden vastgelegd voor foutopsporing. De toegestane waarden zijn none, requestContent, responseContent of zowel requestContent als responseContent, gescheiden door een komma. De standaardwaarde is geen. Houd bij het instellen van deze waarde zorgvuldig rekening met het type informatie dat u tijdens de implementatie doorgeeft. Door informatie over de aanvraag of het antwoord te registreren, kunt u mogelijk gevoelige gegevens beschikbaar maken die worden opgehaald via de implementatiebewerkingen.

Dependency

Informatie over implementatieafhankelijkheid.

Name	Type	Description
dependsOn	BasicDependency[]	De lijst met afhankelijkheden.
id	string	De id van de afhankelijkheid.
resourceName	string	De naam van de afhankelijkheidsresource.
resourceType	string	Het resourcetype van de afhankelijkheid.

Deployment

Parameters voor implementatiebewerking.

Name	Type	Description
location	string	De locatie voor het opslaan van de implementatiegegevens.
properties	DeploymentProperties	De implementatie-eigenschappen.
tags	object	Implementatietags

DeploymentMode

De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of Volledig zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig bij het gebruik van de volledige modus, omdat u onbedoeld resources kunt verwijderen.

Name	Type	Description
Complete	string
Incremental	string

DeploymentProperties

Implementatie-eigenschappen.

Name	Type	Description
debugSetting	DebugSetting	De instelling voor foutopsporing van de implementatie.
expressionEvaluationOptions	ExpressionEvaluationOptions	Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. Alleen van toepassing op geneste sjablonen. Als u dit niet opgeeft, is de standaardwaarde buitenste waarde.
mode	DeploymentMode	De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of Volledig zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig bij het gebruik van de volledige modus, omdat u onbedoeld resources kunt verwijderen.
onErrorDeployment	OnErrorDeployment	Het foutgedrag van de implementatie.
parameters	object	Naam- en waardeparen waarmee de implementatieparameters voor de sjabloon worden gedefinieerd. U gebruikt dit element als u de parameterwaarden rechtstreeks in de aanvraag wilt opgeven in plaats van een koppeling naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de eigenschap parameters, maar niet beide. Dit kan een JObject of een goed gevormde JSON-tekenreeks zijn.
parametersLink	ParametersLink	De URI van het parameterbestand. U gebruikt dit element om een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de eigenschap parameters, maar niet beide.
template	object	De sjablooninhoud. U gebruikt dit element als u de syntaxis van de sjabloon rechtstreeks in de aanvraag wilt doorgeven in plaats van een koppeling naar een bestaande sjabloon. Dit kan een JObject of een goed gevormde JSON-tekenreeks zijn. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.
templateLink	TemplateLink	De URI van de sjabloon. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.

DeploymentPropertiesExtended

Implementatie-eigenschappen met aanvullende details.

Name	Type	Description
correlationId	string	De correlatie-id van de implementatie.
debugSetting	DebugSetting	De instelling voor foutopsporing van de implementatie.
dependencies	Dependency[]	De lijst met implementatieafhankelijkheden.
duration	string	De duur van de sjabloonimplementatie.
error	ErrorResponse	Foutreactie De implementatiefout.
mode	DeploymentMode	De implementatiemodus. Mogelijke waarden zijn Incrementeel en Volledig.
onErrorDeployment	OnErrorDeploymentExtended	Het foutgedrag van de implementatie.
outputResources	ResourceReference[]	Matrix van ingerichte resources.
outputs	object	Sleutel-waardeparen die de implementatie-uitvoer vertegenwoordigen.
parameters	object	Implementatieparameters.
parametersLink	ParametersLink	De URI die verwijst naar de parameters.
providers	Provider[]	De lijst met resourceproviders die nodig zijn voor de implementatie.
provisioningState	ProvisioningState	Hiermee wordt de status van de inrichting aangegeven.
templateHash	string	De hash die voor de sjabloon is geproduceerd.
templateLink	TemplateLink	De URI die verwijst naar de sjabloon.
timestamp	string	De tijdstempel van de sjabloonimplementatie.
validatedResources	ResourceReference[]	Matrix van gevalideerde resources.

DeploymentValidateResult

Informatie uit het antwoord voor het valideren van sjabloonimplementatie.

Name	Type	Description
error	ErrorResponse	Foutreactie De implementatievalidatiefout.
properties	DeploymentPropertiesExtended	De sjabloonimplementatie-eigenschappen.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ExpressionEvaluationOptions

Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.

Name	Type	Description
scope	ExpressionEvaluationOptionsScopeType	Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.

ExpressionEvaluationOptionsScopeType

Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.

Name	Type	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementatie op foutgedrag.

Name	Type	Description
deploymentName	string	De implementatie die moet worden gebruikt voor foutcases.
type	OnErrorDeploymentType	Het type implementatie op foutgedrag. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

OnErrorDeploymentExtended

Implementatie bij foutgedrag met aanvullende details.

Name	Type	Description
deploymentName	string	De implementatie die moet worden gebruikt voor foutcases.
provisioningState	string	De status van de inrichting voor de foutimplementatie.
type	OnErrorDeploymentType	De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

OnErrorDeploymentType

Het type implementatie op foutgedrag. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

Name	Type	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.

Name	Type	Description
contentVersion	string	Indien opgenomen, moet overeenkomen met de ContentVersion in de sjabloon.
uri	string	De URI van het parameterbestand.

Provider

Resourceprovidergegevens.

Name	Type	Description
id	string	De provider-id.
namespace	string	De naamruimte van de resourceprovider.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	De autorisatietoestemmingsstatus van de provider.
registrationPolicy	string	Het registratiebeleid van de resourceprovider.
registrationState	string	De registratiestatus van de resourceprovider.
resourceTypes	ProviderResourceType[]	De verzameling van providerresourcetypen.

ProviderAuthorizationConsentState

De autorisatietoestemmingsstatus van de provider.

Name	Type	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

De uitgebreide locatie van de provider.

Name	Type	Description
extendedLocations	string[]	De uitgebreide locaties voor de Azure-locatie.
location	string	De Azure-locatie.
type	string	Het uitgebreide locatietype.

ProviderResourceType

Resourcetype dat wordt beheerd door de resourceprovider.

Name	Type	Description
aliases	Alias[]	De aliassen die worden ondersteund door dit resourcetype.
apiProfiles	ApiProfile[]	De API-profielen voor de resourceprovider.
apiVersions	string[]	De API-versie.
capabilities	string	De extra mogelijkheden die door dit resourcetype worden geboden.
defaultApiVersion	string	De standaard-API-versie.
locationMappings	ProviderExtendedLocation[]	De locatietoewijzingen die worden ondersteund door dit resourcetype.
locations	string[]	De verzameling locaties waar dit resourcetype kan worden gemaakt.
properties	object	De eigenschappen.
resourceType	string	Het resourcetype.
zoneMappings	ZoneMapping[]

ProvisioningState

Hiermee wordt de status van de inrichting aangegeven.

Name	Type	Description
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

Het resource-id-model.

Name	Type	Description
id	string	De volledig gekwalificeerde resource-id.

TemplateLink

Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.

Name	Type	Description
contentVersion	string	Indien opgenomen, moet overeenkomen met de ContentVersion in de sjabloon.
id	string	De resource-id van een sjabloonspecificatie. Gebruik de eigenschap id of URI, maar niet beide.
queryString	string	De querytekenreeks (bijvoorbeeld een SAS-token) die moet worden gebruikt met de templateLink-URI.
relativePath	string	De eigenschap relativePath kan worden gebruikt om een gekoppelde sjabloon te implementeren op een locatie ten opzichte van het bovenliggende item. Als de bovenliggende sjabloon is gekoppeld aan een TemplateSpec, verwijst dit naar een artefact in de TemplateSpec. Als het bovenliggende item is gekoppeld aan een URI, is de onderliggende implementatie een combinatie van de bovenliggende en relatievePath-URI's
uri	string	De URI van de sjabloon die moet worden geïmplementeerd. Gebruik de eigenschap URI of id, maar niet beide.

ZoneMapping

Name	Type	Description
location	string	De locatie van de zonetoewijzing.
zones	string[]