Blueprints - Create Or Update

Dienst:: Blueprints

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

Erstellen oder Aktualisieren einer Blueprintdefinition.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
blueprintName	path	True	string	Name der Blaupausendefinition.
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
properties.targetScope	True	BlueprintTargetScope	Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann.
description		string maxLength: 500	Mehrzeilige Erläuterung dieser Ressource.
displayName		string maxLength: 256	Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert.
properties.parameters		<string, ParameterDefinition>	Parameter, die von dieser Blueprintdefinition benötigt werden.
properties.resourceGroups		<string, ResourceGroupDefinition>	Durch diese Blueprintdefinition definierte Platzhalter für Ressourcengruppen.
properties.versions		object	Veröffentlichte Versionen dieser Blueprintdefinition.

Antworten

Name	Typ	Beschreibung
201 Created	Blueprint	Erstellt – Blaupausendefinition 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

ManagementGroupBlueprint

ResourceGroupWithTags

SubscriptionBlueprint

ManagementGroupBlueprint

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 201

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 201

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 201

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

Definitionen

Name	Beschreibung
Blueprint	Stellt eine Blueprint-Definition dar.
BlueprintStatus	Der Status des Blueprints. Dieses Feld ist schreibgeschützt.
BlueprintTargetScope	Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann.
CloudError
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
ParameterDefinition	Stellt einen Parameter mit Einschränkungen und Metadaten dar.
ResourceGroupDefinition	Stellt eine Azure-Ressourcengruppe in einer Blueprintdefinition dar.
TemplateParameterType	Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter.

Blueprint

Objekt

Stellt eine Blueprint-Definition dar.

Name	Typ	Beschreibung
description	string maxLength: 500	Mehrzeilige Erläuterung dieser Ressource.
displayName	string maxLength: 256	Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert.
id	string	Zeichenfolgen-ID, die verwendet wird, um eine Ressource in Azure zu finden.
name	string	Name dieser Ressource.
properties.layout	object	Layoutansicht der Blueprintdefinition für UI-Referenz.
properties.parameters	<string, ParameterDefinition>	Parameter, die von dieser Blueprintdefinition benötigt werden.
properties.resourceGroups	<string, ResourceGroupDefinition>	Durch diese Blueprintdefinition definierte Platzhalter für Ressourcengruppen.
properties.status	BlueprintStatus	Status des Blueprints. Dieses Feld ist schreibgeschützt.
properties.targetScope	BlueprintTargetScope	Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann.
properties.versions	object	Veröffentlichte Versionen dieser Blueprintdefinition.
type	string	Typ dieser Ressource.

BlueprintStatus

Objekt

Der Status des Blueprints. Dieses Feld ist schreibgeschützt.

Name	Typ	Beschreibung
lastModified	string (date-time)	Zeitpunkt der letzten Änderung dieser Blueprintdefinition.
timeCreated	string (date-time)	Erstellungszeit dieser Blueprintdefinition.

BlueprintTargetScope

Enumeration

Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann.

Wert	Beschreibung
subscription	Der Blueprint zielt auf ein Abonnement während der Blaupausenzuweisung ab.
managementGroup	Der Blueprint zielt während der Blueprint-Zuordnung auf eine Verwaltungsgruppe ab. Dies ist für die zukünftige Verwendung reserviert.

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.

ParameterDefinition

Objekt

Stellt einen Parameter mit Einschränkungen und Metadaten dar.

Name	Typ	Beschreibung
allowedValues	AllowedValues[]	Array zulässiger Werte für diesen Parameter.
defaultValue		Standardwert für diesen Parameter.
metadata.description	string maxLength: 500	Beschreibung dieses Parameters/resourceGroup.
metadata.displayName	string maxLength: 256	DisplayName dieses Parameters/resourceGroup.
metadata.strongType	string maxLength: 64	StrongType für ui zum Rendern umfangreicher Erfahrungen während der Blueprint-Zuordnung. Unterstützte starke Typen sind "resourceType", "principalId" und "location".
type	TemplateParameterType	Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter.

ResourceGroupDefinition

Objekt

Stellt eine Azure-Ressourcengruppe in einer Blueprintdefinition dar.

Name	Typ	Beschreibung
dependsOn	string[]	Artefakte, die vor dieser Ressourcengruppe bereitgestellt werden müssen.
location	string	Speicherort dieser resourceGroup. Lassen Sie leer, wenn der Speicherort der Ressourcengruppe während der Blueprintzuordnung angegeben wird.
metadata.description	string maxLength: 500	Beschreibung dieses Parameters/resourceGroup.
metadata.displayName	string maxLength: 256	DisplayName dieses Parameters/resourceGroup.
metadata.strongType	string maxLength: 64	StrongType für ui zum Rendern umfangreicher Erfahrungen während der Blueprint-Zuordnung. Unterstützte starke Typen sind "resourceType", "principalId" und "location".
name	string	Name dieser resourceGroup. Lassen Sie leer, wenn der Ressourcengruppenname während der Blueprintzuordnung angegeben wird.
tags	object	Tags, die dieser Ressourcengruppe zugewiesen werden sollen.

TemplateParameterType

Enumeration

Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter.

Wert	Beschreibung
string
array
bool
int
object
secureObject
secureString

Freigeben über

Blueprints - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ManagementGroupBlueprint

Beispielanforderung

Beispiel für eine Antwort

ResourceGroupWithTags

Beispielanforderung

Beispiel für eine Antwort

SubscriptionBlueprint

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Blueprint

BlueprintStatus

BlueprintTargetScope

CloudError

ErrorAdditionalInfo

ErrorResponse

ParameterDefinition

ResourceGroupDefinition

TemplateParameterType