Freigeben über


Published Artifacts - List

Auflisten von Artefakten für eine Version einer veröffentlichten Blaupausendefinition.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts?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}').

versionId
path True

string

Version der veröffentlichten Blaupausendefinition.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

ArtifactList

OK : Artefakte einer Version der veröffentlichten Blaupausendefinition abgerufen.

Other Status Codes

CloudError

Blaupausenfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

MG-ArtifactList
Sub-ArtifactList

MG-ArtifactList

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "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/versions/V2/artifacts/ownerAssignment",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "ownerAssignment"
    },
    {
      "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/versions/V2/artifacts/costCenterPolicy",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "costCenterPolicy"
    },
    {
      "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/versions/V2/artifacts/storageTemplate",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "storageTemplate"
    }
  ]
}

Sub-ArtifactList

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "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/versions/V2/artifacts/ownerAssignment",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "ownerAssignment"
    },
    {
      "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/versions/V2/artifacts/costCenterPolicy",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "costCenterPolicy"
    },
    {
      "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/versions/V2/artifacts/storageTemplate",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "storageTemplate"
    }
  ]
}

Definitionen

Name Beschreibung
ArtifactList

Liste der Blaupausenartefakte.

CloudError
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorResponse

Fehlerantwort

keyVaultReference

Gibt den Link zu einem Key Vault an.

ParameterValue

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

PolicyAssignmentArtifact

Blaupausenartefakt, das eine Richtlinienzuweisung anwendet.

RoleAssignmentArtifact

Blaupausenartefakt, das eine Rollenzuweisung anwendet.

SecretValueReference

Verweis auf ein Key Vault Geheimnis.

TemplateArtifact

Blaupausenartefakt, das eine Resource Manager-Vorlage bereitstellt.

ArtifactList

Liste der Blaupausenartefakte.

Name Typ Beschreibung
nextLink

string

Link zur nächsten Ergebnisseite.

value Artifact[]:

Liste der Blaupausenartefakte.

CloudError

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort
Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

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 "Verweis" sein, aber nicht beide.

Name Typ Beschreibung
reference

SecretValueReference

Parameterwert als Verweistyp.

value

object

Parameterwert. Jeder gültige JSON-Wert ist zulässig, einschließlich Objekten, Arrays, Zeichenfolgen, Zahlen und Booleanen.

PolicyAssignmentArtifact

Blaupausenartefakt, das eine Richtlinienzuweisung anwendet.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die zum Suchen einer beliebigen Ressource in Azure verwendet wird.

kind string:

policyAssignment

Gibt die Art des Blaupausenartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

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

properties.description

string

Mehrzeilige Erläuterungen zu dieser Ressource.

properties.displayName

string

Eine einzeilige Zeichenfolge erklärt diese Ressource.

properties.parameters

<string,  ParameterValue>

Parameterwerte für die Richtliniendefinition.

properties.policyDefinitionId

string

Azure-Ressourcen-ID der Richtliniendefinition.

properties.resourceGroup

string

Name des Ressourcengruppenplatzhalters, dem die Richtlinie zugewiesen wird.

type

string

Typ dieser Ressource.

RoleAssignmentArtifact

Blaupausenartefakt, das eine Rollenzuweisung anwendet.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die zum Suchen einer beliebigen Ressource in Azure verwendet wird.

kind string:

roleAssignment

Gibt die Art des Blaupausenartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

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

properties.description

string

Mehrzeilige Erläuterungen zu dieser Ressource.

properties.displayName

string

Eine einzeilige Zeichenfolge erklärt diese Ressource.

properties.principalIds

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

properties.resourceGroup

string

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

properties.roleDefinitionId

string

Azure-Ressourcen-ID der RoleDefinition.

type

string

Typ dieser Ressource.

SecretValueReference

Verweis auf ein Key Vault Geheimnis.

Name Typ Beschreibung
keyVault

keyVaultReference

Gibt den Verweis auf eine bestimmte Azure-Key Vault an.

secretName

string

Name des Geheimnisses.

secretVersion

string

Die Version des zu verwendenden Geheimnisses. Wenn sie leer bleiben, wird die neueste Version des Geheimnisses verwendet.

TemplateArtifact

Blaupausenartefakt, das eine Resource Manager-Vorlage bereitstellt.

Name Typ Beschreibung
id

string

Zeichenfolgen-ID, die zum Suchen einer beliebigen Ressource in Azure verwendet wird.

kind string:

template

Gibt die Art des Blaupausenartefakts an.

name

string

Name dieser Ressource.

properties.dependsOn

string[]

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

properties.description

string

Mehrzeilige Erläuterungen zu dieser Ressource.

properties.displayName

string

Eine einzeilige Zeichenfolge erklärt diese Ressource.

properties.parameters

<string,  ParameterValue>

Resource Manager Parameterwerte für Blaupausenartefakt der Vorlage.

properties.resourceGroup

string

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

properties.template

object

Der Resource Manager Vorlagen-Blaupausenartefaktkörper.

type

string

Typ dieser Ressource.