Published Artifacts - List

Tjänst:: Blueprints

API-version:: 2018-11-01-preview

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	I	Obligatorisk	Typ	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	Typ	Description
200 OK	ArtifactList	OK – artefakter av en version av den publicerade skissdefinitionen som hämtats.
Other Status Codes	CloudError	Felsvar för skisser.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

MG-ArtifactList

Sub-ArtifactList

MG-ArtifactList

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Name	Description
ArtifactList	Lista över skissartefakter.
CloudError
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
keyVaultReference	Anger länken till ett Nyckelvalv.
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

Objekt

Lista över skissartefakter.

Name	Typ	Description
nextLink	string	Länka till nästa sida med resultat.
value	Artifact[]: PolicyAssignmentArtifact[] RoleAssignmentArtifact[] TemplateArtifact[]	Lista över skissartefakter.

CloudError

Objekt

Name	Typ	Description
error	ErrorResponse	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 formatet för OData-felsvar.)

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

keyVaultReference

Objekt

Anger länken till ett Nyckelvalv.

Name	Typ	Description
id	string	Azure-resurs-ID för Key Vault.

ParameterValue

Objekt

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

Name	Typ	Description
reference	SecretValueReference	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

Objekt

Skissartefakt som tillämpar en principtilldelning.

Name	Typ	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 maxLength: 500	Förklara den här resursen med flera rader.
properties.displayName	string maxLength: 256	Enradssträng förklarar den här resursen.
properties.parameters	<string, ParameterValue>	Parametervärden för principdefinitionen.
properties.policyDefinitionId	string	Azure-resurs-ID för principdefinitionen.
properties.resourceGroup	string	Namn på platshållaren för resursgruppen som principen ska tilldelas till.
type	string	Typ av resurs.

RoleAssignmentArtifact

Objekt

Skissartefakt som tillämpar en rolltilldelning.

Name	Typ	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 maxLength: 500	Förklara den här resursen med flera rader.
properties.displayName	string maxLength: 256	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ång 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

Objekt

Referens till en Key Vault-hemlighet.

Name	Typ	Description
keyVault	keyVaultReference	Anger referensen till ett visst Azure Key Vault.
secretName	string	Namnet på hemligheten.
secretVersion	string	Den version av hemligheten som ska användas. Om den lämnas tom används den senaste versionen av hemligheten.

TemplateArtifact

Objekt

Skissartefakt som distribuerar en Resource Manager-mall.

Name	Typ	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 maxLength: 500	Förklara den här resursen med flera rader.
properties.displayName	string maxLength: 256	Enradssträng förklarar den här resursen.
properties.parameters	<string, ParameterValue>	Resource Manager-mallens parametervärden för skissartefakter.
properties.resourceGroup	string	Om tillämpligt, namnet på platshållaren för resursgruppen som Resource Manager-mallens skissartefakt ska distribueras till.
properties.template	object	Resource Manager-mallens artefakttext för skissen.
type	string	Typ av resurs.

Dela via

Published Artifacts - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

MG-ArtifactList

Exempelbegäran

Exempelsvar

Sub-ArtifactList

Exempelbegäran

Exempelsvar

Definitioner

ArtifactList

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ParameterValue

PolicyAssignmentArtifact

RoleAssignmentArtifact

SecretValueReference

TemplateArtifact