Partager via


Published Artifacts - List

Répertorier les artefacts d’une version d’une définition de blueprint publiée.

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

Paramètres URI

Nom Dans Obligatoire Type Description
blueprintName
path True

string

Nom de la définition de blueprint.

resourceScope
path True

string

Portée de la ressource. Les étendues valides sont les suivantes : groupe d’administration (format : « /providers/Microsoft.Management/managementGroups/{managementGroup} »), abonnement (format : « /subscriptions/{subscriptionId} »).

versionId
path True

string

Version de la définition de blueprint publiée.

api-version
query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

ArtifactList

OK : artefacts d’une version de la définition de blueprint publiée récupérée.

Other Status Codes

CloudError

Réponse d’erreur blueprints.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

MG-ArtifactList
Sub-ArtifactList

MG-ArtifactList

Exemple de requête

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

Exemple de réponse

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

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ArtifactList

Liste des artefacts de blueprint.

CloudError
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorResponse

Réponse d’erreur

keyVaultReference

Spécifie le lien vers un Key Vault.

ParameterValue

Valeur du paramètre spécifié. Il peut s’agir de « valeur » ou de « référence », mais pas des deux.

PolicyAssignmentArtifact

Artefact de blueprint qui applique une affectation de stratégie.

RoleAssignmentArtifact

Artefact de blueprint qui applique une attribution de rôle.

SecretValueReference

Référence à un secret Key Vault.

TemplateArtifact

Artefact de blueprint qui déploie un modèle Resource Manager.

ArtifactList

Liste des artefacts de blueprint.

Nom Type Description
nextLink

string

Lien vers la page de résultats suivante.

value Artifact[]:

Liste des artefacts de blueprint.

CloudError

Nom Type Description
error

ErrorResponse

Réponse d’erreur
Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorResponse[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

keyVaultReference

Spécifie le lien vers un Key Vault.

Nom Type Description
id

string

ID de ressource Azure du Key Vault.

ParameterValue

Valeur du paramètre spécifié. Il peut s’agir de « valeur » ou de « référence », mais pas des deux.

Nom Type Description
reference

SecretValueReference

Valeur du paramètre comme type de référence.

value

object

Valeur du paramètre. Toute valeur JSON valide est autorisée, y compris les objets, les tableaux, les chaînes, les nombres et les booléens.

PolicyAssignmentArtifact

Artefact de blueprint qui applique une affectation de stratégie.

Nom Type Description
id

string

ID de chaîne utilisé pour localiser n’importe quelle ressource sur Azure.

kind string:

policyAssignment

Spécifie le type d’artefact de blueprint.

name

string

Nom de cette ressource.

properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.

properties.description

string

Expliquez cette ressource sur plusieurs lignes.

properties.displayName

string

Une chaîne à une ligne explique cette ressource.

properties.parameters

<string,  ParameterValue>

Valeurs de paramètre pour la définition de stratégie.

properties.policyDefinitionId

string

ID de ressource Azure de la définition de stratégie.

properties.resourceGroup

string

Nom de l’espace réservé du groupe de ressources auquel la stratégie sera affectée.

type

string

Type de cette ressource.

RoleAssignmentArtifact

Artefact de blueprint qui applique une attribution de rôle.

Nom Type Description
id

string

ID de chaîne utilisé pour localiser n’importe quelle ressource sur Azure.

kind string:

roleAssignment

Spécifie le type d’artefact de blueprint.

name

string

Nom de cette ressource.

properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.

properties.description

string

Expliquez cette ressource sur plusieurs lignes.

properties.displayName

string

Une chaîne à une ligne explique cette ressource.

properties.principalIds

Tableau d’identités d’utilisateur ou de groupe dans Azure Active Directory. RoleDefinition s’applique à chaque identité.

properties.resourceGroup

string

RoleAssignment sera étendu à ce groupe de ressources. S’il est vide, il s’étend à l’abonnement.

properties.roleDefinitionId

string

ID de ressource Azure de RoleDefinition.

type

string

Type de cette ressource.

SecretValueReference

Référence à un secret Key Vault.

Nom Type Description
keyVault

keyVaultReference

Spécifie la référence à un Key Vault Azure donné.

secretName

string

Nom du secret.

secretVersion

string

Version du secret à utiliser. Si ce n’est pas le cas, la dernière version du secret est utilisée.

TemplateArtifact

Artefact de blueprint qui déploie un modèle Resource Manager.

Nom Type Description
id

string

ID de chaîne utilisé pour localiser n’importe quelle ressource sur Azure.

kind string:

template

Spécifie le type d’artefact de blueprint.

name

string

Nom de cette ressource.

properties.dependsOn

string[]

Artefacts qui doivent être déployés avant l’artefact spécifié.

properties.description

string

Expliquez cette ressource sur plusieurs lignes.

properties.displayName

string

Une chaîne à une ligne explique cette ressource.

properties.parameters

<string,  ParameterValue>

Resource Manager valeurs de paramètre d’artefact de blueprint de modèle.

properties.resourceGroup

string

Le cas échéant, nom de l’espace réservé du groupe de ressources sur lequel l’artefact de blueprint de modèle Resource Manager sera déployé.

properties.template

object

Corps d’artefact de blueprint de modèle Resource Manager.

type

string

Type de cette ressource.