Published Artifacts - List

Výpis artefaktů pro verzi publikované definice podrobného plánu

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

Parametry identifikátoru URI

Name In Required Type Description
blueprintName
path True
  • string

Název definice podrobného plánu.

resourceScope
path True
  • string

Rozsah prostředku. Platné obory jsou: skupina pro správu (formát: /providers/Microsoft.Management/managementGroups/{managementGroup}), předplatné (formát: /subscriptions/{subscriptionId}).

versionId
path True
  • string

Verze publikované definice podrobného plánu.

api-version
query True
  • string

Verze rozhraní API klienta

Odpovědi

Name Type Description
200 OK

OK – artefakty verze publikované definice podrobného plánu byly načteny.

Other Status Codes

Chybová odpověď podrobného plánu

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

MG-ArtifactList
Sub-ArtifactList

MG-ArtifactList

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definice

ArtifactList

Seznam artefaktů podrobného plánu

CloudError
ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorResponse

Chybová odpověď

keyVaultReference

Určuje odkaz na Key Vault.

ParameterValue

Hodnota zadaného parametru. Může to být buď hodnota, nebo odkaz, ale ne obojí.

PolicyAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení zásad.

RoleAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení role.

SecretValueReference

Odkaz na tajný kód Key Vault

TemplateArtifact

Artefakt podrobného plánu, který nasadí šablonu Resource Manager.

ArtifactList

Seznam artefaktů podrobného plánu

Name Type Description
nextLink
  • string

Odkaz na další stránku výsledků

value Artifact[]:

Seznam artefaktů podrobného plánu

CloudError

Name Type Description
error

Chybová odpověď
Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager pro vrácení podrobností o chybách pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Type Description
info
  • object

Další informace.

type
  • string

Další typ informací.

ErrorResponse

Chybová odpověď

Name Type Description
additionalInfo

Další informace o chybě.

code
  • string

Kód chyby

details

Podrobnosti o chybě.

message
  • string

Chybová zpráva

target
  • string

Cíl chyby.

keyVaultReference

Určuje odkaz na Key Vault.

Name Type Description
id
  • string

ID prostředku Azure Key Vault

ParameterValue

Hodnota zadaného parametru. Může to být buď hodnota, nebo odkaz, ale ne obojí.

Name Type Description
reference

Hodnota parametru jako typ odkazu

value
  • object

Hodnota parametru. Jakákoli platná hodnota JSON je povolená, včetně objektů, polí, řetězců, čísel a logických hodnot.

PolicyAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení zásad.

Name Type Description
id
  • string

ID řetězce použité k vyhledání libovolného prostředku v Azure

kind string:
  • policyAssignment

Určuje druh artefaktu podrobného plánu.

name
  • string

Název tohoto prostředku.

properties.dependsOn
  • string[]

Artifacts, které je potřeba nasadit před zadaným artefaktem.

properties.description
  • string

Víceřádkové vysvětlení tohoto prostředku

properties.displayName
  • string

Řetězec s jednou vložkou tento prostředek vysvětluje.

properties.parameters

Hodnoty parametrů pro definici zásady

properties.policyDefinitionId
  • string

ID prostředku Azure definice zásady

properties.resourceGroup
  • string

Název zástupného symbolu skupiny prostředků, ke kterému bude zásada přiřazena.

type
  • string

Typ tohoto prostředku

RoleAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení role.

Name Type Description
id
  • string

ID řetězce použité k vyhledání libovolného prostředku v Azure

kind string:
  • roleAssignment

Určuje druh artefaktu podrobného plánu.

name
  • string

Název tohoto prostředku.

properties.dependsOn
  • string[]

Artifacts, které je potřeba nasadit před zadaným artefaktem.

properties.description
  • string

Víceřádkové vysvětlení tohoto prostředku

properties.displayName
  • string

Řetězec s jednou vložkou tento prostředek vysvětluje.

properties.principalIds

Pole identit uživatelů nebo skupin v Azure Active Directory RoleDefinition se použije pro každou identitu.

properties.resourceGroup
  • string

Přiřazení roleAssignment bude oborem pro tuto skupinu prostředků. Pokud je prázdné, rozsahy předplatného.

properties.roleDefinitionId
  • string

ID prostředku Azure roleDefinition

type
  • string

Typ tohoto prostředku

SecretValueReference

Odkaz na tajný kód Key Vault

Name Type Description
keyVault

Určuje odkaz na danou Key Vault Azure.

secretName
  • string

Název tajného klíče.

secretVersion
  • string

Verze tajného kódu, který se má použít. Pokud ponecháte prázdné, použije se nejnovější verze tajného kódu.

TemplateArtifact

Artefakt podrobného plánu, který nasadí šablonu Resource Manager.

Name Type Description
id
  • string

ID řetězce použité k vyhledání libovolného prostředku v Azure

kind string:
  • template

Určuje druh artefaktu podrobného plánu.

name
  • string

Název tohoto prostředku.

properties.dependsOn
  • string[]

Artifacts, které je potřeba nasadit před zadaným artefaktem.

properties.description
  • string

Víceřádkové vysvětlení tohoto prostředku

properties.displayName
  • string

Řetězec s jednou vložkou tento prostředek vysvětluje.

properties.parameters

Resource Manager hodnot parametrů artefaktů podrobného plánu šablony.

properties.resourceGroup
  • string

Pokud je to možné, název zástupného symbolu skupiny prostředků, do kterého se nasadí artefakt podrobného plánu šablony Resource Manager.

properties.template
  • object

Text artefaktu podrobného plánu šablony Resource Manager.

type
  • string

Typ tohoto prostředku