Distributioner av Microsoft.Resources

Artikel
12/17/2024

Anmärkningar

För Bicep bör du överväga att använda moduler i stället för den här resurstypen.

Bicep-resursdefinition

Resurstypen distributioner 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/deployments-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Resources/deployments@2024-11-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'
    }
    validationLevel: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

FelsökningInställningar

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

DeploymentParameter

Namn	Beskrivning	Värde
hänvisning	Parameterreferens för Azure Key Vault.	KeyVaultParameterReference
värde	Indatavärde till parametern .	någon

DeploymentPropertiesOrDeploymentPropertiesExtended

Namn	Beskrivning	Värde
debugSetting	Felsökningsinställningen för distributionen.	FelsökningInställningar för
expressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast kapslade mallar. Om det inte anges är standardvärdet yttre.	ExpressionEvaluationOptions
läge	Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.	"Slutfört" "Inkrementell" (krävs)
onErrorDeployment	Distributionen på felbeteende.	OnErrorDeploymentOrOnErrorDeploymentExtended
Parametrar	Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange 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. Det kan vara en JObject- eller en välformulerad JSON-sträng.	DeploymentPropertiesParameters
parametersLink	URI:n för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.	ParametersLink
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.	någon
templateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.	TemplateLink
validationLevel	Valideringsnivån för distributionen	"Provider" "ProviderNoRbac" "Mall"

DeploymentPropertiesParameters

Namn	Beskrivning	Värde

DeploymentTags

Namn	Beskrivning	Värde

ExpressionEvaluationOptions

Namn	Beskrivning	Värde
omfattning	Omfånget som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.	"Inre" "NotSpecified" "Yttre"

KeyVaultParameterReference

Namn	Beskrivning	Värde
keyVault	Azure Key Vault-referens.	KeyVaultReference (krävs)
secretName	Hemligt namn på Azure Key Vault.	sträng (krävs)
secretVersion	Hemlig version av Azure Key Vault.	sträng

KeyVaultReference

Namn	Beskrivning	Värde
Id	Resurs-ID för Azure Key Vault.	sträng (krävs)

Microsoft.Resources/deployments

Namn	Beskrivning	Värde
plats	Platsen där distributionsdata ska lagras.	sträng
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = `^[-\w\._]+$` (krävs)
Egenskaper	Distributionsegenskaperna.	DeploymentPropertiesOrDeploymentPropertiesExtended (krävs)
omfattning	Använd när du skapar en resurs i ett annat omfång än distributionsomfånget.	Ange den här egenskapen till det symboliska namnet på en resurs för att tillämpa -tilläggsresursen.
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

OnErrorDeploymentOrOnErrorDeploymentExtended

Namn	Beskrivning	Värde
deploymentName	Distributionen som ska användas i felfall.	sträng
typ	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Uri	URI:n för parameterfilen.	sträng (krävs)

TemplateLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Id	Resurs-ID:t 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 den till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av överordnade och relativaPath-URI:er	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 distributioner 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/deployments-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2024-11-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"
    },
    "validationLevel": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

FelsökningInställningar

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

DeploymentParameter

Namn	Beskrivning	Värde
hänvisning	Parameterreferens för Azure Key Vault.	KeyVaultParameterReference
värde	Indatavärde till parametern .	någon

DeploymentPropertiesOrDeploymentPropertiesExtended

Namn	Beskrivning	Värde
debugSetting	Felsökningsinställningen för distributionen.	FelsökningInställningar för
expressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast kapslade mallar. Om det inte anges är standardvärdet yttre.	ExpressionEvaluationOptions
läge	Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.	"Slutfört" "Inkrementell" (krävs)
onErrorDeployment	Distributionen på felbeteende.	OnErrorDeploymentOrOnErrorDeploymentExtended
Parametrar	Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange 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. Det kan vara en JObject- eller en välformulerad JSON-sträng.	DeploymentPropertiesParameters
parametersLink	URI:n för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.	ParametersLink
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.	någon
templateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.	TemplateLink
validationLevel	Valideringsnivån för distributionen	"Provider" "ProviderNoRbac" "Mall"

DeploymentPropertiesParameters

Namn	Beskrivning	Värde

DeploymentTags

Namn	Beskrivning	Värde

ExpressionEvaluationOptions

Namn	Beskrivning	Värde
omfattning	Omfånget som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.	"Inre" "NotSpecified" "Yttre"

KeyVaultParameterReference

Namn	Beskrivning	Värde
keyVault	Azure Key Vault-referens.	KeyVaultReference (krävs)
secretName	Hemligt namn på Azure Key Vault.	sträng (krävs)
secretVersion	Hemlig version av Azure Key Vault.	sträng

KeyVaultReference

Namn	Beskrivning	Värde
Id	Resurs-ID för Azure Key Vault.	sträng (krävs)

Microsoft.Resources/deployments

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2024-11-01'
plats	Platsen där distributionsdata ska lagras.	sträng
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = `^[-\w\._]+$` (krävs)
Egenskaper	Distributionsegenskaperna.	DeploymentPropertiesOrDeploymentPropertiesExtended (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.Resources/deployments"

OnErrorDeploymentOrOnErrorDeploymentExtended

Namn	Beskrivning	Värde
deploymentName	Distributionen som ska användas i felfall.	sträng
typ	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Uri	URI:n för parameterfilen.	sträng (krävs)

TemplateLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Id	Resurs-ID:t 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 den till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av överordnade och relativaPath-URI:er	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 distributioner 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/deployments-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2024-11-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"
      }
      validationLevel = "string"
    }
  })
}

Egenskapsvärden

FelsökningInställningar

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

DeploymentParameter

Namn	Beskrivning	Värde
hänvisning	Parameterreferens för Azure Key Vault.	KeyVaultParameterReference
värde	Indatavärde till parametern .	någon

DeploymentPropertiesOrDeploymentPropertiesExtended

Namn	Beskrivning	Värde
debugSetting	Felsökningsinställningen för distributionen.	FelsökningInställningar för
expressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast kapslade mallar. Om det inte anges är standardvärdet yttre.	ExpressionEvaluationOptions
läge	Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.	"Slutfört" "Inkrementell" (krävs)
onErrorDeployment	Distributionen på felbeteende.	OnErrorDeploymentOrOnErrorDeploymentExtended
Parametrar	Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange 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. Det kan vara en JObject- eller en välformulerad JSON-sträng.	DeploymentPropertiesParameters
parametersLink	URI:n för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.	ParametersLink
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.	någon
templateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.	TemplateLink
validationLevel	Valideringsnivån för distributionen	"Provider" "ProviderNoRbac" "Mall"

DeploymentPropertiesParameters

Namn	Beskrivning	Värde

DeploymentTags

Namn	Beskrivning	Värde

ExpressionEvaluationOptions

Namn	Beskrivning	Värde
omfattning	Omfånget som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.	"Inre" "NotSpecified" "Yttre"

KeyVaultParameterReference

Namn	Beskrivning	Värde
keyVault	Azure Key Vault-referens.	KeyVaultReference (krävs)
secretName	Hemligt namn på Azure Key Vault.	sträng (krävs)
secretVersion	Hemlig version av Azure Key Vault.	sträng

KeyVaultReference

Namn	Beskrivning	Värde
Id	Resurs-ID för Azure Key Vault.	sträng (krävs)

Microsoft.Resources/deployments

Namn	Beskrivning	Värde
plats	Platsen där distributionsdata ska lagras.	sträng
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = `^[-\w\._]+$` (krävs)
parent_id	ID:t för resursen som den här tilläggsresursen ska tillämpas på.	sträng (krävs)
Egenskaper	Distributionsegenskaperna.	DeploymentPropertiesOrDeploymentPropertiesExtended (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.Resources/deployments@2024-11-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Namn	Beskrivning	Värde
deploymentName	Distributionen som ska användas i felfall.	sträng
typ	Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Uri	URI:n för parameterfilen.	sträng (krävs)

TemplateLink

Namn	Beskrivning	Värde
contentVersion	Om det ingår måste det matcha ContentVersion i mallen.	sträng
Id	Resurs-ID:t 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 den till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av överordnade och relativaPath-URI:er	sträng
Uri	URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.	sträng

Dela via

Distributioner av Microsoft.Resources

Anmärkningar

Bicep-resursdefinition

Resursformat

Egenskapsvärden

FelsökningInställningar

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

FelsökningInställningar

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

FelsökningInställningar

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

Feedback

Ytterligare resurser