Deployments - Validate At Tenant Scope

Dienst:

Resource Management

API-Version:

2021-04-01

Überprüft, ob die angegebene Vorlage syntaktisch korrekt ist und von Azure Resource Manager akzeptiert wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentName	path	True	string	Der Name der Bereitstellung RegEx-Muster: ^[-\w\._\(\)]+$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der Speicherort für die Bereitstellungsdaten.
properties	True	DeploymentProperties	Die Bereitstellungseigenschaften.
tags		object	Bereitstellungstags

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentValidateResult	OK: Gibt das Validierungsergebnis zurück.
202 Accepted		Akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert, und der Vorgang wird asynchron abgeschlossen.
400 Bad Request	DeploymentValidateResult	Gibt das Validierungsergebnis zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Definitionen

Name	Beschreibung
Alias	Der Aliastyp.
AliasPath	Der Typ der Pfade für den Alias.
AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
AliasPathMetadata
AliasPathTokenType	Der Typ des Tokens, auf das sich der Aliaspfad bezieht.
AliasPattern	Der Typ des Musters für einen Aliaspfad.
AliasPatternType	Typ des Aliasmusters
AliasType	Der Typ de Alias.
ApiProfile
BasicDependency	Informationen zur Bereitstellungsabhängigkeit.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
DebugSetting	Die Debugeinstellung.
Dependency	Informationen zur Bereitstellungsabhängigkeit.
DeploymentMode	Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder Inkrementell oder Vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie versehentlich Ressourcen löschen können.
DeploymentProperties	Bereitstellungseigenschaften.
DeploymentPropertiesExtended	Bereitstellungseigenschaften mit zusätzlichen Details.
DeploymentValidateResult	Informationen aus der Antwort der Vorlagenbereitstellungsüberprüfung.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
ExpressionEvaluationOptions	Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten oder geschachtelten Vorlage ausgewertet werden.
ExpressionEvaluationOptionsScopeType	Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.
OnErrorDeployment	Bereitstellung bei Fehlerverhalten.
OnErrorDeploymentExtended	Bereitstellung bei Fehlerverhalten mit zusätzlichen Details.
OnErrorDeploymentType	Die Bereitstellung nach Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.
ParametersLink	Entität, die den Verweis auf die Bereitstellungsparameter darstellt.
Provider	Informationen zum Ressourcenanbieter.
ProviderAuthorizationConsentState	Der Autorisierungsstatus des Anbieters.
ProviderExtendedLocation	Der erweiterte Standort des Anbieters.
ProviderResourceType	Durch den Ressourcenanbieter verwalteter Ressourcentyp.
ProvisioningState	Gibt den Status der Bereitstellung an.
ResourceReference	Das Ressourcen-ID-Modell.
ScopedDeployment	Parameter des Bereitstellungsvorgangs.
TemplateLink	Entität, die den Verweis auf die Vorlage darstellt.
ZoneMapping

Alias

Der Aliastyp.

Name	Typ	Beschreibung
defaultMetadata	AliasPathMetadata	Die Standard-Aliaspfadmetadaten. Gilt für den Standardpfad und für jeden Aliaspfad, der keine Metadaten enthält.
defaultPath	string	Der Standardpfad für einen Alias.
defaultPattern	AliasPattern	Das Standardmuster für einen Alias.
name	string	Der Aliasname.
paths	AliasPath[]	Die Pfade für einen Alias.
type	AliasType	Der Typ de Alias.

AliasPath

Der Typ der Pfade für den Alias.

Name	Typ	Beschreibung
apiVersions	string[]	Die API-Versionen.
metadata	AliasPathMetadata	Die Metadaten des Aliaspfads. Falls nicht vorhanden, greifen Sie auf die Standardmetadaten des Alias zurück.
path	string	Der Pfad eines Alias.
pattern	AliasPattern	Das Muster für einen Aliaspfad.

AliasPathAttributes

Die Attribute des Tokens, auf das der Aliaspfad verweist.

Name	Typ	Beschreibung
Modifiable	string	Das Token, auf das sich der Aliaspfad bezieht, kann durch Richtlinien mit dem Effekt "modify" geändert werden.
None	string	Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf.

AliasPathMetadata

Name	Typ	Beschreibung
attributes	AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
type	AliasPathTokenType	Der Typ des Tokens, auf das sich der Aliaspfad bezieht.

AliasPathTokenType

Der Typ des Tokens, auf das sich der Aliaspfad bezieht.

Name	Typ	Beschreibung
Any	string	Der Tokentyp kann beliebig sein.
Array	string	Der Tokentyp ist array.
Boolean	string	Der Tokentyp ist boolescher Wert.
Integer	string	Der Tokentyp ist integer.
NotSpecified	string	Der Tokentyp ist nicht angegeben.
Number	string	Der Tokentyp ist number.
Object	string	Der Tokentyp ist object.
String	string	Der Tokentyp ist Zeichenfolge.

AliasPattern

Der Typ des Musters für einen Aliaspfad.

Name	Typ	Beschreibung
phrase	string	Der Aliasmusterausdruck.
type	AliasPatternType	Typ des Aliasmusters
variable	string	Die Aliasmustervariable.

AliasPatternType

Typ des Aliasmusters

Name	Typ	Beschreibung
Extract	string	Extrahieren ist der einzige zulässige Wert.
NotSpecified	string	NotSpecified ist nicht zulässig.

AliasType

Der Typ de Alias.

Name	Typ	Beschreibung
Mask	string	Der Aliaswert ist geheimnis.
NotSpecified	string	Der Aliastyp ist unbekannt (identisch mit der Angabe des Aliastyps).
PlainText	string	Der Aliaswert ist kein Geheimnis.

ApiProfile

Name	Typ	Beschreibung
apiVersion	string	Die API-Version.
profileVersion	string	Die Profilversion.

BasicDependency

Informationen zur Bereitstellungsabhängigkeit.

Name	Typ	Beschreibung
id	string	Die ID der Abhängigkeit.
resourceName	string	Der Name der Abhängigkeitsressource.
resourceType	string	Der Ressourcentyp der Abhängigkeit.

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

DebugSetting

Die Debugeinstellung.

Name	Typ	Beschreibung
detailLevel	string	Gibt den Typ der Informationen an, die für das Debuggen protokolliert werden sollen. Die zulässigen Werte sind none, requestContent, responseContent oder requestContent und responseContent getrennt durch ein Komma. Der Standardwert ist „none“. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig den Typ der Informationen, die Sie während der Bereitstellung übergeben. Indem Sie Informationen über die Anforderung oder die Antwort protokollieren, machen Sie möglicherweise vertrauliche Daten verfügbar, die durch die Bereitstellungsvorgänge abgerufen werden.

Dependency

Informationen zur Bereitstellungsabhängigkeit.

Name	Typ	Beschreibung
dependsOn	BasicDependency[]	Die Liste der Abhängigkeiten.
id	string	Die ID der Abhängigkeit.
resourceName	string	Der Name der Abhängigkeitsressource.
resourceType	string	Der Ressourcentyp der Abhängigkeit.

DeploymentMode

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder Inkrementell oder Vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie versehentlich Ressourcen löschen können.

Name	Typ	Beschreibung
Complete	string
Incremental	string

DeploymentProperties

Bereitstellungseigenschaften.

Name	Typ	Beschreibung
debugSetting	DebugSetting	Die Debugeinstellung der Bereitstellung.
expressionEvaluationOptions	ExpressionEvaluationOptions	Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten oder geschachtelten Vorlage ausgewertet werden. Gilt nur für geschachtelte Vorlagen. Wenn nicht angegeben, ist der Standardwert äußerer Wert.
mode	DeploymentMode	Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder Inkrementell oder Vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie versehentlich Ressourcen löschen können.
onErrorDeployment	OnErrorDeployment	Die Bereitstellung bei Fehlerverhalten.
parameters	object	Name- und Wertpaare, die die Bereitstellungsparameter für die Vorlage definieren. Sie verwenden dieses Element, wenn Sie die Parameterwerte direkt in der Anforderung angeben möchten, anstatt eine Verknüpfung mit einer vorhandenen Parameterdatei herzustellen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beide. Dabei kann es sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge handeln.
parametersLink	ParametersLink	Der URI der Parameterdatei. Sie verwenden dieses Element, um eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beide.
template	object	Der Vorlageninhalt. Sie verwenden dieses Element, wenn Sie die Vorlagensyntax direkt in der Anforderung übergeben möchten, anstatt eine Verknüpfung mit einer vorhandenen Vorlage herzustellen. Es kann sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge handeln. Verwenden Sie entweder die templateLink-Eigenschaft oder die Template-Eigenschaft, aber nicht beides.
templateLink	TemplateLink	Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Template-Eigenschaft, aber nicht beides.

DeploymentPropertiesExtended

Bereitstellungseigenschaften mit zusätzlichen Details.

Name	Typ	Beschreibung
correlationId	string	Die Korrelations-ID der Bereitstellung.
debugSetting	DebugSetting	Die Debugeinstellung der Bereitstellung.
dependencies	Dependency[]	Die Liste der Bereitstellungsabhängigkeiten.
duration	string	Die Dauer der Vorlagenbereitstellung.
error	ErrorResponse	Fehlerantwort Der Bereitstellungsfehler.
mode	DeploymentMode	Der Bereitstellungsmodus. Mögliche Werte sind Inkrementell und Vollständig.
onErrorDeployment	OnErrorDeploymentExtended	Die Bereitstellung bei Fehlerverhalten.
outputResources	ResourceReference[]	Array der bereitgestellten Ressourcen.
outputs	object	Schlüssel-Wert-Paare, die die Bereitstellungsausgabe darstellen.
parameters	object	Deployment-Parameter.
parametersLink	ParametersLink	Der URI, der auf die Parameter verweist.
providers	Provider[]	Die Liste der Ressourcenanbieter, die für die Bereitstellung benötigt werden.
provisioningState	ProvisioningState	Gibt den Status der Bereitstellung an.
templateHash	string	Der für die Vorlage erstellte Hash.
templateLink	TemplateLink	Der URI, der auf die Vorlage verweist.
timestamp	string	Der Zeitstempel der Vorlagenbereitstellung.
validatedResources	ResourceReference[]	Array überprüfter Ressourcen.

DeploymentValidateResult

Informationen aus der Antwort der Vorlagenbereitstellungsüberprüfung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Der Fehler bei der Überprüfung der Bereitstellung.
properties	DeploymentPropertiesExtended	Die Vorlagenbereitstellungseigenschaften.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten oder geschachtelten Vorlage ausgewertet werden.

Name	Typ	Beschreibung
scope	ExpressionEvaluationOptionsScopeType	Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

ExpressionEvaluationOptionsScopeType

Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

Name	Typ	Beschreibung
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Bereitstellung bei Fehlerverhalten.

Name	Typ	Beschreibung
deploymentName	string	Die Bereitstellung, die bei Einem Fehlerfall verwendet werden soll.
type	OnErrorDeploymentType	Die Bereitstellung nach Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.

OnErrorDeploymentExtended

Bereitstellung bei Fehlerverhalten mit zusätzlichen Details.

Name	Typ	Beschreibung
deploymentName	string	Die Bereitstellung, die bei Einem Fehlerfall verwendet werden soll.
provisioningState	string	Der Status der Bereitstellung für die On Error-Bereitstellung.
type	OnErrorDeploymentType	Die Bereitstellung nach Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.

OnErrorDeploymentType

Die Bereitstellung nach Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.

Name	Typ	Beschreibung
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entität, die den Verweis auf die Bereitstellungsparameter darstellt.

Name	Typ	Beschreibung
contentVersion	string	Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.
uri	string	Der URI der Parameterdatei.

Provider

Informationen zum Ressourcenanbieter.

Name	Typ	Beschreibung
id	string	Die Anbieter-ID.
namespace	string	Der Namespace des Ressourcenanbieters.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Der Autorisierungsstatus des Anbieters.
registrationPolicy	string	Die Registrierungsrichtlinie des Ressourcenanbieters.
registrationState	string	Der Registrierungsstatus des Ressourcenanbieters.
resourceTypes	ProviderResourceType[]	Die Auflistung von Anbieterressourcentypen.

ProviderAuthorizationConsentState

Der Autorisierungsstatus des Anbieters.

Name	Typ	Beschreibung
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Der erweiterte Standort des Anbieters.

Name	Typ	Beschreibung
extendedLocations	string[]	Die erweiterten Speicherorte für den Azure-Standort.
location	string	Der Azure-Standort.
type	string	Der erweiterte Standorttyp.

ProviderResourceType

Durch den Ressourcenanbieter verwalteter Ressourcentyp.

Name	Typ	Beschreibung
aliases	Alias[]	Die Aliase, die von diesem Ressourcentyp unterstützt werden.
apiProfiles	ApiProfile[]	Die API-Profile für den Ressourcenanbieter.
apiVersions	string[]	Die API-Version.
capabilities	string	Die zusätzlichen Funktionen, die von diesem Ressourcentyp angeboten werden.
defaultApiVersion	string	Die Standard-API-Version.
locationMappings	ProviderExtendedLocation[]	Die Von diesem Ressourcentyp unterstützten Standortzuordnungen.
locations	string[]	Die Auflistung der Speicherorte, an denen dieser Ressourcentyp erstellt werden kann.
properties	object	Die Eigenschaften.
resourceType	string	Der Ressourcentyp.
zoneMappings	ZoneMapping[]

ProvisioningState

Gibt den Status der Bereitstellung an.

Name	Typ	Beschreibung
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

Das Ressourcen-ID-Modell.

Name	Typ	Beschreibung
id	string	Die vollqualifizierte Ressourcen-ID.

ScopedDeployment

Parameter des Bereitstellungsvorgangs.

Name	Typ	Beschreibung
location	string	Der Speicherort für die Bereitstellungsdaten.
properties	DeploymentProperties	Die Bereitstellungseigenschaften.
tags	object	Bereitstellungstags

TemplateLink

Entität, die den Verweis auf die Vorlage darstellt.

Name	Typ	Beschreibung
contentVersion	string	Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.
id	string	Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die Id- oder URI-Eigenschaft, aber nicht beide.
queryString	string	Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll.
relativePath	string	Die relativePath-Eigenschaft kann verwendet werden, um eine verknüpfte Vorlage an einem Speicherort relativ zum übergeordneten Element bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, verweist dies auf ein Artefakt in der TemplateSpec. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten uris und relativePath-URIs.
uri	string	Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder id-Eigenschaft, aber nicht beide.

ZoneMapping

Name	Typ	Beschreibung
location	string	Der Speicherort der Zonenzuordnung.
zones	string[]