Partager via


Blueprints Microsoft.Blueprint

Définition de ressource Bicep

Le type de ressource blueprints 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.Blueprint/blueprints, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Blueprint/blueprints@2018-11-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        metadata: {
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        type: 'string'
      }
    }
    resourceGroups: {
      {customized property}: {
        dependsOn: [
          'string'
        ]
        location: 'string'
        metadata: {
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        name: 'string'
        tags: {
          {customized property}: 'string'
        }
      }
    }
    targetScope: 'string'
    versions: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

Valeurs de propriété

BlueprintProperties

Nom Description Valeur
description Les lignes multiples expliquent cette ressource. corde

Contraintes:
Longueur maximale =
displayName La chaîne d’un liner explique cette ressource. corde

Contraintes:
Longueur maximale =
Paramètres Paramètres requis par cette définition de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaces réservés de groupe de ressources définis par cette définition de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope Étendue dans laquelle cette définition de blueprint peut être affectée. 'managementGroup'
'abonnement'
Versions Versions publiées de cette définition de blueprint. quelconque

Microsoft.Blueprint/blueprints

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés détaillées pour la définition de blueprint. BlueprintProperties (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 .

ParameterDefinition

Nom Description Valeur
allowedValues Tableau de valeurs autorisées pour ce paramètre. any[]
defaultValue Valeur par défaut pour ce paramètre. quelconque
métadonnées Propriétés conviviales pour ce paramètre. ParameterDefinitionMetadata
type Types de données autorisés pour les paramètres de modèle Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obligatoire)

ParameterDefinitionMetadata

Nom Description Valeur
description Description de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
displayName DisplayName de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
strongType StrongType pour l’interface utilisateur afin d’afficher une expérience riche pendant l’affectation du blueprint. Les types forts pris en charge sont resourceType, principalId et emplacement. corde

Contraintes:
Longueur maximale =

ResourceGroupDefinition

Nom Description Valeur
dependsOn Artefacts qui doivent être déployés avant ce groupe de ressources. string[]
emplacement Emplacement de ce groupe de ressources. Laissez vide si l’emplacement du groupe de ressources sera spécifié pendant l’affectation du blueprint. corde
métadonnées Propriétés conviviales pour ce groupe de ressources. ParameterDefinitionMetadata
nom Nom de ce groupe de ressources. Laissez vide si le nom du groupe de ressources est spécifié pendant l’affectation du blueprint. corde
étiquettes Balises à affecter à ce groupe de ressources. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nom Description Valeur

SharedBlueprintPropertiesParameters

Nom Description Valeur

SharedBlueprintPropertiesResourceGroups

Nom Description Valeur

Définition de ressource de modèle ARM

Le type de ressource blueprints 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.Blueprint/blueprints, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Blueprint/blueprints",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "type": "string"
      }
    },
    "resourceGroups": {
      "{customized property}": {
        "dependsOn": [ "string" ],
        "location": "string",
        "metadata": {
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "name": "string",
        "tags": {
          "{customized property}": "string"
        }
      }
    },
    "targetScope": "string",
    "versions": {}
  }
}

Valeurs de propriété

BlueprintProperties

Nom Description Valeur
description Les lignes multiples expliquent cette ressource. corde

Contraintes:
Longueur maximale =
displayName La chaîne d’un liner explique cette ressource. corde

Contraintes:
Longueur maximale =
Paramètres Paramètres requis par cette définition de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaces réservés de groupe de ressources définis par cette définition de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope Étendue dans laquelle cette définition de blueprint peut être affectée. 'managementGroup'
'abonnement'
Versions Versions publiées de cette définition de blueprint. quelconque

Microsoft.Blueprint/blueprints

Nom Description Valeur
apiVersion Version de l’API '2018-11-01-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés détaillées pour la définition de blueprint. BlueprintProperties (obligatoire)
type Type de ressource 'Microsoft.Blueprint/blueprints'

ParameterDefinition

Nom Description Valeur
allowedValues Tableau de valeurs autorisées pour ce paramètre. any[]
defaultValue Valeur par défaut pour ce paramètre. quelconque
métadonnées Propriétés conviviales pour ce paramètre. ParameterDefinitionMetadata
type Types de données autorisés pour les paramètres de modèle Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obligatoire)

ParameterDefinitionMetadata

Nom Description Valeur
description Description de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
displayName DisplayName de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
strongType StrongType pour l’interface utilisateur afin d’afficher une expérience riche pendant l’affectation du blueprint. Les types forts pris en charge sont resourceType, principalId et emplacement. corde

Contraintes:
Longueur maximale =

ResourceGroupDefinition

Nom Description Valeur
dependsOn Artefacts qui doivent être déployés avant ce groupe de ressources. string[]
emplacement Emplacement de ce groupe de ressources. Laissez vide si l’emplacement du groupe de ressources sera spécifié pendant l’affectation du blueprint. corde
métadonnées Propriétés conviviales pour ce groupe de ressources. ParameterDefinitionMetadata
nom Nom de ce groupe de ressources. Laissez vide si le nom du groupe de ressources est spécifié pendant l’affectation du blueprint. corde
étiquettes Balises à affecter à ce groupe de ressources. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nom Description Valeur

SharedBlueprintPropertiesParameters

Nom Description Valeur

SharedBlueprintPropertiesResourceGroups

Nom Description Valeur

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
blueprints - Créer une définition de blueprint

Déployer sur Azure
Ce modèle crée une définition de blueprint Azure Blueprint. La définition de blueprint inclut un artefact d’attribution de stratégie et peut être modifiée, puis déployée sur des groupes d’administration ou des abonnements pour des environnements cohérents.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource blueprints 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.Blueprint/blueprints, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      resourceGroups = {
        {customized property} = {
          dependsOn = [
            "string"
          ]
          location = "string"
          metadata = {
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          name = "string"
          tags = {
            {customized property} = "string"
          }
        }
      }
      targetScope = "string"
      versions = ?
    }
  })
}

Valeurs de propriété

BlueprintProperties

Nom Description Valeur
description Les lignes multiples expliquent cette ressource. corde

Contraintes:
Longueur maximale =
displayName La chaîne d’un liner explique cette ressource. corde

Contraintes:
Longueur maximale =
Paramètres Paramètres requis par cette définition de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaces réservés de groupe de ressources définis par cette définition de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope Étendue dans laquelle cette définition de blueprint peut être affectée. 'managementGroup'
'abonnement'
Versions Versions publiées de cette définition de blueprint. quelconque

Microsoft.Blueprint/blueprints

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. chaîne (obligatoire)
Propriétés Propriétés détaillées pour la définition de blueprint. BlueprintProperties (obligatoire)
type Type de ressource « Microsoft.Blueprint/blueprints@2018-11-01-preview »

ParameterDefinition

Nom Description Valeur
allowedValues Tableau de valeurs autorisées pour ce paramètre. any[]
defaultValue Valeur par défaut pour ce paramètre. quelconque
métadonnées Propriétés conviviales pour ce paramètre. ParameterDefinitionMetadata
type Types de données autorisés pour les paramètres de modèle Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obligatoire)

ParameterDefinitionMetadata

Nom Description Valeur
description Description de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
displayName DisplayName de ce paramètre/resourceGroup. corde

Contraintes:
Longueur maximale =
strongType StrongType pour l’interface utilisateur afin d’afficher une expérience riche pendant l’affectation du blueprint. Les types forts pris en charge sont resourceType, principalId et emplacement. corde

Contraintes:
Longueur maximale =

ResourceGroupDefinition

Nom Description Valeur
dependsOn Artefacts qui doivent être déployés avant ce groupe de ressources. string[]
emplacement Emplacement de ce groupe de ressources. Laissez vide si l’emplacement du groupe de ressources sera spécifié pendant l’affectation du blueprint. corde
métadonnées Propriétés conviviales pour ce groupe de ressources. ParameterDefinitionMetadata
nom Nom de ce groupe de ressources. Laissez vide si le nom du groupe de ressources est spécifié pendant l’affectation du blueprint. corde
étiquettes Balises à affecter à ce groupe de ressources. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nom Description Valeur

SharedBlueprintPropertiesParameters

Nom Description Valeur

SharedBlueprintPropertiesResourceGroups

Nom Description Valeur