Partager via

Déploiements Microsoft.Resources 2023-07-01

  • Article

Remarques

Pour Bicep, envisagez de à l’aide de modules au lieu de ce type de ressource.

Définition de ressource Bicep

Le type de ressource des déploiements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Resources/deployments, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Resources/deployments@2023-07-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'
  }
}

Valeurs de propriété

DebugSetting

Nom Description Valeur
detailLevel Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées ne sont aucune, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut n’est aucune. Lors de la définition de cette valeur, tenez soigneusement compte du type d’informations que vous transmettez pendant le déploiement. En journalisant des informations sur la demande ou la réponse, vous pouvez potentiellement exposer des données sensibles récupérées par le biais des opérations de déploiement. corde

DeploymentParameter

Nom Description Valeur
référence Informations de référence sur les paramètres Azure Key Vault. KeyVaultParameterReference
valeur Valeur d’entrée du paramètre . quelconque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nom Description Valeur
debugSetting Paramètre de débogage du déploiement. DebugSetting
expressionEvaluationOptions Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe. ExpressionEvaluationOptions
mode Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources. 'Complete'
'Incrémentiel' (obligatoire)
onErrorDeployment Déploiement sur le comportement d’erreur. OnErrorDeploymentOrOnErrorDeploymentExtended
Paramètres Paires nom et valeur qui définissent les paramètres de déploiement du modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la requête plutôt que de lier à un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’une chaîne JSON bien formée ou JObject. DeploymentPropertiesParameters
parametersLink URI du fichier de paramètres. Vous utilisez cet élément pour créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. ParametersLink
modèle Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez transmettre la syntaxe du modèle directement dans la requête plutôt que de lier à un modèle existant. Il peut s’agir d’une chaîne JSON bien formée ou JObject. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. quelconque
templateLink URI du modèle. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. TemplateLink

DeploymentPropertiesParameters

Nom Description Valeur

DeploymentTags

Nom Description Valeur

ExpressionEvaluationOptions

Nom Description Valeur
portée Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. 'Interne'
'NotSpecified'
'Externe'

KeyVaultParameterReference

Nom Description Valeur
keyVault Informations de référence sur Azure Key Vault. keyVaultReference (obligatoire)
secretName Nom du secret Azure Key Vault. chaîne (obligatoire)
secretVersion Version du secret Azure Key Vault. corde

KeyVaultReference

Nom Description Valeur
id ID de ressource Azure Key Vault. chaîne (obligatoire)

Microsoft.Resources/deployments

Nom Description Valeur
emplacement Emplacement où stocker les données de déploiement. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[-\w\._\(\)]+$ (obligatoire)
Propriétés Propriétés de déploiement. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatoire)
portée Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension .
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

OnErrorDeploymentOrOnErrorDeploymentExtended

Nom Description Valeur
deploymentName Déploiement à utiliser dans le cas d’erreur. corde
type Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
URI URI du fichier de paramètres. chaîne (obligatoire)
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
id ID de ressource d’une spécification de modèle. Utilisez l’ID ou la propriété uri, mais pas les deux. corde
queryString Chaîne de requête (par exemple, un jeton SAP) à utiliser avec l’URI templateLink. corde
relativePath La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement par rapport au parent. Si le modèle parent a été lié à un TemplateSpec, il référence un artefact dans templateSpec. Si le parent a été lié à un URI, le déploiement enfant est une combinaison des URI parent et relativePath corde
URI URI du modèle à déployer. Utilisez l’URI ou la propriété ID, mais pas les deux. corde

Définition de ressource de modèle ARM

Le type de ressource des déploiements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Resources/deployments, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2023-07-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"
  }
}

Valeurs de propriété

DebugSetting

Nom Description Valeur
detailLevel Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées ne sont aucune, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut n’est aucune. Lors de la définition de cette valeur, tenez soigneusement compte du type d’informations que vous transmettez pendant le déploiement. En journalisant des informations sur la demande ou la réponse, vous pouvez potentiellement exposer des données sensibles récupérées par le biais des opérations de déploiement. corde

DeploymentParameter

Nom Description Valeur
référence Informations de référence sur les paramètres Azure Key Vault. KeyVaultParameterReference
valeur Valeur d’entrée du paramètre . quelconque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nom Description Valeur
debugSetting Paramètre de débogage du déploiement. DebugSetting
expressionEvaluationOptions Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe. ExpressionEvaluationOptions
mode Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources. 'Complete'
'Incrémentiel' (obligatoire)
onErrorDeployment Déploiement sur le comportement d’erreur. OnErrorDeploymentOrOnErrorDeploymentExtended
Paramètres Paires nom et valeur qui définissent les paramètres de déploiement du modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la requête plutôt que de lier à un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’une chaîne JSON bien formée ou JObject. DeploymentPropertiesParameters
parametersLink URI du fichier de paramètres. Vous utilisez cet élément pour créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. ParametersLink
modèle Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez transmettre la syntaxe du modèle directement dans la requête plutôt que de lier à un modèle existant. Il peut s’agir d’une chaîne JSON bien formée ou JObject. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. quelconque
templateLink URI du modèle. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. TemplateLink

DeploymentPropertiesParameters

Nom Description Valeur

DeploymentTags

Nom Description Valeur

ExpressionEvaluationOptions

Nom Description Valeur
portée Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. 'Interne'
'NotSpecified'
'Externe'

KeyVaultParameterReference

Nom Description Valeur
keyVault Informations de référence sur Azure Key Vault. keyVaultReference (obligatoire)
secretName Nom du secret Azure Key Vault. chaîne (obligatoire)
secretVersion Version du secret Azure Key Vault. corde

KeyVaultReference

Nom Description Valeur
id ID de ressource Azure Key Vault. chaîne (obligatoire)

Microsoft.Resources/deployments

Nom Description Valeur
apiVersion Version de l’API '2023-07-01'
emplacement Emplacement où stocker les données de déploiement. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[-\w\._\(\)]+$ (obligatoire)
Propriétés Propriétés de déploiement. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Resources/deployments'

OnErrorDeploymentOrOnErrorDeploymentExtended

Nom Description Valeur
deploymentName Déploiement à utiliser dans le cas d’erreur. corde
type Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
URI URI du fichier de paramètres. chaîne (obligatoire)
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
id ID de ressource d’une spécification de modèle. Utilisez l’ID ou la propriété uri, mais pas les deux. corde
queryString Chaîne de requête (par exemple, un jeton SAP) à utiliser avec l’URI templateLink. corde
relativePath La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement par rapport au parent. Si le modèle parent a été lié à un TemplateSpec, il référence un artefact dans templateSpec. Si le parent a été lié à un URI, le déploiement enfant est une combinaison des URI parent et relativePath corde
URI URI du modèle à déployer. Utilisez l’URI ou la propriété ID, mais pas les deux. corde

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource des déploiements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Resources/deployments, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2023-07-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"
      }
    }
  })
}

Valeurs de propriété

DebugSetting

Nom Description Valeur
detailLevel Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées ne sont aucune, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut n’est aucune. Lors de la définition de cette valeur, tenez soigneusement compte du type d’informations que vous transmettez pendant le déploiement. En journalisant des informations sur la demande ou la réponse, vous pouvez potentiellement exposer des données sensibles récupérées par le biais des opérations de déploiement. corde

DeploymentParameter

Nom Description Valeur
référence Informations de référence sur les paramètres Azure Key Vault. KeyVaultParameterReference
valeur Valeur d’entrée du paramètre . quelconque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nom Description Valeur
debugSetting Paramètre de débogage du déploiement. DebugSetting
expressionEvaluationOptions Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe. ExpressionEvaluationOptions
mode Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources. 'Complete'
'Incrémentiel' (obligatoire)
onErrorDeployment Déploiement sur le comportement d’erreur. OnErrorDeploymentOrOnErrorDeploymentExtended
Paramètres Paires nom et valeur qui définissent les paramètres de déploiement du modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la requête plutôt que de lier à un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’une chaîne JSON bien formée ou JObject. DeploymentPropertiesParameters
parametersLink URI du fichier de paramètres. Vous utilisez cet élément pour créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. ParametersLink
modèle Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez transmettre la syntaxe du modèle directement dans la requête plutôt que de lier à un modèle existant. Il peut s’agir d’une chaîne JSON bien formée ou JObject. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. quelconque
templateLink URI du modèle. Utilisez la propriété templateLink ou la propriété de modèle, mais pas les deux. TemplateLink

DeploymentPropertiesParameters

Nom Description Valeur

DeploymentTags

Nom Description Valeur

ExpressionEvaluationOptions

Nom Description Valeur
portée Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. 'Interne'
'NotSpecified'
'Externe'

KeyVaultParameterReference

Nom Description Valeur
keyVault Informations de référence sur Azure Key Vault. keyVaultReference (obligatoire)
secretName Nom du secret Azure Key Vault. chaîne (obligatoire)
secretVersion Version du secret Azure Key Vault. corde

KeyVaultReference

Nom Description Valeur
id ID de ressource Azure Key Vault. chaîne (obligatoire)

Microsoft.Resources/deployments

Nom Description Valeur
emplacement Emplacement où stocker les données de déploiement. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[-\w\._\(\)]+$ (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. chaîne (obligatoire)
Propriétés Propriétés de déploiement. DeploymentPropertiesOrDeploymentPropertiesExtended (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Resources/deployments@2023-07-01 »

OnErrorDeploymentOrOnErrorDeploymentExtended

Nom Description Valeur
deploymentName Déploiement à utiliser dans le cas d’erreur. corde
type Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
URI URI du fichier de paramètres. chaîne (obligatoire)
Nom Description Valeur
contentVersion S’il est inclus, doit correspondre à ContentVersion dans le modèle. corde
id ID de ressource d’une spécification de modèle. Utilisez l’ID ou la propriété uri, mais pas les deux. corde
queryString Chaîne de requête (par exemple, un jeton SAP) à utiliser avec l’URI templateLink. corde
relativePath La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement par rapport au parent. Si le modèle parent a été lié à un TemplateSpec, il référence un artefact dans templateSpec. Si le parent a été lié à un URI, le déploiement enfant est une combinaison des URI parent et relativePath corde
URI URI du modèle à déployer. Utilisez l’URI ou la propriété ID, mais pas les deux. corde