Dela via


Microsoft.Resources deploymentStacks 2024-03-01

Bicep-resursdefinition

Resurstypen deploymentStacks kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Resources/deploymentStacks-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Resources/deploymentStacks@2024-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actionOnUnmanage: {
      managementGroups: 'string'
      resourceGroups: 'string'
      resources: 'string'
    }
    bypassStackOutOfSyncError: bool
    debugSetting: {
      detailLevel: 'string'
    }
    denySettings: {
      applyToChildScopes: bool
      excludedActions: [
        'string'
      ]
      excludedPrincipals: [
        'string'
      ]
      mode: 'string'
    }
    deploymentScope: 'string'
    description: 'string'
    error: {}
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        type: 'string'
        value: any()
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any()
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
}

Egenskapsvärden

deploymentStacks

Name Beskrivning Värde
name Resursnamnet sträng (krävs)
location Platsen för distributionsstacken. Det går inte att ändra den när den har skapats. Det måste vara en av de Azure-platser som stöds. sträng
tags Resurstaggar för distributionsstack. Ordlista med taggnamn och värden. Se Taggar i mallar
properties Egenskaper för distributionsstack. DeploymentStackEgenskaper

DeploymentStackEgenskaper

Name Beskrivning Värde
actionOnUnmanage Definierar beteendet för resurser som inte längre hanteras när distributionsstacken har uppdaterats eller tagits bort. ActionOnUnmanage (krävs)
bypassStackOutOfSyncError Flagga för att kringgå tjänstfel som anger att stackresurslistan inte är korrekt synkroniserad. boolesk
debugSetting Felsökningsinställningen för distributionen. DeploymentStacksDebugSetting
denySettings Definierar hur resurser som distribueras av stacken är låsta. NekaInställningar (krävs)
deploymentScope Det omfång där den första distributionen ska skapas. Om ett omfång inte har angetts används distributionsstackens omfång som standard. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). sträng
beskrivning Beskrivning av distributionsstack. Maximal längd på 4 096 tecken. sträng

Begränsningar:
Maximal längd = 4096
fel Felinformationen. ErrorDetail
parametrar Namn- och värdepar som definierar distributionsparametrarna för mallen. Använd det här elementet när du anger parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStackPropertiesParameters
parametersLink URI för parameterfilen. Använd det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStacksParametersLink
mall Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda. För Bicep kan du använda funktionen any().
templateLink URI:n för mallen. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda. DeploymentStacksTemplateLink

ActionOnUnmanage

Name Beskrivning Värde
managementGroups Anger en åtgärd för en nyligen ohanterad resurs. Ta bort försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resourceGroups Anger en åtgärd för en nyligen ohanterad resurs. Ta bort försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resources Anger en åtgärd för en nyligen ohanterad resurs. Borttagningen försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från" (krävs)

DeploymentStacksDebugSetting

Name Beskrivning Värde
detailLevel Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. När du anger det här värdet bör du noga överväga vilken typ av information som skickas under distributionen. Genom att logga information om begäran eller svaret kan känsliga data som hämtas via distributionsåtgärderna potentiellt exponeras. sträng

NekaInställningar

Name Beskrivning Värde
applyToChildScopes DenySettings tillämpas på underordnade resursomfattningar för varje hanterad resurs med en nekandetilldelning. boolesk
excludedActions Lista över rollbaserade hanteringsåtgärder som undantas från denySettings. Upp till 200 åtgärder är tillåtna. Om läget denySetting är inställt på "denyWriteAndDelete" läggs följande åtgärder automatiskt till i "excludedActions": "*/read" och "Microsoft.Authorization/locks/delete". Om läget denySetting är inställt på "denyDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamns-ID:t som är undantagna från låset. Upp till 5 huvudkonton tillåts. string[]
mode denySettings Mode som definierar nekade åtgärder. "denyDelete"
"denyWriteAndDelete"
"none" (krävs)

ErrorDetail

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

DeploymentStackPropertiesParameters

Name Beskrivning Värde
{anpassad egenskap} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

Name Beskrivning Värde
Referens Parameterreferens för Azure Key Vault. KeyVaultParameterReferenceAutoGenerated
typ Typ av värde. sträng
värde Indatavärde till parametern . För Bicep kan du använda funktionen any().

KeyVaultParameterReferenceAutoGenerated

Name Beskrivning Värde
keyVault Referens för Azure Key Vault. KeyVaultReferenceAutoGenerated (krävs)
secretName Azure Key Vault hemligt namn. sträng (krävs)
secretVersion Azure Key Vault hemliga versionen. sträng

KeyVaultReferenceAutoGenerated

Name Beskrivning Värde
id Azure Key Vault resourceId. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
Uri URI för parameterfilen. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
id ResourceId för en mallspecifikation. Använd antingen id- eller uri-egenskapen, men inte båda. sträng
Querystring Frågesträngen (till exempel en SAS-token) som ska användas med malllänkens URI. sträng
relativePath Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen länkades till en TemplateSpec refererar detta till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av de överordnade och relativaPath-URI:erna. sträng
Uri URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda. sträng

Resursdefinition för ARM-mall

Resurstypen deploymentStacks kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Resources/deploymentStacks-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Resources/deploymentStacks",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actionOnUnmanage": {
      "managementGroups": "string",
      "resourceGroups": "string",
      "resources": "string"
    },
    "bypassStackOutOfSyncError": "bool",
    "debugSetting": {
      "detailLevel": "string"
    },
    "denySettings": {
      "applyToChildScopes": "bool",
      "excludedActions": [ "string" ],
      "excludedPrincipals": [ "string" ],
      "mode": "string"
    },
    "deploymentScope": "string",
    "description": "string",
    "error": {},
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "type": "string",
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  }
}

Egenskapsvärden

deploymentStacks

Name Beskrivning Värde
typ Resurstypen "Microsoft.Resources/deploymentStacks"
apiVersion Resurs-API-versionen '2024-03-01'
name Resursnamnet sträng (krävs)
location Platsen för distributionsstacken. Det går inte att ändra den när den har skapats. Det måste vara en av de Azure-platser som stöds. sträng
tags Resurstaggar för distributionsstack. Ordlista med taggnamn och värden. Se Taggar i mallar
properties Egenskaper för distributionsstack. DeploymentStackEgenskaper

DeploymentStackEgenskaper

Name Beskrivning Värde
actionOnUnmanage Definierar beteendet för resurser som inte längre hanteras när distributionsstacken har uppdaterats eller tagits bort. ActionOnUnmanage (krävs)
bypassStackOutOfSyncError Flagga för att kringgå tjänstfel som anger att stackresurslistan inte är korrekt synkroniserad. boolesk
debugSetting Felsökningsinställningen för distributionen. DeploymentStacksDebugSetting
denySettings Definierar hur resurser som distribueras av stacken är låsta. NekaInställningar (krävs)
deploymentScope Det omfång där den första distributionen ska skapas. Om ett omfång inte har angetts används distributionsstackens omfång som standard. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). sträng
beskrivning Beskrivning av distributionsstack. Maximal längd på 4 096 tecken. sträng

Begränsningar:
Maximal längd = 4096
fel Felinformationen. ErrorDetail
parametrar Namn- och värdepar som definierar distributionsparametrarna för mallen. Använd det här elementet när du anger parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStackPropertiesParameters
parametersLink URI för parameterfilen. Använd det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStacksParametersLink
mall Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
templateLink URI:n för mallen. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda. DeploymentStacksTemplateLink

ActionOnUnmanage

Name Beskrivning Värde
managementGroups Anger en åtgärd för en nyligen ohanterad resurs. Ta bort försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resourceGroups Anger en åtgärd för en nyligen ohanterad resurs. Ta bort försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resources Anger en åtgärd för en nyligen ohanterad resurs. Ta bort försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från" (krävs)

DeploymentStacksDebugSetting

Name Beskrivning Värde
detailLevel Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. När du anger det här värdet bör du noga överväga vilken typ av information som skickas under distributionen. Genom att logga information om begäran eller svaret kan känsliga data som hämtas via distributionsåtgärderna potentiellt exponeras. sträng

NekaInställningar

Name Beskrivning Värde
applyToChildScopes DenySettings tillämpas på underordnade resursomfång för varje hanterad resurs med en nekande tilldelning. boolesk
excludedActions Lista över rollbaserade hanteringsåtgärder som undantas från denySettings. Upp till 200 åtgärder är tillåtna. Om läget denySetting är inställt på "denyWriteAndDelete" läggs följande åtgärder automatiskt till i "excludedActions": "*/read" och "Microsoft.Authorization/locks/delete". Om nekaInställningsläget är inställt på "denyDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamns-ID:t som är undantagna från låset. Upp till 5 huvudkonton är tillåtna. string[]
mode denySettings Mode som definierar nekade åtgärder. "denyDelete"
"denyWriteAndDelete"
"ingen" (krävs)

ErrorDetail

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

DeploymentStackPropertiesParameters

Name Beskrivning Värde
{anpassad egenskap} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

Name Beskrivning Värde
Referens Parameterreferens för Azure Key Vault. KeyVaultParameterReferenceAutoGenerated
typ Typ av värde. sträng
värde Indatavärde till parametern.

KeyVaultParameterReferenceAutoGenerated

Name Beskrivning Värde
keyVault Referens för Azure Key Vault. KeyVaultReferenceAutoGenerated (krävs)
secretName Azure Key Vault hemligt namn. sträng (krävs)
secretVersion Azure Key Vault hemliga versionen. sträng

KeyVaultReferenceAutoGenerated

Name Beskrivning Värde
id Azure Key Vault resourceId. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
Uri URI för parameterfilen. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
id ResourceId för en mallspecifikation. Använd antingen ID- eller URI-egenskapen, men inte båda. sträng
Querystring Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n. sträng
relativePath Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar detta till en artefakt i TemplateSpec. Om den överordnade var länkad med en URI är den underordnade distributionen en kombination av de överordnade och relativePath-URI:erna. sträng
Uri URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen deploymentStacks kan distribueras med åtgärder som mål:

  • Hanteringsgrupper
  • Prenumerationer
  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Resources/deploymentStacks-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deploymentStacks@2024-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actionOnUnmanage = {
        managementGroups = "string"
        resourceGroups = "string"
        resources = "string"
      }
      bypassStackOutOfSyncError = bool
      debugSetting = {
        detailLevel = "string"
      }
      denySettings = {
        applyToChildScopes = bool
        excludedActions = [
          "string"
        ]
        excludedPrincipals = [
          "string"
        ]
        mode = "string"
      }
      deploymentScope = "string"
      description = "string"
      error = {}
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          type = "string"
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

Egenskapsvärden

deploymentStacks

Name Beskrivning Värde
typ Resurstypen "Microsoft.Resources/deploymentStacks@2024-03-01"
name Resursnamnet sträng (krävs)
location Platsen för distributionsstacken. Det går inte att ändra den när den har skapats. Det måste vara en av de Azure-platser som stöds. sträng
parent_id Om du vill distribuera till en hanteringsgrupp använder du ID:t för den hanteringsgruppen. Om du vill distribuera till en prenumeration använder du ID:t för den prenumerationen. Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar för distributionsstacken. Ordlista med taggnamn och värden.
properties Egenskaper för distributionsstack. DeploymentStackProperties

DeploymentStackProperties

Name Beskrivning Värde
actionOnUnmanage Definierar beteendet för resurser som inte längre hanteras när distributionsstacken har uppdaterats eller tagits bort. ActionOnUnmanage (krävs)
bypassStackOutOfSyncError Flagga för att kringgå tjänstfel som anger att stackresurslistan inte är korrekt synkroniserad. boolesk
debugSetting Felsökningsinställningen för distributionen. DeploymentStacksDebugSetting
denySettings Definierar hur resurser som distribueras av stacken låses. NekaInställningar (krävs)
deploymentScope Det omfång där den första distributionen ska skapas. Om inget omfång har angetts används distributionsstackens omfång som standard. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). sträng
beskrivning Beskrivning av distributionsstack. Maxlängd på 4 096 tecken. sträng

Begränsningar:
Maxlängd = 4096
fel Felinformationen. ErrorDetail
parametrar Namn- och värdepar som definierar distributionsparametrarna för mallen. Använd det här elementet när du anger parametervärdena direkt i begäran, i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStackPropertiesParameters
parametersLink URI för parameterfilen. Använd det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. DeploymentStacksParametersLink
mall Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformulerad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
templateLink Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda. DeploymentStacksTemplateLink

ActionOnUnmanage

Name Beskrivning Värde
managementGroups Anger en åtgärd för en nyligen ohanterad resurs. Borttagningen försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resourceGroups Anger en åtgärd för en nyligen ohanterad resurs. Borttagningen försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från"
resources Anger en åtgärd för en nyligen ohanterad resurs. Borttagningen försöker ta bort resursen från Azure. Frånkoppling lämnar resursen i aktuellt tillstånd. "ta bort"
"koppla från" (obligatoriskt)

DeploymentStacksDebugSetting

Name Beskrivning Värde
detailLevel Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. När du anger det här värdet bör du noga överväga vilken typ av information som skickas under distributionen. Genom att logga information om begäran eller svaret kan känsliga data som hämtas via distributionsåtgärderna potentiellt exponeras. sträng

NekaInställningar

Name Beskrivning Värde
applyToChildScopes DenySettings tillämpas på underordnade resursomfattningar för varje hanterad resurs med en nekandetilldelning. boolesk
excludedActions Lista över rollbaserade hanteringsåtgärder som undantas från denySettings. Upp till 200 åtgärder är tillåtna. Om läget denySetting är inställt på "denyWriteAndDelete" läggs följande åtgärder automatiskt till i "excludedActions": "*/read" och "Microsoft.Authorization/locks/delete". Om läget denySetting är inställt på "denyDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamns-ID:t som är undantagna från låset. Upp till 5 huvudkonton tillåts. string[]
mode denySettings Mode som definierar nekade åtgärder. "denyDelete"
"denyWriteAndDelete"
"none" (krävs)

ErrorDetail

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

DeploymentStackPropertiesParameters

Name Beskrivning Värde
{anpassad egenskap} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

Name Beskrivning Värde
Referens Parameterreferens för Azure Key Vault. KeyVaultParameterReferenceAutoGenerated
typ Typ av värde. sträng
värde Indatavärde till parametern .

KeyVaultParameterReferenceAutoGenerated

Name Beskrivning Värde
keyVault Referens för Azure Key Vault. KeyVaultReferenceAutoGenerated (krävs)
secretName Azure Key Vault hemligt namn. sträng (krävs)
secretVersion Azure Key Vault hemliga versionen. sträng

KeyVaultReferenceAutoGenerated

Name Beskrivning Värde
id Azure Key Vault resourceId. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
Uri URI för parameterfilen. sträng (krävs)
Name Beskrivning Värde
contentVersion Om den ingår måste den matcha ContentVersion i mallen. sträng
id ResourceId för en mallspecifikation. Använd antingen ID- eller URI-egenskapen, men inte båda. sträng
Querystring Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n. sträng
relativePath Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar detta till en artefakt i TemplateSpec. Om den överordnade var länkad med en URI är den underordnade distributionen en kombination av de överordnade och relativePath-URI:erna. sträng
Uri URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda. sträng