Published Artifacts - List

Listar artefatos para uma versão de uma definição de blueprint publicada.

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

Parâmetros de URI

Name In Required Type Description
blueprintName
path True
  • string

Nome da definição do blueprint.

resourceScope
path True
  • string

O escopo do recurso. Os escopos válidos são: grupo de gerenciamento (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), assinatura (formato: '/subscriptions/{subscriptionId}').

versionId
path True
  • string

Versão da definição de blueprint publicada.

api-version
query True
  • string

Versão da API do cliente.

Respostas

Name Type Description
200 OK

OK - artefatos de uma versão da definição de blueprint publicada recuperada.

Other Status Codes

Resposta de erro de blueprints.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

ArtifactList

Lista de artefatos de blueprint.

CloudError
ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

ErrorResponse

Resposta de erro

keyVaultReference

Especifica o link para um Key Vault.

ParameterValue

Valor para o parâmetro especificado. Pode ser "valor" ou "referência", mas não ambos.

PolicyAssignmentArtifact

Artefato de blueprint que aplica uma atribuição de Política.

RoleAssignmentArtifact

Artefato de blueprint que aplica uma atribuição de função.

SecretValueReference

Referência a um segredo Key Vault.

TemplateArtifact

Artefato blueprint que implanta um modelo de Resource Manager.

ArtifactList

Lista de artefatos de blueprint.

Name Type Description
nextLink
  • string

Link para a próxima página de resultados.

value Artifact[]:

Lista de artefatos de blueprint.

CloudError

Name Type Description
error

Resposta de erro
Resposta de erro comum para todas as APIs de Resource Manager do Azure retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorResponse

Resposta de erro

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

keyVaultReference

Especifica o link para um Key Vault.

Name Type Description
id
  • string

ID do recurso do Azure do Key Vault.

ParameterValue

Valor para o parâmetro especificado. Pode ser "valor" ou "referência", mas não ambos.

Name Type Description
reference

Valor do parâmetro como tipo de referência.

value
  • object

Valor de parâmetro. Qualquer valor JSON válido é permitido, incluindo objetos, matrizes, cadeias de caracteres, números e boolianos.

PolicyAssignmentArtifact

Artefato de blueprint que aplica uma atribuição de Política.

Name Type Description
id
  • string

ID de cadeia de caracteres usada para localizar qualquer recurso no Azure.

kind string:
  • policyAssignment

Especifica o tipo de artefato de blueprint.

name
  • string

Nome desse recurso.

properties.dependsOn
  • string[]

Artifacts que precisam ser implantados antes do artefato especificado.

properties.description
  • string

Várias linhas explicam esse recurso.

properties.displayName
  • string

Uma cadeia de caracteres de linha única explica esse recurso.

properties.parameters

Valores de parâmetro para a definição de política.

properties.policyDefinitionId
  • string

ID de recurso do Azure da definição de política.

properties.resourceGroup
  • string

Nome do espaço reservado do grupo de recursos ao qual a política será atribuída.

type
  • string

Tipo desse recurso.

RoleAssignmentArtifact

Artefato de blueprint que aplica uma atribuição de função.

Name Type Description
id
  • string

ID de cadeia de caracteres usada para localizar qualquer recurso no Azure.

kind string:
  • roleAssignment

Especifica o tipo de artefato de blueprint.

name
  • string

Nome desse recurso.

properties.dependsOn
  • string[]

Artifacts que precisam ser implantados antes do artefato especificado.

properties.description
  • string

Várias linhas explicam esse recurso.

properties.displayName
  • string

Uma cadeia de caracteres de linha única explica esse recurso.

properties.principalIds

Matriz de identidades de usuário ou grupo no Azure Active Directory. A roleDefinition se aplicará a cada identidade.

properties.resourceGroup
  • string

RoleAssignment será o escopo para este resourceGroup. Se estiver vazio, ele usará o escopo da assinatura.

properties.roleDefinitionId
  • string

ID de recurso do Azure da RoleDefinition.

type
  • string

Tipo desse recurso.

SecretValueReference

Referência a um segredo Key Vault.

Name Type Description
keyVault

Especifica a referência a um determinado Key Vault do Azure.

secretName
  • string

Nome do segredo.

secretVersion
  • string

A versão do segredo a ser usado. Se deixado em branco, a versão mais recente do segredo será usada.

TemplateArtifact

Artefato blueprint que implanta um modelo de Resource Manager.

Name Type Description
id
  • string

ID de cadeia de caracteres usada para localizar qualquer recurso no Azure.

kind string:
  • template

Especifica o tipo de artefato de blueprint.

name
  • string

Nome desse recurso.

properties.dependsOn
  • string[]

Artifacts que precisam ser implantados antes do artefato especificado.

properties.description
  • string

Várias linhas explicam esse recurso.

properties.displayName
  • string

Uma cadeia de caracteres de linha única explica esse recurso.

properties.parameters

Resource Manager valores de parâmetro de artefato de blueprint de modelo.

properties.resourceGroup
  • string

Se aplicável, o nome do espaço reservado do grupo de recursos ao qual o artefato de blueprint do modelo Resource Manager será implantado.

properties.template
  • object

O corpo do artefato de blueprint do modelo Resource Manager.

type
  • string

Tipo desse recurso.