Freigeben über


Artifacts - Create Or Update

Erstellen oder Aktualisieren des Blueprintartefakts.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
artifactName
path True

string

Name des Blueprintartefakts.

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

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name Beschreibung
PolicyAssignmentArtifact

Blueprintartefakt, das eine Richtlinienzuweisung anwendet.

RoleAssignmentArtifact

Blueprintartefakt, das eine Rollenzuweisung anwendet.

TemplateArtifact

Blueprintartefakt, das eine Resource Manager-Vorlage bereitstellt.

PolicyAssignmentArtifact

Blueprintartefakt, das eine Richtlinienzuweisung anwendet.

Name Erforderlich Typ Beschreibung
kind True string:

policyAssignment

Gibt die Art des Blueprintartefakts an.

properties.parameters True

<string,  ParameterValue>

Parameterwerte für die Richtliniendefinition.

properties.policyDefinitionId True

string

Azure-Ressourcen-ID der Richtliniendefinition.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.resourceGroup

string

Name des Platzhalters der Ressourcengruppe, dem die Richtlinie zugewiesen wird.

RoleAssignmentArtifact

Blueprintartefakt, das eine Rollenzuweisung anwendet.

Name Erforderlich Typ Beschreibung
kind True string:

roleAssignment

Gibt die Art des Blueprintartefakts an.

properties.principalIds True

Array von Benutzer- oder Gruppenidentitäten in Azure Active Directory. Die roleDefinition gilt für jede Identität.

properties.roleDefinitionId True

string

Azure-Ressourcen-ID der RoleDefinition.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.resourceGroup

string

RoleAssignment ist Bereich für diese resourceGroup. Wenn sie leer ist, wird der Bereich für das Abonnement festgelegt.

TemplateArtifact

Blueprintartefakt, das eine Resource Manager-Vorlage bereitstellt.

Name Erforderlich Typ Beschreibung
kind True string:

template

Gibt die Art des Blueprintartefakts an.

properties.parameters True

<string,  ParameterValue>

Ressourcen-Manager-Vorlagen-Blueprintartefaktparameterwerte.

properties.template True

object

Der Ressourcen-Manager-Vorlagen-Blueprintartefakttext.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.resourceGroup

string

Falls zutreffend, wird der Name des Ressourcengruppenplatzhalters, für den das Ressourcen-Manager-Vorlagen-Blueprintartefakt bereitgestellt wird, bereitgestellt.

Antworten

Name Typ Beschreibung
201 Created Artifact:

Erstellt – Blueprintartefakt erstellt/aktualisiert.

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

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

MG-ARMTemplateArtifact

Beispielanforderung

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')]"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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')]"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CloudError
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorResponse

Fehlerantwort

keyVaultReference

Gibt den Link zu einem Key Vault an.

ParameterValue

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

PolicyAssignmentArtifact

Blueprintartefakt, das eine Richtlinienzuweisung anwendet.

RoleAssignmentArtifact

Blueprintartefakt, das eine Rollenzuweisung anwendet.

SecretValueReference

Verweis auf einen Schlüsseltresorschlüssel.

TemplateArtifact

Blueprintartefakt, das eine Resource Manager-Vorlage bereitstellt.

CloudError

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

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorResponse

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

Gibt den Link zu einem Key Vault an.

Name Typ Beschreibung
id

string

Azure-Ressourcen-ID des Key Vault.

ParameterValue

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.

PolicyAssignmentArtifact

Blueprintartefakt, das eine Richtlinienzuweisung anwendet.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die verwendet wird, um eine Ressource in Azure zu finden.

kind string:

policyAssignment

Gibt die Art des Blueprintartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.parameters

<string,  ParameterValue>

Parameterwerte für die Richtliniendefinition.

properties.policyDefinitionId

string

Azure-Ressourcen-ID der Richtliniendefinition.

properties.resourceGroup

string

Name des Platzhalters der Ressourcengruppe, dem die Richtlinie zugewiesen wird.

type

string

Typ dieser Ressource.

RoleAssignmentArtifact

Blueprintartefakt, das eine Rollenzuweisung anwendet.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die verwendet wird, um eine Ressource in Azure zu finden.

kind string:

roleAssignment

Gibt die Art des Blueprintartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.principalIds

Array von Benutzer- oder Gruppenidentitäten in Azure Active Directory. Die roleDefinition gilt für jede Identität.

properties.resourceGroup

string

RoleAssignment ist Bereich für diese resourceGroup. Wenn sie leer ist, wird der Bereich für das Abonnement festgelegt.

properties.roleDefinitionId

string

Azure-Ressourcen-ID der RoleDefinition.

type

string

Typ dieser Ressource.

SecretValueReference

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.

TemplateArtifact

Blueprintartefakt, das eine Resource Manager-Vorlage bereitstellt.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die verwendet wird, um eine Ressource in Azure zu finden.

kind string:

template

Gibt die Art des Blueprintartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

Artefakte, die vor dem angegebenen Artefakt bereitgestellt werden müssen.

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.parameters

<string,  ParameterValue>

Ressourcen-Manager-Vorlagen-Blueprintartefaktparameterwerte.

properties.resourceGroup

string

Falls zutreffend, wird der Name des Ressourcengruppenplatzhalters, für den das Ressourcen-Manager-Vorlagen-Blueprintartefakt bereitgestellt wird, bereitgestellt.

properties.template

object

Der Ressourcen-Manager-Vorlagen-Blueprintartefakttext.

type

string

Typ dieser Ressource.