Published Artifacts - List

Enumerar artefactos para una versión de una definición de plano técnico publicada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
blueprintName
path True

string

Nombre de la definición del plano técnico.

resourceScope
path True

string

Ámbito del recurso. Los ámbitos válidos son: grupo de administración (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}').

versionId
path True

string

Versión de la definición del plano técnico publicado.

api-version
query True

string

Versión de la API de cliente.

Respuestas

Nombre Tipo Description
200 OK

ArtifactList

Correcto: artefactos de una versión de la definición de plano técnico publicada recuperada.

Other Status Codes

CloudError

Respuesta de error de planos técnicos.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre Description
ArtifactList

Lista de artefactos de plano técnico.

CloudError
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorResponse

Respuesta de error

keyVaultReference

Especifica el vínculo a un Key Vault.

ParameterValue

Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.

PolicyAssignmentArtifact

Artefacto de plano técnico que aplica una asignación de directiva.

RoleAssignmentArtifact

Artefacto de plano técnico que aplica una asignación de roles.

SecretValueReference

Referencia a un secreto de Key Vault.

TemplateArtifact

Artefacto de plano técnico que implementa una plantilla de Resource Manager.

ArtifactList

Lista de artefactos de plano técnico.

Nombre Tipo Description
nextLink

string

Vínculo a la página siguiente de resultados.

value Artifact[]:

Lista de artefactos de plano técnico.

CloudError

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorResponse[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

keyVaultReference

Especifica el vínculo a un Key Vault.

Nombre Tipo Description
id

string

Identificador de recurso de Azure del Key Vault.

ParameterValue

Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.

Nombre Tipo Description
reference

SecretValueReference

Valor de parámetro como tipo de referencia.

value

object

Valor del parámetro. Se permite cualquier valor JSON válido, incluidos objetos, matrices, cadenas, números y booleanos.

PolicyAssignmentArtifact

Artefacto de plano técnico que aplica una asignación de directiva.

Nombre Tipo Description
id

string

Identificador de cadena que se usa para buscar cualquier recurso en Azure.

kind string:

policyAssignment

Especifica el tipo de artefacto de plano técnico.

name

string

Nombre de este recurso.

properties.dependsOn

string[]

Artefactos que deben implementarse antes del artefacto especificado.

properties.description

string

Explicar este recurso en varias líneas.

properties.displayName

string

Una cadena de línea explica este recurso.

properties.parameters

<string,  ParameterValue>

Valores de parámetro para la definición de directiva.

properties.policyDefinitionId

string

Identificador de recurso de Azure de la definición de directiva.

properties.resourceGroup

string

Nombre del marcador de posición del grupo de recursos al que se asignará la directiva.

type

string

Tipo de este recurso.

RoleAssignmentArtifact

Artefacto de plano técnico que aplica una asignación de roles.

Nombre Tipo Description
id

string

Identificador de cadena que se usa para buscar cualquier recurso en Azure.

kind string:

roleAssignment

Especifica el tipo de artefacto de plano técnico.

name

string

Nombre de este recurso.

properties.dependsOn

string[]

Artefactos que deben implementarse antes del artefacto especificado.

properties.description

string

Explicar este recurso en varias líneas.

properties.displayName

string

Una cadena de línea explica este recurso.

properties.principalIds

Matriz de identidades de usuario o grupo en Azure Active Directory. RoleDefinition se aplicará a cada identidad.

properties.resourceGroup

string

RoleAssignment será el ámbito de este resourceGroup. Si está vacío, se limita a la suscripción.

properties.roleDefinitionId

string

Identificador de recurso de Azure de RoleDefinition.

type

string

Tipo de este recurso.

SecretValueReference

Referencia a un secreto de Key Vault.

Nombre Tipo Description
keyVault

keyVaultReference

Especifica la referencia a una Key Vault de Azure determinada.

secretName

string

Nombre del secreto.

secretVersion

string

Versión del secreto que se va a usar. Si se deja en blanco, se usa la versión más reciente del secreto.

TemplateArtifact

Artefacto de plano técnico que implementa una plantilla de Resource Manager.

Nombre Tipo Description
id

string

Identificador de cadena que se usa para buscar cualquier recurso en Azure.

kind string:

template

Especifica el tipo de artefacto de plano técnico.

name

string

Nombre de este recurso.

properties.dependsOn

string[]

Artefactos que deben implementarse antes del artefacto especificado.

properties.description

string

Explicar este recurso en varias líneas.

properties.displayName

string

Una cadena de línea explica este recurso.

properties.parameters

<string,  ParameterValue>

Resource Manager valores de parámetro de artefacto de plano técnico de plantilla.

properties.resourceGroup

string

Si procede, el nombre del marcador de posición del grupo de recursos en el que se implementará el artefacto de plano técnico de plantilla de Resource Manager.

properties.template

object

Cuerpo del artefacto del plano técnico de la plantilla de Resource Manager.

type

string

Tipo de este recurso.