Assignments - Create Or Update

Dienst:: Blueprints

API-Version:: 2018-11-01-preview

Erstellen oder Aktualisieren einer Blaupausenzuweisung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assignmentName	path	True	string	Name der Blueprint-Zuordnung.
resourceScope	path	True	string	Der Bereich der Ressource. Gültige Bereiche sind: Verwaltungsgruppe (Format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), Abonnement (Format: '/subscriptions/{subscriptionId}').
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
identity	True	ManagedServiceIdentity	Verwaltete Identität für diese Blaupausenzuweisung.
location	True	string	Der Speicherort dieser Blaupausenzuweisung.
properties.parameters	True	<string, ParameterValue>	Werte des Blueprint-Zuordnungsparameters.
properties.resourceGroups	True	<string, ResourceGroupValue>	Namen und Speicherorte von Platzhaltern für Ressourcengruppen.
properties.blueprintId		string	ID der veröffentlichten Version einer Blueprintdefinition.
properties.description		string maxLength: 500	Mehrzeilige Erläuterung dieser Ressource.
properties.displayName		string maxLength: 256	Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert.
properties.locks		AssignmentLockSettings	Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden.
properties.scope		string	Der Zielabonnementbereich der Blueprintzuweisung (Format: '/subscriptions/{subscriptionId}'). Für Zuordnungen auf Verwaltungsgruppenebene ist die Eigenschaft erforderlich.

Antworten

Name	Typ	Beschreibung
201 Created	Assignment	Erstellt – Blaupausenzuweisung gespeichert.
Other Status Codes	CloudError	Blueprints-Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispielanforderung

HTTP

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"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "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

Beispielanforderung

HTTP

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"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "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

Beispielanforderung

HTTP

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"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "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

Beispielanforderung

HTTP

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"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "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"
}

Definitionen

Name	Beschreibung
Assignment	Stellt eine Blaupausenzuweisung dar.
AssignmentLockMode	Sperrmodus.
AssignmentLockSettings	Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden.
AssignmentProvisioningState	Status der Blaupausenzuordnung.
AssignmentStatus	Der Status einer Blaupausenzuweisung. Dieses Feld ist schreibgeschützt.
CloudError
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
keyVaultReference	Gibt den Link zu einem Key Vault an.
ManagedServiceIdentity	Generisches Objekt der verwalteten Identität.
ManagedServiceIdentityType	Typ der verwalteten Identität.
ParameterValue	Wert für den angegebenen Parameter. Kann entweder "Wert" oder "Bezug" sein, aber nicht beide.
ResourceGroupValue	Stellt eine Azure-Ressourcengruppe dar.
SecretValueReference	Verweis auf einen Schlüsseltresorschlüssel.
UserAssignedIdentity	Vom Benutzer zugewiesene verwaltete Identität.

Assignment

Objekt

Stellt eine Blaupausenzuweisung dar.

Name	Typ	Beschreibung
id	string	Zeichenfolgen-ID, die verwendet wird, um eine Ressource in Azure zu finden.
identity	ManagedServiceIdentity	Verwaltete Identität für diese Blaupausenzuweisung.
location	string	Der Speicherort dieser Blaupausenzuweisung.
name	string	Name dieser Ressource.
properties.blueprintId	string	ID der veröffentlichten Version einer Blueprintdefinition.
properties.description	string maxLength: 500	Mehrzeilige Erläuterung dieser Ressource.
properties.displayName	string maxLength: 256	Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert.
properties.locks	AssignmentLockSettings	Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden.
properties.parameters	<string, ParameterValue>	Werte des Blueprint-Zuordnungsparameters.
properties.provisioningState	AssignmentProvisioningState	Status der Blaupausenzuordnung.
properties.resourceGroups	<string, ResourceGroupValue>	Namen und Speicherorte von Platzhaltern für Ressourcengruppen.
properties.scope	string	Der Zielabonnementbereich der Blueprintzuweisung (Format: '/subscriptions/{subscriptionId}'). Für Zuordnungen auf Verwaltungsgruppenebene ist die Eigenschaft erforderlich.
properties.status	AssignmentStatus	Status der Blaupausenzuweisung. Dieses Feld ist schreibgeschützt.
type	string	Typ dieser Ressource.

AssignmentLockMode

Enumeration

Sperrmodus.

Wert	Beschreibung
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Objekt

Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden.

Name	Typ	Beschreibung
excludedActions	string[]	Liste der Verwaltungsvorgänge, die von Blueprintsperren ausgeschlossen sind. Bis zu 200 Aktionen sind zulässig. Wenn der Sperrmodus auf "AllResourcesReadOnly" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" und "Microsoft.Authorization/locks/delete". Wenn der Sperrmodus auf "AllResourcesDoNotDelete" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "Microsoft.Authorization/locks/delete". Doppelte Aktionen werden entfernt.
excludedPrincipals	string[]	Liste der AAD-Prinzipale, die von Blueprintsperren ausgeschlossen sind. Bis zu 5 Prinzipale sind zulässig.
mode	AssignmentLockMode	Sperrmodus.

AssignmentProvisioningState

Enumeration

Status der Blaupausenzuordnung.

Wert	Beschreibung
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Objekt

Der Status einer Blaupausenzuweisung. Dieses Feld ist schreibgeschützt.

Name	Typ	Beschreibung
lastModified	string (date-time)	Zeitpunkt der letzten Änderung dieser Blueprintdefinition.
managedResources	string[]	Liste der Ressourcen, die von der Blueprintzuordnung erstellt wurden.
timeCreated	string (date-time)	Erstellungszeit dieser Blueprintdefinition.

CloudError

Objekt

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

keyVaultReference

Objekt

Gibt den Link zu einem Key Vault an.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID des Key Vault.

ManagedServiceIdentity

Objekt

Generisches Objekt der verwalteten Identität.

Name	Typ	Beschreibung
principalId	string	Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist.
tenantId	string	ID des Azure Active Directory.
type	ManagedServiceIdentityType	Typ der verwalteten Identität.
userAssignedIdentities	<string, UserAssignedIdentity>	Die Liste der vom Benutzer zugewiesenen verwalteten Identitäten, die der Ressource zugeordnet sind. Der Schlüssel ist die Azure-Ressourcen-ID der verwalteten Identität.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Identität.

Wert	Beschreibung
None
SystemAssigned
UserAssigned

ParameterValue

Objekt

Wert für den angegebenen Parameter. Kann entweder "Wert" oder "Bezug" sein, aber nicht beide.

Name	Typ	Beschreibung
reference	SecretValueReference	Parameterwert als Bezugstyp.
value	object	Parameterwert. Jeder gültige JSON-Wert ist zulässig, einschließlich Objekte, Arrays, Zeichenfolgen, Zahlen und Booleans.

ResourceGroupValue

Objekt

Stellt eine Azure-Ressourcengruppe dar.

Name	Typ	Beschreibung
location	string	Speicherort der Ressourcengruppe.
name	string minLength: 1 maxLength: 90	Name der Ressourcengruppe.

SecretValueReference

Objekt

Verweis auf einen Schlüsseltresorschlüssel.

Name	Typ	Beschreibung
keyVault	keyVaultReference	Gibt den Verweis auf einen bestimmten Azure Key Vault an.
secretName	string	Der Name des geheimen Schlüssels.
secretVersion	string	Die zu verwendende Version des geheimen Schlüssels. Wenn sie leer gelassen wird, wird die neueste Version des geheimen Schlüssels verwendet.

UserAssignedIdentity

Objekt

Vom Benutzer zugewiesene verwaltete Identität.

Name	Typ	Beschreibung
clientId	string	Dieser Identität zugeordnete Client-App-ID.
principalId	string	Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist.

Freigeben über

Assignments - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Assignment with system-assigned managed identity at management group scope

Beispielanforderung

Beispiel für eine Antwort

Assignment with system-assigned managed identity at subscription scope

Beispielanforderung

Beispiel für eine Antwort

Assignment with user-assigned managed identity at management group scope

Beispielanforderung

Beispiel für eine Antwort

Assignment with user-assigned managed identity at subscription scope

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Assignment

AssignmentLockMode

AssignmentLockSettings

AssignmentProvisioningState

AssignmentStatus

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ManagedServiceIdentity

ManagedServiceIdentityType

ParameterValue

ResourceGroupValue

SecretValueReference

UserAssignedIdentity