Artifacts - Create Or Update

Service:
Blueprints
Version d'API:
2018-11-01-preview

Créez ou mettez à jour un artefact de blueprint.

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

Paramètres URI

Nom Dans Obligatoire Type Description
artifactName
 path True

string

Nom de l’artefact de blueprint.
blueprintName
 path True

string

Nom de la définition du blueprint.
resourceScope
 path True

string

Étendue 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

Le corps de la requête peut être l’un des suivants :

Nom Description
PolicyAssignmentArtifact

Artefact de blueprint qui applique une attribution de stratégie.
RoleAssignmentArtifact

Artefact de blueprint qui applique une attribution de rôle.
TemplateArtifact

Artefact de blueprint qui déploie un modèle Resource Manager.

PolicyAssignmentArtifact

Artefact de blueprint qui applique une attribution de stratégie.

Nom Obligatoire Type Description
kind True string:

policyAssignment

Spécifie le type d’artefact de blueprint.
properties.parameters True

<string,  ParameterValue>

Valeurs de paramètre pour la définition de stratégie.
properties.policyDefinitionId True

string

ID de ressource Azure de la définition de stratégie.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.resourceGroup

string

Nom de l’espace réservé du groupe de ressources auquel la stratégie sera affectée.

RoleAssignmentArtifact

Artefact de blueprint qui applique une attribution de rôle.

Nom Obligatoire Type Description
kind True string:

roleAssignment

Spécifie le type d’artefact de blueprint.
properties.principalIds True

Tableau d’identités d’utilisateur ou de groupe dans Azure Active Directory. RoleDefinition s’applique à chaque identité.
properties.roleDefinitionId True

string

ID de ressource Azure de RoleDefinition.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.resourceGroup

string

RoleAssignment sera étendue à ce groupe de ressources. S’il est vide, il s’étend à l’abonnement.

TemplateArtifact

Artefact de blueprint qui déploie un modèle Resource Manager.

Nom Obligatoire Type Description
kind True string:

template

Spécifie le type d’artefact de blueprint.
properties.parameters True

<string,  ParameterValue>

Valeurs des paramètres d’artefact de blueprint du modèle Resource Manager.
properties.template True

object

Corps de l’artefact de blueprint du modèle Resource Manager.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.resourceGroup

string

Le cas échéant, le nom de l’espace réservé du groupe de ressources sur lequel l’artefact de blueprint du modèle Resource Manager sera déployé.

Réponses

Nom Type Description
201 Created Artifact:

Créé :- artefact de blueprint créé/mis à jour.
Other Status Codes

CloudError

Réponse d’erreur blueprints.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

MG-ARMTemplateArtifact
MG-PolicyAssignmentArtifact
MG-RoleAssignmentArtifact
Sub-ARMTemplateArtifact
Sub-PolicyAssignmentArtifact
Sub-RoleAssignmentArtifact

MG-ARMTemplateArtifact

Exemple de requête

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

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

MG-PolicyAssignmentArtifact

Exemple de requête

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

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

MG-RoleAssignmentArtifact

Exemple de requête

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

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Sub-ARMTemplateArtifact

Exemple de requête

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

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

Sub-PolicyAssignmentArtifact

Exemple de requête

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

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

Sub-RoleAssignmentArtifact

Exemple de requête

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

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Exemple de réponse

Code d’état:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Définitions

Nom Description
CloudError
ErrorAdditionalInfo

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

Réponse d’erreur
keyVaultReference

Spécifie le lien vers un coffre de clés.
ParameterValue

Valeur du paramètre spécifié. Peut être « valeur » ou « référence », mais pas les deux.
PolicyAssignmentArtifact

Artefact de blueprint qui applique une attribution de stratégie.
RoleAssignmentArtifact

Artefact de blueprint qui applique une attribution de rôle.
SecretValueReference

Référence à un secret Key Vault.
TemplateArtifact

Artefact de blueprint qui déploie un modèle Resource Manager.

CloudError

Object
Nom Type Description
error

ErrorResponse

Réponse d’erreur
Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de 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

Object

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

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorResponse[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

keyVaultReference

Object

Spécifie le lien vers un coffre de clés.

Nom Type Description
id

string

ID de ressource Azure du coffre de clés.

ParameterValue

Object

Valeur du paramètre spécifié. Peut être « valeur » ou « référence », mais pas les deux.

Nom Type Description
reference

SecretValueReference

Valeur de paramètre comme type de référence.
value

object

Valeur du paramètre. Toute valeur JSON valide est autorisée, y compris les objets, les tableaux, les chaînes, les nombres et les booléens.

PolicyAssignmentArtifact

Object

Artefact de blueprint qui applique une attribution de stratégie.

Nom Type Description
id

string

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

policyAssignment

Spécifie le type d’artefact de blueprint.
name

string

Nom de cette ressource.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.parameters

<string,  ParameterValue>

Valeurs de paramètre pour la définition de stratégie.
properties.policyDefinitionId

string

ID de ressource Azure de la définition de stratégie.
properties.resourceGroup

string

Nom de l’espace réservé du groupe de ressources auquel la stratégie sera affectée.
type

string

Type de cette ressource.

RoleAssignmentArtifact

Object

Artefact de blueprint qui applique une attribution de rôle.

Nom Type Description
id

string

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

roleAssignment

Spécifie le type d’artefact de blueprint.
name

string

Nom de cette ressource.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.principalIds

Tableau d’identités d’utilisateur ou de groupe dans Azure Active Directory. RoleDefinition s’applique à chaque identité.
properties.resourceGroup

string

RoleAssignment sera étendue à ce groupe de ressources. S’il est vide, il s’étend à l’abonnement.
properties.roleDefinitionId

string

ID de ressource Azure de RoleDefinition.
type

string

Type de cette ressource.

SecretValueReference

Object

Référence à un secret Key Vault.

Nom Type Description
keyVault

keyVaultReference

Spécifie la référence à un coffre de clés Azure donné.
secretName

string

Nom du secret.
secretVersion

string

Version du secret à utiliser. Si elle est vide, la dernière version du secret est utilisée.

TemplateArtifact

Object

Artefact de blueprint qui déploie un modèle Resource Manager.

Nom Type Description
id

string

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

template

Spécifie le type d’artefact de blueprint.
name

string

Nom de cette ressource.
properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.
properties.description

string

maxLength: 500

Les lignes multiples expliquent cette ressource.
properties.displayName

string

maxLength: 256

La chaîne d’un liner explique cette ressource.
properties.parameters

<string,  ParameterValue>

Valeurs des paramètres d’artefact de blueprint du modèle Resource Manager.
properties.resourceGroup

string

Le cas échéant, le nom de l’espace réservé du groupe de ressources sur lequel l’artefact de blueprint du modèle Resource Manager sera déployé.
properties.template

object

Corps de l’artefact de blueprint du modèle Resource Manager.
type

string

Type de cette ressource.