Blueprints - Create Or Update

Créez ou mettez à jour une définition de blueprint.

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}?api-version=2018-11-01-preview

Paramètres URI

Name In Required Type Description
blueprintName
path True
  • string

Nom de la définition du blueprint.

resourceScope
path True
  • string

Portée de la ressource. Les étendues valides sont les suivantes : groupe d’administration (format : « /providers/Microsoft.Management/managementGroups/{managementGroup} »), abonnement (format : « /subscriptions/{subscriptionId} »).

api-version
query True
  • string

Version de l’API cliente.

Corps de la demande

Name Required Type Description
properties.targetScope True

Étendue dans laquelle cette définition de blueprint peut être affectée.

description
  • string

Plusieurs lignes expliquent cette ressource.

displayName
  • string

La chaîne d’un trait explique cette ressource.

properties.parameters

Paramètres requis par cette définition de blueprint.

properties.resourceGroups

Espaces réservés de groupe de ressources définis par cette définition de blueprint.

properties.versions
  • object

Versions publiées de cette définition de blueprint.

Réponses

Name Type Description
201 Created

Créé -- définition de blueprint enregistrée.

Other Status Codes

Réponse d’erreur blueprints.

Sécurité

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ManagementGroupBlueprint
ResourceGroupWithTags
SubscriptionBlueprint

ManagementGroupBlueprint

Sample Request

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  }
}

Sample Response

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

ResourceGroupWithTags

Sample Request

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{ManagementGroupId}/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "targetScope": "subscription",
    "resourceGroups": {
      "myRGName": {
        "name": "myRGName",
        "location": "westus",
        "metadata": {
          "displayName": "My Resource Group"
        },
        "tags": {
          "costcenter": "123456",
          "nameOnlyTag": ""
        }
      }
    },
    "description": "An example blueprint containing an RG with two tags."
  }
}

Sample Response

{
  "properties": {
    "parameters": {},
    "resourceGroups": {
      "myRGName": {
        "name": "myRGName",
        "location": "westus",
        "metadata": {
          "displayName": "My Resource Group"
        },
        "dependsOn": [],
        "tags": {
          "costcenter": "123456",
          "tagWithNoValue": ""
        }
      }
    },
    "targetScope": "subscription",
    "status": {
      "timeCreated": "2019-04-29T20:52:56+00:00",
      "lastModified": "2019-04-29T20:52:56+00:00"
    },
    "description": "An example blueprint containing an RG with two tags."
  },
  "id": "/providers/Microsoft.Management/managementGroups/{ManagementGroupId}/providers/Microsoft.Blueprint/blueprints/RGTaggingExample",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "RGTaggingExample"
}

SubscriptionBlueprint

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  }
}

Sample Response

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

Définitions

Blueprint

Représente une définition de blueprint.

BlueprintStatus

État du blueprint. Ce champ est lu en lecture seule.

BlueprintTargetScope

Étendue dans laquelle cette définition de blueprint peut être affectée.

CloudError
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorResponse

Réponse d’erreur

ParameterDefinition

Représente un paramètre avec des contraintes et des métadonnées.

ResourceGroupDefinition

Représente un groupe de ressources Azure dans une définition de blueprint.

TemplateParameterType

Types de données autorisés pour Resource Manager paramètres de modèle.

Blueprint

Représente une définition de blueprint.

Name Type Description
description
  • string

Plusieurs lignes expliquent cette ressource.

displayName
  • string

La chaîne d’un trait explique cette ressource.

id
  • string

ID de chaîne utilisé pour localiser n’importe quelle ressource sur Azure.

name
  • string

Nom de cette ressource.

properties.layout
  • object

Vue de disposition de la définition de blueprint pour référence de l’interface utilisateur.

properties.parameters

Paramètres requis par cette définition de blueprint.

properties.resourceGroups

Espaces réservés de groupe de ressources définis par cette définition de blueprint.

properties.status

État du blueprint. Ce champ est lu en lecture seule.

properties.targetScope

Étendue dans laquelle cette définition de blueprint peut être affectée.

properties.versions
  • object

Versions publiées de cette définition de blueprint.

type
  • string

Type de cette ressource.

BlueprintStatus

État du blueprint. Ce champ est lu en lecture seule.

Name Type Description
lastModified
  • string

Heure de dernière modification de cette définition de blueprint.

timeCreated
  • string

Heure de création de cette définition de blueprint.

BlueprintTargetScope

Étendue dans laquelle cette définition de blueprint peut être affectée.

Name Type Description
managementGroup
  • string

Le blueprint cible un groupe d’administration pendant l’affectation du blueprint. Ceci est réservé pour une utilisation ultérieure.

subscription
  • string

Le blueprint cible un abonnement pendant l’affectation du blueprint.

CloudError

Name Type Description
error

Réponse d’erreur
Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaire.

ErrorResponse

Réponse d’erreur

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

ParameterDefinition

Représente un paramètre avec des contraintes et des métadonnées.

Name Type Description
allowedValues
  • AllowedValues[]

Tableau de valeurs autorisées pour ce paramètre.

defaultValue

Valeur par défaut pour ce paramètre.

metadata.description
  • string

Description de ce paramètre/resourceGroup.

metadata.displayName
  • string

DisplayName de ce paramètre/resourceGroup.

metadata.strongType
  • string

StrongType pour l’interface utilisateur afin d’afficher une expérience enrichie pendant l’affectation du blueprint. Les types forts pris en charge sont resourceType, principalId et emplacement.

type

Types de données autorisés pour Resource Manager paramètres de modèle.

ResourceGroupDefinition

Représente un groupe de ressources Azure dans une définition de blueprint.

Name Type Description
dependsOn
  • string[]

Artifacts qui doivent être déployées avant ce groupe de ressources.

location
  • string

Emplacement de ce groupe de ressources. Laissez vide si l’emplacement du groupe de ressources est spécifié pendant l’affectation du blueprint.

metadata.description
  • string

Description de ce paramètre/resourceGroup.

metadata.displayName
  • string

DisplayName de ce paramètre/resourceGroup.

metadata.strongType
  • string

StrongType pour l’interface utilisateur afin d’afficher une expérience enrichie pendant l’affectation du blueprint. Les types forts pris en charge sont resourceType, principalId et emplacement.

name
  • string

Nom de ce groupe de ressources. Laissez vide si le nom du groupe de ressources est spécifié pendant l’affectation du blueprint.

tags
  • object

Balises à affecter à ce groupe de ressources.

TemplateParameterType

Types de données autorisés pour Resource Manager paramètres de modèle.

Name Type Description
array
  • string
bool
  • string
int
  • string
object
  • string
secureObject
  • string
secureString
  • string
string
  • string