Partilhar via


Artifacts - Create Or Update

Crie ou atualize o artefato do blueprint.

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

Parâmetros do URI

Name Em Necessário Tipo Description
artifactName
path True

string

Nome do artefato de esquema.

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}').

api-version
query True

string

Versão da API do cliente.

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name Description
PolicyAssignmentArtifact

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

RoleAssignmentArtifact

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

TemplateArtifact

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

PolicyAssignmentArtifact

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

Name Necessário Tipo Description
kind True string:

policyAssignment

Especifica o tipo de artefato de blueprint.

properties.parameters True

<string,  ParameterValue>

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

properties.policyDefinitionId True

string

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

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.resourceGroup

string

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

RoleAssignmentArtifact

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

Name Necessário Tipo Description
kind True string:

roleAssignment

Especifica o tipo de artefato de blueprint.

properties.principalIds True

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

properties.roleDefinitionId True

string

ID de recurso do Azure da RoleDefinition.

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.resourceGroup

string

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

TemplateArtifact

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

Name Necessário Tipo Description
kind True string:

template

Especifica o tipo de artefato de blueprint.

properties.parameters True

<string,  ParameterValue>

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

properties.template True

object

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

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

Respostas

Name Tipo Description
201 Created Artifact:

Criado -- artefato de blueprint criado/atualizado.

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-ARMTemplateArtifact
MG-PolicyAssignmentArtifact
MG-RoleAssignmentArtifact
Sub-ARMTemplateArtifact
Sub-PolicyAssignmentArtifact
Sub-RoleAssignmentArtifact

MG-ARMTemplateArtifact

Pedido de amostra

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

{
  "kind": "template",
  "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')]"
      }
    }
  }
}

Resposta da amostra

{
  "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/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

MG-PolicyAssignmentArtifact

Pedido de amostra

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

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

Resposta da amostra

{
  "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/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

MG-RoleAssignmentArtifact

Pedido de amostra

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

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Resposta da amostra

{
  "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/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Sub-ARMTemplateArtifact

Pedido de amostra

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate?api-version=2018-11-01-preview

{
  "kind": "template",
  "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')]"
      }
    }
  }
}

Resposta da amostra

{
  "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/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

Sub-PolicyAssignmentArtifact

Pedido de amostra

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy?api-version=2018-11-01-preview

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

Resposta da amostra

{
  "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/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

Sub-RoleAssignmentArtifact

Pedido de amostra

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Resposta da amostra

{
  "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/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Definições

Name Description
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.

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.