Partilhar via


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 do URI

Name Em Necessário Tipo 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 modelo publicada.

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

ArtifactList

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

Other Status Codes

CloudError

Blueprints resposta de erro.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

MG-ArtifactList
Sub-ArtifactList

MG-ArtifactList

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Name Description
ArtifactList

Lista de artefatos de blueprint.

CloudError
ErrorAdditionalInfo

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

ErrorResponse

Resposta de erro

keyVaultReference

Especifica o link para um Cofre de Chaves.

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 do Cofre da Chave.

TemplateArtifact

Artefato de blueprint que implanta um modelo do Gerenciador de Recursos.

ArtifactList

Lista de artefatos de blueprint.

Name Tipo Description
nextLink

string

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

value Artifact[]:

Lista de artefatos de blueprint.

CloudError

Name Tipo Description
error

ErrorResponse

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

ErrorAdditionalInfo

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

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorResponse

Resposta de erro

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorResponse[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

keyVaultReference

Especifica o link para um Cofre de Chaves.

Name Tipo Description
id

string

ID de recurso do Azure do Cofre da Chave.

ParameterValue

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

Name Tipo Description
reference

SecretValueReference

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

value

object

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

PolicyAssignmentArtifact

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

Name Tipo Description
id

string

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

kind string:

policyAssignment

Especifica o tipo de artefato de blueprint.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefatos que precisam ser implantados antes do artefato especificado.

properties.description

string

maxLength: 500

Multi-linha explicar este recurso.

properties.displayName

string

maxLength: 256

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

properties.parameters

<string,  ParameterValue>

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 deste recurso.

RoleAssignmentArtifact

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

Name Tipo Description
id

string

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

kind string:

roleAssignment

Especifica o tipo de artefato de blueprint.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefatos que precisam ser implantados antes do artefato especificado.

properties.description

string

maxLength: 500

Multi-linha explicar este recurso.

properties.displayName

string

maxLength: 256

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

properties.principalIds

Matriz de identidades de usuário ou grupo no Azure Ative Directory. O roleDefinition será aplicado a cada identidade.

properties.resourceGroup

string

RoleAssignment será o escopo deste resourceGroup. Se estiver vazio, ele terá como escopo a assinatura.

properties.roleDefinitionId

string

ID de recurso do Azure da RoleDefinition.

type

string

Tipo deste recurso.

SecretValueReference

Referência a um segredo do Cofre da Chave.

Name Tipo Description
keyVault

keyVaultReference

Especifica a referência a um determinado Cofre de Chaves do Azure.

secretName

string

Nome do segredo.

secretVersion

string

A versão do segredo a usar. Se deixado em branco, a versão mais recente do segredo é usada.

TemplateArtifact

Artefato de blueprint que implanta um modelo do Gerenciador de Recursos.

Name Tipo Description
id

string

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

kind string:

template

Especifica o tipo de artefato de blueprint.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefatos que precisam ser implantados antes do artefato especificado.

properties.description

string

maxLength: 500

Multi-linha explicar este recurso.

properties.displayName

string

maxLength: 256

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

properties.parameters

<string,  ParameterValue>

Valores de parâmetros de artefato de modelo de blueprint do Gerenciador de Recursos.

properties.resourceGroup

string

Se aplicável, o nome do espaço reservado do grupo de recursos no qual o artefato de blueprint do modelo do Gerenciador de Recursos será implantado.

properties.template

object

O corpo do artefato de modelo de modelo do Gerenciador de Recursos.

type

string

Tipo deste recurso.