Freigeben über


Microsoft.Resources-Bereitstellungen 2022-09-01

Bemerkungen

Für Bicep sollten Sie anstelle dieses Ressourcentyps Module verwenden.

Bicep-Ressourcendefinition

Der Ressourcentyp "Deployments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Resources/deployments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Resources/deployments@2022-09-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

DebugSetting

Name Beschreibung Wert
detailLevel 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. Schnur

DeploymentParameter

Name Beschreibung Wert
Referenz Referenz zum Azure Key Vault-Parameter. KeyVaultParameterReference
Wert Eingabewert für den Parameter . jegliche

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Beschreibung Wert
debugSetting Die Debugeinstellung der Bereitstellung. DebugSetting-
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 außen. ExpressionEvaluationOptions-
Modus 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. "Abgeschlossen"
"Inkrementell" (erforderlich)
onErrorDeployment Die Bereitstellung beim Fehlerverhalten. OnErrorDeploymentOrOnErrorDeploymentExtended
Parameter Name- 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 eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die ParametersLink-Eigenschaft oder die Parametereigenschaft, aber nicht beide. Es kann sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge sein. DeploymentPropertiesParameters
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. ParametersLink-
Schablone 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 wohlgeformte JSON-Zeichenfolge sein. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. jegliche
templateLink Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. TemplateLink-

DeploymentPropertiesParameters

Name Beschreibung Wert

DeploymentTags

Name Beschreibung Wert

ExpressionEvaluationOptions

Name Beschreibung Wert
Umfang Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll. 'Inner'
"Nicht angegeben"
"Außen"

KeyVaultParameterReference

Name Beschreibung Wert
keyVault Azure Key Vault-Referenz. KeyVaultReference- (erforderlich)
secretName Geheimer Azure Key Vault-Name. Zeichenfolge (erforderlich)
secretVersion Geheime Azure Key Vault-Version. Schnur

KeyVaultReference

Name Beschreibung Wert
id Azure Key Vault-Ressourcen-ID. Zeichenfolge (erforderlich)

Microsoft.Resources/Deployments

Name Beschreibung Wert
Ort Der Speicherort zum Speichern der Bereitstellungsdaten. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[-\w\._\(\)]+$ (erforderlich)
Eigenschaften Die Bereitstellungseigenschaften. DeploymentPropertiesOrDeploymentPropertiesExtended (erforderlich)
Umfang Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Beschreibung Wert
deploymentName Die Bereitstellung, die für den Fehlerfall verwendet werden soll. Schnur
Art Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
Uri Der URI der Parameterdatei. Zeichenfolge (erforderlich)
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
id Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beide. Schnur
queryString Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll. Schnur
relativePath 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. Schnur
Uri Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide. Schnur

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Deployments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Resources/deployments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2022-09-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

DebugSetting

Name Beschreibung Wert
detailLevel 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. Schnur

DeploymentParameter

Name Beschreibung Wert
Referenz Referenz zum Azure Key Vault-Parameter. KeyVaultParameterReference
Wert Eingabewert für den Parameter . jegliche

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Beschreibung Wert
debugSetting Die Debugeinstellung der Bereitstellung. DebugSetting-
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 außen. ExpressionEvaluationOptions-
Modus 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. "Abgeschlossen"
"Inkrementell" (erforderlich)
onErrorDeployment Die Bereitstellung beim Fehlerverhalten. OnErrorDeploymentOrOnErrorDeploymentExtended
Parameter Name- 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 eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die ParametersLink-Eigenschaft oder die Parametereigenschaft, aber nicht beide. Es kann sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge sein. DeploymentPropertiesParameters
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. ParametersLink-
Schablone 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 wohlgeformte JSON-Zeichenfolge sein. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. jegliche
templateLink Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. TemplateLink-

DeploymentPropertiesParameters

Name Beschreibung Wert

DeploymentTags

Name Beschreibung Wert

ExpressionEvaluationOptions

Name Beschreibung Wert
Umfang Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll. 'Inner'
"Nicht angegeben"
"Außen"

KeyVaultParameterReference

Name Beschreibung Wert
keyVault Azure Key Vault-Referenz. KeyVaultReference- (erforderlich)
secretName Geheimer Azure Key Vault-Name. Zeichenfolge (erforderlich)
secretVersion Geheime Azure Key Vault-Version. Schnur

KeyVaultReference

Name Beschreibung Wert
id Azure Key Vault-Ressourcen-ID. Zeichenfolge (erforderlich)

Microsoft.Resources/Deployments

Name Beschreibung Wert
apiVersion Die API-Version '2022-09-01'
Ort Der Speicherort zum Speichern der Bereitstellungsdaten. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[-\w\._\(\)]+$ (erforderlich)
Eigenschaften Die Bereitstellungseigenschaften. DeploymentPropertiesOrDeploymentPropertiesExtended (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.Resources/deployments"

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Beschreibung Wert
deploymentName Die Bereitstellung, die für den Fehlerfall verwendet werden soll. Schnur
Art Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
Uri Der URI der Parameterdatei. Zeichenfolge (erforderlich)
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
id Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beide. Schnur
queryString Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll. Schnur
relativePath 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. Schnur
Uri Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Deployments" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Resources/Deployments-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2022-09-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

Eigenschaftswerte

DebugSetting

Name Beschreibung Wert
detailLevel 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. Schnur

DeploymentParameter

Name Beschreibung Wert
Referenz Referenz zum Azure Key Vault-Parameter. KeyVaultParameterReference
Wert Eingabewert für den Parameter . jegliche

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Beschreibung Wert
debugSetting Die Debugeinstellung der Bereitstellung. DebugSetting-
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 außen. ExpressionEvaluationOptions-
Modus 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. "Abgeschlossen"
"Inkrementell" (erforderlich)
onErrorDeployment Die Bereitstellung beim Fehlerverhalten. OnErrorDeploymentOrOnErrorDeploymentExtended
Parameter Name- 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 eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die ParametersLink-Eigenschaft oder die Parametereigenschaft, aber nicht beide. Es kann sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge sein. DeploymentPropertiesParameters
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. ParametersLink-
Schablone 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 wohlgeformte JSON-Zeichenfolge sein. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. jegliche
templateLink Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. TemplateLink-

DeploymentPropertiesParameters

Name Beschreibung Wert

DeploymentTags

Name Beschreibung Wert

ExpressionEvaluationOptions

Name Beschreibung Wert
Umfang Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll. 'Inner'
"Nicht angegeben"
"Außen"

KeyVaultParameterReference

Name Beschreibung Wert
keyVault Azure Key Vault-Referenz. KeyVaultReference- (erforderlich)
secretName Geheimer Azure Key Vault-Name. Zeichenfolge (erforderlich)
secretVersion Geheime Azure Key Vault-Version. Schnur

KeyVaultReference

Name Beschreibung Wert
id Azure Key Vault-Ressourcen-ID. Zeichenfolge (erforderlich)

Microsoft.Resources/Deployments

Name Beschreibung Wert
Ort Der Speicherort zum Speichern der Bereitstellungsdaten. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[-\w\._\(\)]+$ (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Die Bereitstellungseigenschaften. DeploymentPropertiesOrDeploymentPropertiesExtended (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.Resources/deployments@2022-09-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Beschreibung Wert
deploymentName Die Bereitstellung, die für den Fehlerfall verwendet werden soll. Schnur
Art Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
Uri Der URI der Parameterdatei. Zeichenfolge (erforderlich)
Name Beschreibung Wert
contentVersion Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. Schnur
id Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beide. Schnur
queryString Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll. Schnur
relativePath 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. Schnur
Uri Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide. Schnur