Deployments - Create Or Update At Tenant Scope

Stellt Ressourcen im Mandantenbereich bereit.
Sie können die Vorlage und Parameter direkt in der Anforderung oder im Link zu JSON-Dateien bereitstellen.

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

URI-Parameter

Name In Required Type Description
deploymentName
path True
  • string

Der Name der Bereitstellung

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Required Type Description
location True
  • string

Der Speicherort zum Speichern der Bereitstellungsdaten.

properties True

Die Bereitstellungseigenschaften.

tags
  • object

Bereitstellungstags

Antworten

Name Type Description
200 OK

OK – Gibt Informationen zur Bereitstellung zurück, einschließlich Bereitstellungsstatus.

201 Created

Erstellt – Gibt Informationen zur Bereitstellung zurück, einschließlich Bereitstellungsstatus.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Create deployment at tenant scope.

Sample Request

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Sample Response

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}
{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Definitionen

Alias

Der Aliastyp.

AliasPath

Der Typ der Pfade für Alias.

AliasPathAttributes

Die Attribute des Token, auf das der Aliaspfad verweist.

AliasPathMetadata
AliasPathTokenType

Der Typ des Token, auf das der Aliaspfad verweist.

AliasPattern

Der Typ des Musters für einen Aliaspfad.

AliasPatternType

Der 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.

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 versehentlich Ressourcen löschen.

DeploymentProperties

Bereitstellungseigenschaften.

DeploymentPropertiesExtended

Bereitstellungseigenschaften mit zusätzlichen Details.

ErrorAdditionalInfo

Der Fehler beim Ressourcenverwaltungsfehler.

ErrorResponse

Fehlerantwort

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage 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 beim Fehlerverhalten.

OnErrorDeploymentExtended

Bereitstellung im Fehlerverhalten mit zusätzlichen Details.

OnErrorDeploymentType

Die Bereitstellung für den 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 Anbieter hat den erweiterten Standort erweitert.

ProviderResourceType

Durch den Ressourcenanbieter verwalteter Ressourcentyp.

ProvisioningState

Gibt den Status der Bereitstellung an.

ResourceReference

Das Ressourcen-ID-Modell.

ScopedDeployment

Parameter für den Bereitstellungsvorgang.

TemplateLink

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

ZoneMapping

Alias

Der Aliastyp.

Name Type Description
defaultMetadata

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

Das Standardmuster für einen Alias.

name
  • string

Der Aliasname.

paths

Die Pfade für einen Alias.

type

Der Typ de Alias.

AliasPath

Der Typ der Pfade für Alias.

Name Type Description
apiVersions
  • string[]

Die API-Versionen.

metadata

Die Metadaten des Aliaspfads. Falls nicht vorhanden, fallen Sie auf die Standardmetadaten des Alias zurück.

path
  • string

Der Pfad eines Alias.

pattern

Das Muster für einen Aliaspfad.

AliasPathAttributes

Die Attribute des Token, auf das der Aliaspfad verweist.

Name Type Description
Modifiable
  • string

Das Token, auf das der Aliaspfad verweist, ist durch Richtlinien mit dem Effekt "Ändern" geändert.

None
  • string

Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf.

AliasPathMetadata

Name Type Description
attributes

Die Attribute des Token, auf das der Aliaspfad verweist.

type

Der Typ des Token, auf das der Aliaspfad verweist.

AliasPathTokenType

Der Typ des Token, auf das der Aliaspfad verweist.

Name Type Description
Any
  • string

Der Tokentyp kann alles sein.

Array
  • string

Der Tokentyp ist Array.

Boolean
  • string

Der Tokentyp ist boolescher Typ.

Integer
  • string

Der Tokentyp ist ganze Zahl.

NotSpecified
  • string

Der Tokentyp wird nicht angegeben.

Number
  • string

Der Tokentyp ist Zahl.

Object
  • string

Der Tokentyp ist Objekt.

String
  • string

Der Tokentyp ist Zeichenfolge.

AliasPattern

Der Typ des Musters für einen Aliaspfad.

Name Type Description
phrase
  • string

Der Aliasmusterausdruck.

type

Der Typ des Aliasmusters

variable
  • string

Die Aliasmustervariable.

AliasPatternType

Der Typ des Aliasmusters

Name Type Description
Extract
  • string

Der Extrakt ist der einzige zulässige Wert.

NotSpecified
  • string

NotSpecified ist nicht zulässig.

AliasType

Der Typ de Alias.

Name Type Description
Mask
  • string

Aliaswert ist geheim.

NotSpecified
  • string

Der Aliastyp ist unbekannt (identisch mit der Bereitstellung von Aliastyp).

PlainText
  • string

Der Aliaswert ist nicht geheim.

ApiProfile

Name Type Description
apiVersion
  • string

Die API-Version.

profileVersion
  • string

Die Profilversion.

BasicDependency

Informationen zur Bereitstellungsabhängigkeit.

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

Fehlerantwort
Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

DebugSetting

Die Debugeinstellung.

Name Type Description
detailLevel
  • string

Gibt den Typ der Informationen an, die für das Debuggen protokolliert werden sollen. Die zulässigen Werte sind keine, requestContent, responseContent oder sowohl requestContent als auch responseContent getrennt durch ein Komma. Der Standardwert ist „none“. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig die Art 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 Type Description
dependsOn

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.

DeploymentExtended

Informationen zur Bereitstellung.

Name Type Description
id
  • string

Die ID der Bereitstellung.

location
  • string

der Speicherort der Bereitstellung.

name
  • string

Der Name der Bereitstellung

properties

Bereitstellungseigenschaften.

tags
  • object

Bereitstellungstags

type
  • string

Der Typ der Bereitstellung.

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 versehentlich Ressourcen löschen.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Bereitstellungseigenschaften.

Name Type Description
debugSetting

Die Debugeinstellung der Bereitstellung.

expressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden. Gilt nur für geschachtelte Vorlagen. Wenn nicht angegeben, ist der Standardwert äußerer Wert.

mode

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 versehentlich Ressourcen löschen.

onErrorDeployment

Die Bereitstellung beim Fehlerverhalten.

parameters
  • object

Namen- und Wertpaare, die die Bereitstellungsparameter für die Vorlage definieren. Sie verwenden dieses Element, wenn Sie die Parameterwerte direkt in der Anforderung bereitstellen möchten, anstatt mit einer vorhandenen Parameterdatei zu verknüpfen. Verwenden Sie entweder die ParametersLink-Eigenschaft oder die Parametereigenschaft, aber nicht beide. Es kann sich um ein JObject oder eine gut gebildete JSON-Zeichenfolge sein.

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 Parametereigenschaft, aber nicht beide.

template
  • object

Der Vorlageninhalt. Sie verwenden dieses Element, wenn Sie die Vorlagensyntax direkt in der Anforderung übergeben möchten, anstatt mit einer vorhandenen Vorlage zu verknüpfen. Es kann sich um eine JObject- oder gut formierte JSON-Zeichenfolge sein. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide.

templateLink

Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide.

DeploymentPropertiesExtended

Bereitstellungseigenschaften mit zusätzlichen Details.

Name Type Description
correlationId
  • string

Die Korrelations-ID der Bereitstellung.

debugSetting

Die Debugeinstellung der Bereitstellung.

dependencies

Die Liste der Bereitstellungsabhängigkeiten.

duration
  • string

Die Dauer der Vorlagenbereitstellung.

error

Fehlerantwort
Der Bereitstellungsfehler.

mode

Der Bereitstellungsmodus. Mögliche Werte sind inkrementell und abgeschlossen.

onErrorDeployment

Die Bereitstellung beim Fehlerverhalten.

outputResources

Array von bereitgestellten Ressourcen.

outputs
  • object

Schlüssel-Wert-Paare, die die Bereitstellungsausgabe darstellen.

parameters
  • object

Deployment-Parameter.

parametersLink

Der URI verweist auf die Parameter.

providers

Die Liste der Ressourcenanbieter, die für die Bereitstellung erforderlich sind.

provisioningState

Gibt den Status der Bereitstellung an.

templateHash
  • string

Der für die Vorlage erstellte Hash.

templateLink

Der URI, der auf die Vorlage verweist.

timestamp
  • string

Der Zeitstempel der Vorlagenbereitstellung.

validatedResources

Array überprüfter Ressourcen.

ErrorAdditionalInfo

Der Fehler beim Ressourcenverwaltungsfehler.

Name Type Description
info
  • object

Die zusätzlichen Informationen.

type
  • string

Der zusätzliche Infotyp.

ErrorResponse

Fehlerantwort

Name Type Description
additionalInfo

Der Fehler zusätzliche Informationen.

code
  • string

Der Fehlercode.

details

Die Fehlerdetails.

message
  • string

Die Fehlermeldung.

target
  • string

Das Fehlerziel.

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden.

Name Type Description
scope

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 Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Bereitstellung beim Fehlerverhalten.

Name Type Description
deploymentName
  • string

Die Bereitstellung, die bei Fehlerfall verwendet werden soll.

type

Die Bereitstellung für den Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.

OnErrorDeploymentExtended

Bereitstellung im Fehlerverhalten mit zusätzlichen Details.

Name Type Description
deploymentName
  • string

Die Bereitstellung, die bei Fehlerfall verwendet werden soll.

provisioningState
  • string

Der Status der Bereitstellung für die Fehlerbereitstellung.

type

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

OnErrorDeploymentType

Die Bereitstellung für den Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type Description
contentVersion
  • string

Falls enthalten, muss die ContentVersion in der Vorlage übereinstimmen.

uri
  • string

Der URI der Parameterdatei.

Provider

Informationen zum Ressourcenanbieter.

Name Type Description
id
  • string

Die Anbieter-ID.

namespace
  • string

Der Namespace des Ressourcenanbieters.

providerAuthorizationConsentState

Der Berechtigungsstatus des Anbieters.

registrationPolicy
  • string

Die Registrierungsrichtlinie des Ressourcenanbieters.

registrationState
  • string

Der Registrierungsstatus des Ressourcenanbieters.

resourceTypes

Die Auflistung der Anbieterressourcentypen.

ProviderAuthorizationConsentState

Der Berechtigungsstatus des Anbieters.

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

Der Anbieter hat den erweiterten Standort erweitert.

Name Type Description
extendedLocations
  • string[]

Die erweiterten Speicherorte für den Azure-Speicherort.

location
  • string

Der Azure-Speicherort.

type
  • string

Der erweiterte Standorttyp.

ProviderResourceType

Durch den Ressourcenanbieter verwalteter Ressourcentyp.

Name Type Description
aliases

Die Aliase, die von diesem Ressourcentyp unterstützt werden.

apiProfiles

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

Die Standortzuordnungen, die von diesem Ressourcentyp unterstützt werden.

locations
  • string[]

Die Auflistung von Speicherorten, an denen dieser Ressourcentyp erstellt werden kann.

properties
  • object

Die Eigenschaften.

resourceType
  • string

Der Ressourcentyp.

zoneMappings

ProvisioningState

Gibt den Status der Bereitstellung an.

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

Das Ressourcen-ID-Modell.

Name Type Description
id
  • string

Die vollqualifizierte Ressourcen-ID.

ScopedDeployment

Parameter für den Bereitstellungsvorgang.

Name Type Description
location
  • string

Der Speicherort zum Speichern der Bereitstellungsdaten.

properties

Die Bereitstellungseigenschaften.

tags
  • object

Bereitstellungstags

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

Name Type Description
contentVersion
  • string

Falls enthalten, muss die 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), das mit dem templateLink-URI verwendet werden soll.

relativePath
  • string

Die relativePath-Eigenschaft kann verwendet werden, um eine verknüpfte Vorlage an einem Ort relativ zum übergeordneten Element bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, verweist dies auf ein Artefakte in der 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 zu bereitstellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide.

ZoneMapping

Name Type Description
location
  • string

Die Position der Zonenzuordnung.

zones
  • string[]