Udostępnij za pośrednictwem


Microsoft.VirtualMachineImages imageTemplates 2018-02-01-preview

Definicja zasobu Bicep

Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod Bicep do szablonu.

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

Obiekty ImageTemplateDistributor

Ustaw właściwość , aby określić typ obiektu.

W przypadku managedImageużyj:

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

W przypadku sharedImageużyj:

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

Obiekty ImageTemplateCustomizer

Ustaw właściwość , aby określić typ obiektu.

W przypadkupowłoki użyj polecenia:

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

Obiekty ImageTemplateSource

Ustaw właściwość , aby określić typ obiektu.

W przypadku ISO użyj:

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

W przypadku PlatformImageużyj:

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

Wartości właściwości

ImageTemplateCustomizer

Nazwa Opis Wartość
nazwa Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania struna
typ Ustaw wartość "shell" dla typu ImageTemplateShellCustomizer. "shell" (wymagane)

ImageTemplateDistributor

Nazwa Opis Wartość
artifactTags Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. ImageTemplateDistributorArtifactTags
runOutputName Nazwa, która ma być używana dla skojarzonego elementu RunOutput. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
typ Ustaw wartość "managedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "sharedImage" dla typu ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (wymagane)

ImageTemplateDistributorArtifactTags

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceURI Adres URL umożliwiający pobranie obrazu ISO. Ten adres URL musi być dostępny dla dostawcy zasobów w momencie utworzenia elementu imageTemplate. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (wymagane)

ImageTemplateManagedImageDistributor

Nazwa Opis Wartość
imageId Identyfikator zasobu obrazu dysku zarządzanego ciąg (wymagany)
lokalizacja Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje ciąg (wymagany)
typ Typ rozkładu. "managedImage" (wymagane)

ImageTemplatePlatformImageSource

Nazwa Opis Wartość
oferta Oferta obrazu z Azure Gallery Images. struna
wydawca Program Image Publisher w usłudze Azure Gallery Images. struna
Numer jednostki magazynowej Jednostka SKU obrazu z Obrazów z galerii platformy Azure. struna
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "PlatformImage" (wymagane)
Wersja Wersja obrazu z Obrazów z galerii platformy Azure. struna

ImageTemplateProperties

Nazwa Opis Wartość
Dostosuj Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. ImageTemplateCustomizer[]
rozdzielać Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. ImageTemplateDistributor[] (wymagane)
źródło Określa właściwości używane do opisywania obrazu źródłowego. ImageTemplateSource (wymagane)

ImageTemplateSharedImageDistributor

Nazwa Opis Wartość
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions string[] (wymagane)
typ Typ rozkładu. "sharedImage" (wymagane)

ImageTemplateShellCustomizer

Nazwa Opis Wartość
skrypt Skrypt powłoki do uruchomienia na potrzeby dostosowywania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. struna
typ Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer "shell" (wymagane)

ImageTemplateSource

Nazwa Opis Wartość
typ Ustaw wartość "ISO" dla typu ImageTemplateIsoSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (wymagane)

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
Właściwości ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Tagi zasobów

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Azure Image Builder z programem Azure Windows Baseline Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure.
Konfigurowanie usługi Dev Box Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box.

Definicja zasobu szablonu usługi ARM

Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod JSON do szablonu.

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

Obiekty ImageTemplateDistributor

Ustaw właściwość , aby określić typ obiektu.

W przypadku managedImageużyj:

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

W przypadku sharedImageużyj:

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

Obiekty ImageTemplateCustomizer

Ustaw właściwość , aby określić typ obiektu.

W przypadkupowłoki użyj polecenia:

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

Obiekty ImageTemplateSource

Ustaw właściwość , aby określić typ obiektu.

W przypadku ISO użyj:

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

W przypadku PlatformImageużyj:

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

Wartości właściwości

ImageTemplateCustomizer

Nazwa Opis Wartość
nazwa Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania struna
typ Ustaw wartość "shell" dla typu ImageTemplateShellCustomizer. "shell" (wymagane)

ImageTemplateDistributor

Nazwa Opis Wartość
artifactTags Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. ImageTemplateDistributorArtifactTags
runOutputName Nazwa, która ma być używana dla skojarzonego elementu RunOutput. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
typ Ustaw wartość "managedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "sharedImage" dla typu ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (wymagane)

ImageTemplateDistributorArtifactTags

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceURI Adres URL umożliwiający pobranie obrazu ISO. Ten adres URL musi być dostępny dla dostawcy zasobów w momencie utworzenia elementu imageTemplate. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (wymagane)

ImageTemplateManagedImageDistributor

Nazwa Opis Wartość
imageId Identyfikator zasobu obrazu dysku zarządzanego ciąg (wymagany)
lokalizacja Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje ciąg (wymagany)
typ Typ rozkładu. "managedImage" (wymagane)

ImageTemplatePlatformImageSource

Nazwa Opis Wartość
oferta Oferta obrazu z Azure Gallery Images. struna
wydawca Program Image Publisher w usłudze Azure Gallery Images. struna
Numer jednostki magazynowej Jednostka SKU obrazu z Obrazów z galerii platformy Azure. struna
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "PlatformImage" (wymagane)
Wersja Wersja obrazu z Obrazów z galerii platformy Azure. struna

ImageTemplateProperties

Nazwa Opis Wartość
Dostosuj Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. ImageTemplateCustomizer[]
rozdzielać Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. ImageTemplateDistributor[] (wymagane)
źródło Określa właściwości używane do opisywania obrazu źródłowego. ImageTemplateSource (wymagane)

ImageTemplateSharedImageDistributor

Nazwa Opis Wartość
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions string[] (wymagane)
typ Typ rozkładu. "sharedImage" (wymagane)

ImageTemplateShellCustomizer

Nazwa Opis Wartość
skrypt Skrypt powłoki do uruchomienia na potrzeby dostosowywania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. struna
typ Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer "shell" (wymagane)

ImageTemplateSource

Nazwa Opis Wartość
typ Ustaw wartość "ISO" dla typu ImageTemplateIsoSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (wymagane)

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2018-02-01-preview"
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
Właściwości ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.VirtualMachineImages/imageTemplates"

Tagi zasobów

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Azure Image Builder z programem Azure Windows Baseline

wdrażanie w usłudze Azure
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure.
Konfigurowanie usługi Dev Box

wdrażanie w usłudze Azure
Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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
      }
    }
  })
}

Obiekty ImageTemplateDistributor

Ustaw właściwość , aby określić typ obiektu.

W przypadku managedImageużyj:

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

W przypadku sharedImageużyj:

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

Obiekty ImageTemplateCustomizer

Ustaw właściwość , aby określić typ obiektu.

W przypadkupowłoki użyj polecenia:

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

Obiekty ImageTemplateSource

Ustaw właściwość , aby określić typ obiektu.

W przypadku ISO użyj:

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

W przypadku PlatformImageużyj:

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

Wartości właściwości

ImageTemplateCustomizer

Nazwa Opis Wartość
nazwa Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania struna
typ Ustaw wartość "shell" dla typu ImageTemplateShellCustomizer. "shell" (wymagane)

ImageTemplateDistributor

Nazwa Opis Wartość
artifactTags Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. ImageTemplateDistributorArtifactTags
runOutputName Nazwa, która ma być używana dla skojarzonego elementu RunOutput. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
typ Ustaw wartość "managedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "sharedImage" dla typu ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (wymagane)

ImageTemplateDistributorArtifactTags

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceURI Adres URL umożliwiający pobranie obrazu ISO. Ten adres URL musi być dostępny dla dostawcy zasobów w momencie utworzenia elementu imageTemplate. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (wymagane)

ImageTemplateManagedImageDistributor

Nazwa Opis Wartość
imageId Identyfikator zasobu obrazu dysku zarządzanego ciąg (wymagany)
lokalizacja Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje ciąg (wymagany)
typ Typ rozkładu. "managedImage" (wymagane)

ImageTemplatePlatformImageSource

Nazwa Opis Wartość
oferta Oferta obrazu z Azure Gallery Images. struna
wydawca Program Image Publisher w usłudze Azure Gallery Images. struna
Numer jednostki magazynowej Jednostka SKU obrazu z Obrazów z galerii platformy Azure. struna
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "PlatformImage" (wymagane)
Wersja Wersja obrazu z Obrazów z galerii platformy Azure. struna

ImageTemplateProperties

Nazwa Opis Wartość
Dostosuj Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. ImageTemplateCustomizer[]
rozdzielać Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. ImageTemplateDistributor[] (wymagane)
źródło Określa właściwości używane do opisywania obrazu źródłowego. ImageTemplateSource (wymagane)

ImageTemplateSharedImageDistributor

Nazwa Opis Wartość
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions string[] (wymagane)
typ Typ rozkładu. "sharedImage" (wymagane)

ImageTemplateShellCustomizer

Nazwa Opis Wartość
skrypt Skrypt powłoki do uruchomienia na potrzeby dostosowywania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. struna
typ Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer "shell" (wymagane)

ImageTemplateSource

Nazwa Opis Wartość
typ Ustaw wartość "ISO" dla typu ImageTemplateIsoSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (wymagane)

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_]{1,64}$ (wymagane)
Właściwości ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"

Tagi zasobów

Nazwa Opis Wartość