Published Artifacts - List

Služba:: Blueprints

Verze rozhraní API:: 2018-11-01-preview

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	V	Vyžadováno	Typ	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	Typ	Description
200 OK	ArtifactList	OK – artefakty verze publikované definice podrobného plánu byly načteny.
Other Status Codes	CloudError	Odpověď na chybu podrobných plánů

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

MG-ArtifactList

Sub-ArtifactList

MG-ArtifactList

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
    }
  ]
}

Definice

Name	Description
ArtifactList	Seznam artefaktů podrobného plánu
CloudError
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
keyVaultReference	Určuje propojení se službou Key Vault.
ParameterValue	Hodnota pro zadaný parametr. 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ý klíč služby Key Vault
TemplateArtifact	Artefakt podrobného plánu, který nasadí šablonu Resource Manageru.

ArtifactList

Objekt

Seznam artefaktů podrobného plánu

Name	Typ	Description
nextLink	string	Odkaz na další stránku výsledků
value	Artifact[]: PolicyAssignmentArtifact[] RoleAssignmentArtifact[] TemplateArtifact[]	Seznam artefaktů podrobného plánu

CloudError

Objekt

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Objekt

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

keyVaultReference

Objekt

Určuje propojení se službou Key Vault.

Name	Typ	Description
id	string	ID prostředku Azure služby Key Vault.

ParameterValue

Objekt

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

Name	Typ	Description
reference	SecretValueReference	Hodnota parametru jako typ odkazu
value	object	Hodnota parametru. Všechna platná hodnota JSON je povolená, včetně objektů, polí, řetězců, čísel a logických hodnot.

PolicyAssignmentArtifact

Objekt

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

Name	Typ	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[]	Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description	string maxLength: 500	Víceřádkové vysvětlení tohoto prostředku
properties.displayName	string maxLength: 256	Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.parameters	<string, ParameterValue>	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é se zásada přiřadí.
type	string	Typ tohoto prostředku

RoleAssignmentArtifact

Objekt

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

Name	Typ	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[]	Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description	string maxLength: 500	Víceřádkové vysvětlení tohoto prostředku
properties.displayName	string maxLength: 256	Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.principalIds		Pole identit uživatelů nebo skupin v Azure Active Directory Definice role se použije pro každou identitu.
properties.resourceGroup	string	RoleAssignment bude oborem pro tuto skupinu prostředků. Pokud je prázdný, rozsah se vztahuje na předplatné.
properties.roleDefinitionId	string	ID prostředku Azure roleDefinition.
type	string	Typ tohoto prostředku

SecretValueReference

Objekt

Odkaz na tajný klíč služby Key Vault

Name	Typ	Description
keyVault	keyVaultReference	Určuje odkaz na danou službu Azure Key Vault.
secretName	string	Název tajného klíče.
secretVersion	string	Verze tajného kódu, který se má použít. Pokud necháte prázdné, použije se nejnovější verze tajného kódu.

TemplateArtifact

Objekt

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

Name	Typ	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[]	Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description	string maxLength: 500	Víceřádkové vysvětlení tohoto prostředku
properties.displayName	string maxLength: 256	Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.parameters	<string, ParameterValue>	Hodnoty parametrů artefaktů šablony Resource Manageru
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 Manageru.
properties.template	object	Tělo artefaktu podrobného plánu šablony Resource Manageru
type	string	Typ tohoto prostředku

Sdílet prostřednictvím

Published Artifacts - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

MG-ArtifactList

Ukázkový požadavek

Ukázková odpověď

Sub-ArtifactList

Ukázkový požadavek

Ukázková odpověď

Definice

ArtifactList

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ParameterValue

PolicyAssignmentArtifact

RoleAssignmentArtifact

SecretValueReference

TemplateArtifact