Assignments - Create Or Update

Créez ou mettez à jour une affectation de blueprint.

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

Paramètres URI

Name In Required Type Description
assignmentName
path True
  • string

Nom de l’affectation de 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
identity True

Identité managée pour cette affectation de blueprint.

location True
  • string

Emplacement de cette affectation de blueprint.

properties.parameters True

Valeurs des paramètres d’affectation de blueprint.

properties.resourceGroups True

Noms et emplacements des espaces réservés de groupe de ressources.

properties.blueprintId
  • string

ID de la version publiée d’une définition de blueprint.

properties.description
  • string

Plusieurs lignes expliquent cette ressource.

properties.displayName
  • string

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

properties.locks

Définit la façon dont les ressources déployées par une affectation de blueprint sont verrouillées.

properties.scope
  • string

Étendue de l’abonnement cible de l’affectation de blueprint (format : « /subscriptions/{subscriptionId} »). Pour les affectations au niveau du groupe d’administration, la propriété est requise.

Réponses

Name Type Description
201 Created

Créé :- affectation 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

Assignment with system-assigned managed identity at management group scope
Assignment with system-assigned managed identity at subscription scope
Assignment with user-assigned managed identity at management group scope
Assignment with user-assigned managed identity at subscription scope

Assignment with system-assigned managed identity at management group scope

Sample Request

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Sample Response

{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with system-assigned managed identity at subscription scope

Sample Request

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Sample Response

{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at management group scope

Sample Request

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Sample Response

{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at subscription scope

Sample Request

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Sample Response

{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Définitions

Assignment

Représente une affectation de blueprint.

AssignmentLockMode

Mode de verrouillage.

AssignmentLockSettings

Définit la façon dont les ressources déployées par une affectation de blueprint sont verrouillées.

AssignmentProvisioningState

État de l’affectation de blueprint.

AssignmentStatus

État d’une affectation de blueprint. Ce champ est lu en lecture seule.

CloudError
ErrorAdditionalInfo

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

ErrorResponse

Réponse d’erreur

keyVaultReference

Spécifie le lien vers un Key Vault.

ManagedServiceIdentity

Objet générique d’identité managée.

ManagedServiceIdentityType

Type de l’identité managée.

ParameterValue

Valeur du paramètre spécifié. Peut être « value » ou « reference », mais pas les deux.

ResourceGroupValue

Représente un groupe de ressources Azure.

SecretValueReference

Référence à un secret Key Vault.

UserAssignedIdentity

Identité managée affectée par l’utilisateur.

Assignment

Représente une affectation de blueprint.

Name Type Description
id
  • string

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

identity

Identité managée pour cette affectation de blueprint.

location
  • string

Emplacement de cette affectation de blueprint.

name
  • string

Nom de cette ressource.

properties.blueprintId
  • string

ID de la version publiée d’une définition de blueprint.

properties.description
  • string

Plusieurs lignes expliquent cette ressource.

properties.displayName
  • string

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

properties.locks

Définit la façon dont les ressources déployées par une affectation de blueprint sont verrouillées.

properties.parameters

Valeurs des paramètres d’affectation de blueprint.

properties.provisioningState

État de l’affectation de blueprint.

properties.resourceGroups

Noms et emplacements des espaces réservés de groupe de ressources.

properties.scope
  • string

Étendue de l’abonnement cible de l’affectation de blueprint (format : « /subscriptions/{subscriptionId} »). Pour les affectations au niveau du groupe d’administration, la propriété est requise.

properties.status

État de l’affectation de blueprint. Ce champ est lu en lecture seule.

type
  • string

Type de cette ressource.

AssignmentLockMode

Mode de verrouillage.

Name Type Description
AllResourcesDoNotDelete
  • string
AllResourcesReadOnly
  • string
None
  • string

AssignmentLockSettings

Définit la façon dont les ressources déployées par une affectation de blueprint sont verrouillées.

Name Type Description
excludedActions
  • string[]

Liste des opérations de gestion exclues des verrous de blueprint. Jusqu’à 200 actions sont autorisées. Si le mode de verrouillage est défini sur « AllResourcesReadOnly », les actions suivantes sont automatiquement ajoutées à « excludedActions » : « */read », « Microsoft.Network/virtualNetworks/subnets/join/action » et « Microsoft.Authorization/locks/delete ». Si le mode de verrouillage est défini sur « AllResourcesDoNotDelete », les actions suivantes sont automatiquement ajoutées à « excludedActions » : « Microsoft.Authorization/locks/delete ». Les actions en double sont supprimées.

excludedPrincipals
  • string[]

Liste des principaux AAD exclus des verrous de blueprint. Jusqu’à 5 principaux sont autorisés.

mode

Mode de verrouillage.

AssignmentProvisioningState

État de l’affectation de blueprint.

Name Type Description
canceled
  • string
cancelling
  • string
creating
  • string
deleting
  • string
deploying
  • string
failed
  • string
locking
  • string
succeeded
  • string
validating
  • string
waiting
  • string

AssignmentStatus

État d’une affectation de blueprint. Ce champ est lu en lecture seule.

Name Type Description
lastModified
  • string

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

managedResources
  • string[]

Liste des ressources créées par l’affectation de blueprint.

timeCreated
  • string

Heure de création de cette définition de 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.

keyVaultReference

Spécifie le lien vers un Key Vault.

Name Type Description
id
  • string

ID de ressource Azure du Key Vault.

ManagedServiceIdentity

Objet générique d’identité managée.

Name Type Description
principalId
  • string

Azure Active Directory ID de principal associé à cette identité.

tenantId
  • string

ID du Azure Active Directory.

type

Type de l’identité managée.

userAssignedIdentities

Liste des identités managées affectées par l’utilisateur associées à la ressource. La clé est l’ID de ressource Azure de l’identité managée.

ManagedServiceIdentityType

Type de l’identité managée.

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

ParameterValue

Valeur du paramètre spécifié. Peut être « value » ou « reference », mais pas les deux.

Name Type Description
reference

Valeur de paramètre en tant que type 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.

ResourceGroupValue

Représente un groupe de ressources Azure.

Name Type Description
location
  • string

Emplacement du groupe de ressources.

name
  • string

Nom du groupe de ressources.

SecretValueReference

Référence à un secret Key Vault.

Name Type Description
keyVault

Spécifie la référence à un Key Vault 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.

UserAssignedIdentity

Identité managée affectée par l’utilisateur.

Name Type Description
clientId
  • string

ID d’application client associé à cette identité.

principalId
  • string

Azure Active Directory ID de principal associé à cette identité.