Published Artifacts - List

Lista artefakter för en version av en publicerad skissdefinition.

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

URI-parametrar

Name In Required Type Description
blueprintName
path True
  • string

Namnet på skissdefinitionen.

resourceScope
path True
  • string

Resursens omfång. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), prenumeration (format: '/subscriptions/{subscriptionId}').

versionId
path True
  • string

Version av den publicerade skissdefinitionen.

api-version
query True
  • string

Klient-API-version.

Svar

Name Type Description
200 OK

OK – artefakter av en version av den publicerade skissdefinitionen som hämtats.

Other Status Codes

Felsvar för skisser.

Säkerhet

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 personifiera ditt användarkonto

Exempel

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

Definitioner

ArtifactList

Lista över skissartefakter.

CloudError
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorResponse

Felsvar

keyVaultReference

Anger länken till en Key Vault.

ParameterValue

Värde för den angivna parametern. Kan vara antingen "värde" eller "referens", men inte båda.

PolicyAssignmentArtifact

Skissartefakt som tillämpar en principtilldelning.

RoleAssignmentArtifact

Skissartefakt som tillämpar en rolltilldelning.

SecretValueReference

Referens till en Key Vault hemlighet.

TemplateArtifact

Skissartefakt som distribuerar en Resource Manager mall.

ArtifactList

Lista över skissartefakter.

Name Type Description
nextLink
  • string

Länka till nästa sida med resultat.

value Artifact[]:

Lista över skissartefakter.

CloudError

Name Type Description
error

Felsvar
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.)

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Type Description
info
  • object

Den ytterligare informationen.

type
  • string

Ytterligare informationstyp.

ErrorResponse

Felsvar

Name Type Description
additionalInfo

Ytterligare information om felet.

code
  • string

Felkoden.

details

Felinformationen.

message
  • string

Felmeddelandet.

target
  • string

Felmålet.

keyVaultReference

Anger länken till en Key Vault.

Name Type Description
id
  • string

Azure-resurs-ID för Key Vault.

ParameterValue

Värde för den angivna parametern. Kan vara antingen "värde" eller "referens", men inte båda.

Name Type Description
reference

Parametervärde som referenstyp.

value
  • object

Parametervärde. Alla giltiga JSON-värden tillåts, inklusive objekt, matriser, strängar, tal och booleska värden.

PolicyAssignmentArtifact

Skissartefakt som tillämpar en principtilldelning.

Name Type Description
id
  • string

Sträng-ID som används för att hitta en resurs i Azure.

kind string:
  • policyAssignment

Anger typen av skissartefakt.

name
  • string

Namnet på den här resursen.

properties.dependsOn
  • string[]

Artefakter som måste distribueras före den angivna artefakten.

properties.description
  • string

Förklara den här resursen med flera rader.

properties.displayName
  • string

Enradssträng förklarar den här resursen.

properties.parameters

Parametervärden för principdefinitionen.

properties.policyDefinitionId
  • string

Azure-resurs-ID för principdefinitionen.

properties.resourceGroup
  • string

Namnet på platshållaren för resursgruppen som principen ska tilldelas till.

type
  • string

Typ av resurs.

RoleAssignmentArtifact

Skissartefakt som tillämpar en rolltilldelning.

Name Type Description
id
  • string

Sträng-ID som används för att hitta en resurs i Azure.

kind string:
  • roleAssignment

Anger typen av skissartefakt.

name
  • string

Namnet på den här resursen.

properties.dependsOn
  • string[]

Artefakter som måste distribueras före den angivna artefakten.

properties.description
  • string

Förklara den här resursen med flera rader.

properties.displayName
  • string

Enradssträng förklarar den här resursen.

properties.principalIds

Matris med användar- eller gruppidentiteter i Azure Active Directory. RoleDefinition gäller för varje identitet.

properties.resourceGroup
  • string

RoleAssignment kommer att vara omfånget för den här resourceGroup. Om den är tom omfångsbegränsas den till prenumerationen.

properties.roleDefinitionId
  • string

Azure-resurs-ID för RoleDefinition.

type
  • string

Typ av resurs.

SecretValueReference

Referens till en Key Vault hemlighet.

Name Type Description
keyVault

Anger referensen till en viss Azure-Key Vault.

secretName
  • string

Namnet på hemligheten.

secretVersion
  • string

Den version av hemligheten som ska användas. Om det lämnas tomt används den senaste versionen av hemligheten.

TemplateArtifact

Skissartefakt som distribuerar en Resource Manager mall.

Name Type Description
id
  • string

Sträng-ID som används för att hitta en resurs i Azure.

kind string:
  • template

Anger typen av skissartefakt.

name
  • string

Namnet på den här resursen.

properties.dependsOn
  • string[]

Artefakter som måste distribueras före den angivna artefakten.

properties.description
  • string

Förklara den här resursen med flera rader.

properties.displayName
  • string

Enradssträng förklarar den här resursen.

properties.parameters

Resource Manager parametervärden för skissartefakter för mallar.

properties.resourceGroup
  • string

I förekommande fall namnet på resursgruppens platshållare som Resource Manager mallskissartefakt ska distribueras till.

properties.template
  • object

Den Resource Manager mallens artefakttext för mallen.

type
  • string

Typ av resurs.