Partilhar via


Published Artifacts - List

Listar artefactos para uma versão de uma definição de esquema 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 esquema.

resourceScope
path True

string

O âmbito do recurso. Os âmbitos válidos são: grupo de gestão (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscrição (formato: '/subscriptions/{subscriptionId}').

versionId
path True

string

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

api-version
query True

string

Versão da API de Cliente.

Respostas

Name Tipo Description
200 OK

ArtifactList

OK – artefactos de uma versão da definição de esquema publicada obtida.

Other Status Codes

CloudError

Resposta de erro de esquemas.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name Description
user_impersonation representar 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 artefactos de esquema.

CloudError
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorResponse

Resposta a Erros

keyVaultReference

Especifica a ligação para um Key Vault.

ParameterValue

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

PolicyAssignmentArtifact

Artefacto de esquema que aplica uma atribuição de Política.

RoleAssignmentArtifact

Artefacto de esquema que aplica uma atribuição de Função.

SecretValueReference

Referência a um segredo Key Vault.

TemplateArtifact

Artefacto de esquema que implementa um modelo de Resource Manager.

ArtifactList

Lista de artefactos de esquema.

Name Tipo Description
nextLink

string

Ligar à página seguinte dos resultados.

value Artifact[]:

Lista de artefactos de esquema.

CloudError

Name Tipo Description
error

ErrorResponse

Resposta a Erros
Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informações adicionais.

ErrorResponse

Resposta a Erros

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

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 a ligação para um Key Vault.

Name Tipo Description
id

string

ID de recurso do Azure do Key Vault.

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, números e booleanos.

PolicyAssignmentArtifact

Artefacto de esquema que aplica uma atribuição de Política.

Name Tipo Description
id

string

ID de cadeia utilizado para localizar qualquer recurso no Azure.

kind string:

policyAssignment

Especifica o tipo de artefacto de esquema.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefactos que precisam de ser implementados antes do artefacto especificado.

properties.description

string

Explicar este recurso com várias linhas.

properties.displayName

string

A cadeia de linha única explica este recurso.

properties.parameters

<string,  ParameterValue>

Valores de parâmetros 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 marcador de posição do grupo de recursos ao qual a política será atribuída.

type

string

Tipo deste recurso.

RoleAssignmentArtifact

Artefacto de esquema que aplica uma atribuição de Função.

Name Tipo Description
id

string

ID de cadeia utilizado para localizar qualquer recurso no Azure.

kind string:

roleAssignment

Especifica o tipo de artefacto de esquema.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefactos que precisam de ser implementados antes do artefacto especificado.

properties.description

string

Explicar este recurso com várias linhas.

properties.displayName

string

A cadeia de linha única explica este recurso.

properties.principalIds

Matriz de identidades de utilizador ou grupo no Azure Active Directory. A roleDefinition será aplicada a cada identidade.

properties.resourceGroup

string

RoleAssignment será o âmbito deste resourceGroup. Se estiver vazio, será confinado à subscrição.

properties.roleDefinitionId

string

ID de recurso do Azure da RoleDefinition.

type

string

Tipo deste recurso.

SecretValueReference

Referência a um segredo Key Vault.

Name Tipo Description
keyVault

keyVaultReference

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

secretName

string

Nome do segredo.

secretVersion

string

A versão do segredo a utilizar. Se for deixada em branco, é utilizada a versão mais recente do segredo.

TemplateArtifact

Artefacto de esquema que implementa um modelo de Resource Manager.

Name Tipo Description
id

string

ID de cadeia utilizado para localizar qualquer recurso no Azure.

kind string:

template

Especifica o tipo de artefacto de esquema.

name

string

Nome deste recurso.

properties.dependsOn

string[]

Artefactos que precisam de ser implementados antes do artefacto especificado.

properties.description

string

Explicar este recurso com várias linhas.

properties.displayName

string

A cadeia de linha única explica este recurso.

properties.parameters

<string,  ParameterValue>

Resource Manager valores de parâmetros de artefactos de esquema de modelo.

properties.resourceGroup

string

Se aplicável, o nome do marcador de posição do grupo de recursos no qual o artefacto de esquema de modelo Resource Manager será implementado.

properties.template

object

O Resource Manager corpo do artefacto do esquema do modelo.

type

string

Tipo deste recurso.