Deployments - Get

Dienst:

Resource Management

API-Version:

2021-04-01

Ruft eine Bereitstellung ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._\(\)]+$	Der Name der Bereitstellung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentExtended	OK : Gibt Informationen zur Bereitstellung zurück, einschließlich des Bereitstellungsstatus.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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 Alias.
AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
AliasPathMetadata
AliasPathTokenType	Der Typ des Tokens, auf das der Aliaspfad verweist.
AliasPattern	Der Typ des Musters für einen Aliaspfad.
AliasPatternType	Der Typ des Aliasmusters
AliasType	Der Typ des Alias.
ApiProfile
BasicDependency	Informationen zur Bereitstellungsabhängigkeit.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
DebugSetting	Die Debugeinstellung.
Dependency	Informationen zur Bereitstellungsabhängigkeit.
DeploymentExtended	Bereitstellungsinformationen.
DeploymentMode	Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen 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, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen.
DeploymentPropertiesExtended	Bereitstellungseigenschaften mit zusätzlichen Details.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
OnErrorDeploymentExtended	Bereitstellung bei Fehlerverhalten mit zusätzlichen Details.
OnErrorDeploymentType	Die Bereitstellung beim 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 Anbieterspeicherort.
ProviderResourceType	Vom Ressourcenanbieter verwalteter Ressourcentyp.
ProvisioningState	Gibt den Bereitstellungsstatus an.
ResourceReference	Das Ressourcen-ID-Modell.
TemplateLink	Entität, die den Verweis auf die Vorlage darstellt.
ZoneMapping

Alias

Objekt

Der Aliastyp.

Name	Typ	Beschreibung
defaultMetadata	AliasPathMetadata	Die Standardaliaspfadmetadaten. Gilt für den Standardpfad und für alle Aliaspfade, für die keine Metadaten vorhanden sind
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 des Alias.

AliasPath

Objekt

Der Typ der Pfade für Alias.

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

AliasPathAttributes

Enumeration

Die Attribute des Tokens, auf das der Aliaspfad verweist.

Wert	Beschreibung
Modifiable	Das Token, auf das der Aliaspfad verweist, kann durch Richtlinien mit "Modify"-Effekt geändert werden.
None	Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf.

AliasPathMetadata

Objekt

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

AliasPathTokenType

Enumeration

Der Typ des Tokens, auf das der Aliaspfad verweist.

Wert	Beschreibung
Any	Der Tokentyp kann alles sein.
Array	Der Tokentyp ist array.
Boolean	Der Tokentyp ist boolescher Wert.
Integer	Der Tokentyp ist eine ganze Zahl.
NotSpecified	Der Tokentyp ist nicht angegeben.
Number	Der Tokentyp ist Zahl.
Object	Der Tokentyp ist Objekt.
String	Der Tokentyp ist eine Zeichenfolge.

AliasPattern

Objekt

Der Typ des Musters für einen Aliaspfad.

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

AliasPatternType

Enumeration

Der Typ des Aliasmusters

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

AliasType

Enumeration

Der Typ des Alias.

Wert	Beschreibung
Mask	Der Aliaswert ist geheim.
NotSpecified	Der Aliastyp ist unbekannt (identisch mit der Angabe des Aliastyps).
PlainText	Der Aliaswert ist nicht geheim.

ApiProfile

Objekt

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

BasicDependency

Objekt

Informationen zur Bereitstellungsabhängigkeit.

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

CloudError

Objekt

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

DebugSetting

Objekt

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", die durch ein Komma getrennt sind. Der Standardwert ist keine. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig die Art der Informationen, die Sie während der Bereitstellung übergeben. Durch die Protokollierung von Informationen über die Anforderung oder Antwort könnten Sie potenziell vertrauliche Daten verfügbar machen, die über die Bereitstellungsvorgänge abgerufen werden.

Dependency

Objekt

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 Abhängigkeitsressourcentyp.

DeploymentExtended

Objekt

Bereitstellungsinformationen.

Name	Typ	Beschreibung
id	string	Die ID der Bereitstellung.
location	string	der Speicherort der Bereitstellung.
name	string	Der Name der Bereitstellung.
properties	DeploymentPropertiesExtended	Bereitstellungseigenschaften.
tags	object	Bereitstellungstags
type	string	Der Typ der Bereitstellung.

DeploymentMode

Enumeration

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen 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, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen.

Wert	Beschreibung
Complete
Incremental

DeploymentPropertiesExtended

Objekt

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 abgeschlossen.
onErrorDeployment	OnErrorDeploymentExtended	Die Bereitstellung beim Fehlerverhalten.
outputResources	ResourceReference[]	Array der bereitgestellten Ressourcen.
outputs	object	Schlüssel-Wert-Paare, die die Bereitstellungsausgabe darstellen.
parameters	object	Bereitstellungsparameter.
parametersLink	ParametersLink	Der URI, der auf die Parameter verweist.
providers	Provider[]	Die Liste der Ressourcenanbieter, die für die Bereitstellung erforderlich sind.
provisioningState	ProvisioningState	Gibt den Bereitstellungsstatus an.
templateHash	string	Der für die Vorlage erstellte Hash.
templateLink	TemplateLink	Der URI, der auf die Vorlage verweist.
timestamp	string (date-time)	Der Zeitstempel der Vorlagenbereitstellung.
validatedResources	ResourceReference[]	Array von überprüften Ressourcen.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Fehlerantwort

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

OnErrorDeploymentExtended

Objekt

Bereitstellung bei Fehlerverhalten mit zusätzlichen Details.

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

OnErrorDeploymentType

Enumeration

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

Wert	Beschreibung
LastSuccessful
SpecificDeployment

ParametersLink

Objekt

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

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

Provider

Objekt

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 Sammlung von Anbieterressourcentypen.

ProviderAuthorizationConsentState

Enumeration

Der Autorisierungsstatus des Anbieters.

Wert	Beschreibung
Consented
NotRequired
NotSpecified
Required

ProviderExtendedLocation

Objekt

Der erweiterte Anbieterspeicherort.

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

ProviderResourceType

Objekt

Vom 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 Standortzuordnungen, die von diesem Ressourcentyp unterstützt werden.
locations	string[]	Die Sammlung der Speicherorte, an denen dieser Ressourcentyp erstellt werden kann.
properties	object	Die Eigenschaften.
resourceType	string	Der Ressourcentyp.
zoneMappings	ZoneMapping[]

ProvisioningState

Enumeration

Gibt den Bereitstellungsstatus an.

Wert	Beschreibung
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
NotSpecified
Ready
Running
Succeeded
Updating

ResourceReference

Objekt

Das Ressourcen-ID-Modell.

Name	Typ	Beschreibung
id	string	Die vollqualifizierte Ressourcen-ID.

TemplateLink

Objekt

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

Name	Typ	Beschreibung
contentVersion	string	Falls enthalten, muss der ContentVersion in der Vorlage entsprechen.
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, wird auf ein Artefakt in der TemplateSpec verwiesen. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten und relativenPath-URIs.
uri	string	Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide.

ZoneMapping

Objekt

Name	Typ	Beschreibung
location	string	Die Position der Zonenzuordnung.
zones	string[]