Deployments - List At Management Group Scope

Dienst:

Resource Management

API-Version:

2021-04-01

Rufen Sie alle Bereitstellungen für eine Verwaltungsgruppe ab.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/?api-version=2021-04-01

Mit optionalen Parametern:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/?$filter={$filter}&$top={$top}&api-version=2021-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
groupId	path	True	string	Die Verwaltungsgruppen-ID.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll. Sie können beispielsweise $filter=provisioningState eq '{state}' verwenden.
$top	query		integer int32	Die Anzahl der abzurufenden Ergebnisse. Wenn NULL übergeben wird, gibt alle Bereitstellungen zurück.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentListResult	OK: Gibt ein Array von Bereitstellungen 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.
DeploymentExtended	Informationen zur Bereitstellung.
DeploymentListResult	Liste der Bereitstellungen
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 ressourcen unbeabsichtigt löschen können.
DeploymentPropertiesExtended	Bereitstellungseigenschaften mit zusätzlichen Details.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
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 Berechtigungsstatus 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.
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 Abhängigkeitsressourcentyp.

DeploymentExtended

Informationen zur Bereitstellung.

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.

DeploymentListResult

Liste der Bereitstellungen

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen der nächsten Ergebnismenge verwendet werden soll.
value	DeploymentExtended[]	Ein Array von Bereitstellungen.

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 ressourcen unbeabsichtigt löschen können.

Name	Typ	Beschreibung
Complete	string
Incremental	string

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 von überprüften Ressourcen.

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.

OnErrorDeploymentExtended

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-Fehlerbereitstellung.
type	OnErrorDeploymentType	Der Bereitstellungstyp für fehlerverhalten. 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 Berechtigungsstatus des Anbieters.
registrationPolicy	string	Die Registrierungsrichtlinie des Ressourcenanbieters.
registrationState	string	Der Registrierungsstatus des Ressourcenanbieters.
resourceTypes	ProviderResourceType[]	Die Auflistung der Anbieterressourcentypen.

ProviderAuthorizationConsentState

Der Berechtigungsstatus 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 Standortzuordnungen, die von diesem Ressourcentyp unterstützt werden.
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.

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 beides.
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 relativ zum übergeordneten Standort bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, verweist dies auf ein Artefakt im TemplateSpec. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten und relativePath-URIs.
uri	string	Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder id-Eigenschaft, aber nicht beides.

ZoneMapping

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