Compartilhar via


Microsoft.VirtualMachineImages imageTemplates 2018-02-01-preview

Definição de recurso do Bicep

O tipo de recurso imageTemplates pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos ImageTemplateCustomizer

Defina a propriedade type para especificar o tipo de objeto.

Para shell, use:

{
  script: 'string'
  type: 'shell'
}

Objetos ImageTemplateSource

Defina a propriedade type para especificar o tipo de objeto.

Para ISO, use:

{
  sha256Checksum: 'string'
  sourceURI: 'string'
  type: 'ISO'
}

Para PlatformImage, use:

{
  offer: 'string'
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

Objetos ImageTemplateDistributor

Defina a propriedade type para especificar o tipo de objeto.

Para managedImage, use:

{
  imageId: 'string'
  location: 'string'
  type: 'managedImage'
}

Para sharedImage, use:

{
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  type: 'sharedImage'
}

Valores de propriedade

Microsoft.VirtualMachineImages/imageTemplates

Nome Descrição Valor
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
propriedades ImageTemplateProperties
etiquetas Etiquetas de recursos Dicionário de nomes e valores de tags. Ver Marcas em modelos

Personalizador de modelo de imagem

Nome Descrição Valor
nome Nome Amigável para fornecer contexto sobre o que essa etapa de personalização faz cadeia
tipo Defina como 'shell' para o tipo ImageTemplateShellCustomizer. 'shell' (obrigatório)

Distribuidor de ImageTemplate

Nome Descrição Valor
artifactTags Marcas que serão aplicadas ao artefato depois que ele tiver sido criado/atualizado pelo distribuidor. ImageTemplateDistributorArtifactTags
runNome_da_saída O nome a ser usado para o RunOutput associado. cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
tipo Defina como 'managedImage' para o tipo ImageTemplateManagedImageDistributor. Defina como 'sharedImage' para o tipo ImageTemplateSharedImageDistributor. 'imagem gerenciada'
'sharedImage' (obrigatório)

ImageTemplateDistributorArtifactTags

Nome Descrição Valor

ImageTemplateIsoSource

Nome Descrição Valor
sha256Soma de verificação Soma de verificação SHA256 da imagem ISO. cadeia de caracteres (obrigatório)
sourceURI URL para obter a imagem ISO. Essa URL deve ser acessível ao provedor de recursos no momento da criação do imageTemplate. cadeia de caracteres (obrigatório)
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'ISO' (obrigatório)

ImageTemplateManagedImageDistributor

Nome Descrição Valor
ID da imagem ID do recurso da imagem de disco gerenciado cadeia de caracteres (obrigatório)
local O local do Azure para a imagem deve corresponder se a imagem já existir cadeia de caracteres (obrigatório)
tipo Tipo de distribuição. 'managedImage' (obrigatório)

ImageTemplatePlatformImageSource

Nome Descrição Valor
oferta Oferta de imagem das Imagens da Galeria do Azure. cadeia
desenvolvedor Editor de Imagens nas Imagens da Galeria do Azure. cadeia
Sku SKU de imagem das Imagens da Galeria do Azure. cadeia
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'PlatformImage' (obrigatório)
versão Versão da imagem das Imagens da Galeria do Azure. cadeia

Propriedades do modelo de imagem

Nome Descrição Valor
personalizar Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc. ImageTemplateCustomizer []
distribuir A distribuição é direcionada para onde a saída da imagem precisa ir. ImageTemplateDistributor[] (obrigatório)
fonte Especifica as propriedades usadas para descrever a imagem de origem. ImageTemplateSource (obrigatório)

ImageTemplateSharedImageDistributor

Nome Descrição Valor
galleryImageId ID do recurso da imagem da Galeria de Imagens Compartilhadas cadeia de caracteres (obrigatório)
regiões de replicação string[] (obrigatório)
tipo Tipo de distribuição. 'sharedImage' (obrigatório)

ImageTemplateShellCustomizer

Nome Descrição Valor
script O script de shell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc. cadeia
tipo O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "shell" pode ser shellCustomizer 'shell' (obrigatório)

ImageTemplateSource

Nome Descrição Valor
tipo Defina como 'ISO' para o tipo ImageTemplateIsoSource. Defina como 'PlatformImage' para o tipo ImageTemplatePlatformImageSource. 'ISO'
'PlatformImage' (obrigatório)

Tags de recursos

Nome Descrição Valor

Exemplos de uso

Módulos verificados do Azure

Os módulos verificados do Azure a seguir podem ser usados para implantar esse tipo de recurso.

Módulo Descrição
Modelo de imagem de máquina virtual Módulo de recurso AVM para modelo de imagem de máquina virtual

Exemplos de Início Rápido do Azure

Os seguintes modelos de Início Rápido do Azure contêm exemplos do Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
Construtor de Imagens do Azure com a Linha de Base do Windows do Azure Cria um ambiente do Construtor de Imagens do Azure e cria uma imagem do Windows Server com as atualizações mais recentes do Windows e a Linha de Base do Windows do Azure aplicadas.
Configurar o serviço Dev Box Esse modelo criaria todos os recursos de administrador do Dev Box de acordo com o guia de início rápido do Dev Box (/azure/dev-box/quickstart-create-dev-box). Você pode exibir todos os recursos criados ou ir diretamente para DevPortal.microsoft.com para criar sua primeira Caixa de Desenvolvimento.

Definição de recurso de modelo do ARM

O tipo de recurso imageTemplates pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2018-02-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "customize": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateCustomizer objects
    } ],
    "distribute": [ {
      "artifactTags": {
        "{customized property}": "string"
      },
      "runOutputName": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateDistributor objects
    } ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos ImageTemplateCustomizer

Defina a propriedade type para especificar o tipo de objeto.

Para shell, use:

{
  "script": "string",
  "type": "shell"
}

Objetos ImageTemplateSource

Defina a propriedade type para especificar o tipo de objeto.

Para ISO, use:

{
  "sha256Checksum": "string",
  "sourceURI": "string",
  "type": "ISO"
}

Para PlatformImage, use:

{
  "offer": "string",
  "publisher": "string",
  "sku": "string",
  "type": "PlatformImage",
  "version": "string"
}

Objetos ImageTemplateDistributor

Defina a propriedade type para especificar o tipo de objeto.

Para managedImage, use:

{
  "imageId": "string",
  "location": "string",
  "type": "managedImage"
}

Para sharedImage, use:

{
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "type": "sharedImage"
}

Valores de propriedade

Microsoft.VirtualMachineImages/imageTemplates

Nome Descrição Valor
apiVersion A versão da API '2018-02-01-preview'
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
propriedades ImageTemplateProperties
etiquetas Etiquetas de recursos Dicionário de nomes e valores de tags. Ver Marcas em modelos
tipo O tipo de recurso 'Microsoft.VirtualMachineImages/imageTemplates'

Personalizador de modelo de imagem

Nome Descrição Valor
nome Nome Amigável para fornecer contexto sobre o que essa etapa de personalização faz cadeia
tipo Defina como 'shell' para o tipo ImageTemplateShellCustomizer. 'shell' (obrigatório)

Distribuidor de ImageTemplate

Nome Descrição Valor
artifactTags Marcas que serão aplicadas ao artefato depois que ele tiver sido criado/atualizado pelo distribuidor. ImageTemplateDistributorArtifactTags
runNome_da_saída O nome a ser usado para o RunOutput associado. cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
tipo Defina como 'managedImage' para o tipo ImageTemplateManagedImageDistributor. Defina como 'sharedImage' para o tipo ImageTemplateSharedImageDistributor. 'imagem gerenciada'
'sharedImage' (obrigatório)

ImageTemplateDistributorArtifactTags

Nome Descrição Valor

ImageTemplateIsoSource

Nome Descrição Valor
sha256Soma de verificação Soma de verificação SHA256 da imagem ISO. cadeia de caracteres (obrigatório)
sourceURI URL para obter a imagem ISO. Essa URL deve ser acessível ao provedor de recursos no momento da criação do imageTemplate. cadeia de caracteres (obrigatório)
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'ISO' (obrigatório)

ImageTemplateManagedImageDistributor

Nome Descrição Valor
ID da imagem ID do recurso da imagem de disco gerenciado cadeia de caracteres (obrigatório)
local O local do Azure para a imagem deve corresponder se a imagem já existir cadeia de caracteres (obrigatório)
tipo Tipo de distribuição. 'managedImage' (obrigatório)

ImageTemplatePlatformImageSource

Nome Descrição Valor
oferta Oferta de imagem das Imagens da Galeria do Azure. cadeia
desenvolvedor Editor de Imagens nas Imagens da Galeria do Azure. cadeia
Sku SKU de imagem das Imagens da Galeria do Azure. cadeia
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'PlatformImage' (obrigatório)
versão Versão da imagem das Imagens da Galeria do Azure. cadeia

Propriedades do modelo de imagem

Nome Descrição Valor
personalizar Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc. ImageTemplateCustomizer []
distribuir A distribuição é direcionada para onde a saída da imagem precisa ir. ImageTemplateDistributor[] (obrigatório)
fonte Especifica as propriedades usadas para descrever a imagem de origem. ImageTemplateSource (obrigatório)

ImageTemplateSharedImageDistributor

Nome Descrição Valor
galleryImageId ID do recurso da imagem da Galeria de Imagens Compartilhadas cadeia de caracteres (obrigatório)
regiões de replicação string[] (obrigatório)
tipo Tipo de distribuição. 'sharedImage' (obrigatório)

ImageTemplateShellCustomizer

Nome Descrição Valor
script O script de shell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc. cadeia
tipo O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "shell" pode ser shellCustomizer 'shell' (obrigatório)

ImageTemplateSource

Nome Descrição Valor
tipo Defina como 'ISO' para o tipo ImageTemplateIsoSource. Defina como 'PlatformImage' para o tipo ImageTemplatePlatformImageSource. 'ISO'
'PlatformImage' (obrigatório)

Tags de recursos

Nome Descrição Valor

Exemplos de uso

Modelos de Início Rápido do Azure

Os seguintes modelos de Início Rápido do Azure implantam esse tipo de recurso.

Modelo Descrição
Construtor de Imagens do Azure com a Linha de Base do Windows do Azure

Implantar no Azure
Cria um ambiente do Construtor de Imagens do Azure e cria uma imagem do Windows Server com as atualizações mais recentes do Windows e a Linha de Base do Windows do Azure aplicadas.
Configurar o serviço Dev Box

Implantar no Azure
Esse modelo criaria todos os recursos de administrador do Dev Box de acordo com o guia de início rápido do Dev Box (/azure/dev-box/quickstart-create-dev-box). Você pode exibir todos os recursos criados ou ir diretamente para DevPortal.microsoft.com para criar sua primeira Caixa de Desenvolvimento.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso imageTemplates pode ser implantado com operações de destino:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {
            {customized property} = "string"
          }
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
    }
  }
}

Objetos ImageTemplateCustomizer

Defina a propriedade type para especificar o tipo de objeto.

Para shell, use:

{
  script = "string"
  type = "shell"
}

Objetos ImageTemplateSource

Defina a propriedade type para especificar o tipo de objeto.

Para ISO, use:

{
  sha256Checksum = "string"
  sourceURI = "string"
  type = "ISO"
}

Para PlatformImage, use:

{
  offer = "string"
  publisher = "string"
  sku = "string"
  type = "PlatformImage"
  version = "string"
}

Objetos ImageTemplateDistributor

Defina a propriedade type para especificar o tipo de objeto.

Para managedImage, use:

{
  imageId = "string"
  location = "string"
  type = "managedImage"
}

Para sharedImage, use:

{
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  type = "sharedImage"
}

Valores de propriedade

Microsoft.VirtualMachineImages/imageTemplates

Nome Descrição Valor
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
propriedades ImageTemplateProperties
etiquetas Etiquetas de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"

Personalizador de modelo de imagem

Nome Descrição Valor
nome Nome Amigável para fornecer contexto sobre o que essa etapa de personalização faz cadeia
tipo Defina como 'shell' para o tipo ImageTemplateShellCustomizer. 'shell' (obrigatório)

Distribuidor de ImageTemplate

Nome Descrição Valor
artifactTags Marcas que serão aplicadas ao artefato depois que ele tiver sido criado/atualizado pelo distribuidor. ImageTemplateDistributorArtifactTags
runNome_da_saída O nome a ser usado para o RunOutput associado. cadeia de caracteres

Restrições:
Padrão = ^[A-Za-z0-9-_]{1,64}$ (obrigatório)
tipo Defina como 'managedImage' para o tipo ImageTemplateManagedImageDistributor. Defina como 'sharedImage' para o tipo ImageTemplateSharedImageDistributor. 'imagem gerenciada'
'sharedImage' (obrigatório)

ImageTemplateDistributorArtifactTags

Nome Descrição Valor

ImageTemplateIsoSource

Nome Descrição Valor
sha256Soma de verificação Soma de verificação SHA256 da imagem ISO. cadeia de caracteres (obrigatório)
sourceURI URL para obter a imagem ISO. Essa URL deve ser acessível ao provedor de recursos no momento da criação do imageTemplate. cadeia de caracteres (obrigatório)
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'ISO' (obrigatório)

ImageTemplateManagedImageDistributor

Nome Descrição Valor
ID da imagem ID do recurso da imagem de disco gerenciado cadeia de caracteres (obrigatório)
local O local do Azure para a imagem deve corresponder se a imagem já existir cadeia de caracteres (obrigatório)
tipo Tipo de distribuição. 'managedImage' (obrigatório)

ImageTemplatePlatformImageSource

Nome Descrição Valor
oferta Oferta de imagem das Imagens da Galeria do Azure. cadeia
desenvolvedor Editor de Imagens nas Imagens da Galeria do Azure. cadeia
Sku SKU de imagem das Imagens da Galeria do Azure. cadeia
tipo Especifica o tipo de imagem de origem com a qual você deseja começar. 'PlatformImage' (obrigatório)
versão Versão da imagem das Imagens da Galeria do Azure. cadeia

Propriedades do modelo de imagem

Nome Descrição Valor
personalizar Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc. ImageTemplateCustomizer []
distribuir A distribuição é direcionada para onde a saída da imagem precisa ir. ImageTemplateDistributor[] (obrigatório)
fonte Especifica as propriedades usadas para descrever a imagem de origem. ImageTemplateSource (obrigatório)

ImageTemplateSharedImageDistributor

Nome Descrição Valor
galleryImageId ID do recurso da imagem da Galeria de Imagens Compartilhadas cadeia de caracteres (obrigatório)
regiões de replicação string[] (obrigatório)
tipo Tipo de distribuição. 'sharedImage' (obrigatório)

ImageTemplateShellCustomizer

Nome Descrição Valor
script O script de shell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc. cadeia
tipo O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "shell" pode ser shellCustomizer 'shell' (obrigatório)

ImageTemplateSource

Nome Descrição Valor
tipo Defina como 'ISO' para o tipo ImageTemplateIsoSource. Defina como 'PlatformImage' para o tipo ImageTemplatePlatformImageSource. 'ISO'
'PlatformImage' (obrigatório)

Tags de recursos

Nome Descrição Valor