Microsoft.VirtualMachineImages imageTemplates 2018-02-01-preview
Definicja zasobu Bicep
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
source: {
type: 'string'
// For remaining properties, see ImageTemplateSource objects
}
}
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku powłoki użyj:
type: 'shell'
script: 'string'
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku funkcji managedImage użyj:
type: 'managedImage'
imageId: 'string'
location: 'string'
W przypadku funkcji sharedImage użyj:
type: 'sharedImage'
galleryImageId: 'string'
replicationRegions: [
'string'
]
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku normy ISO użyj:
type: 'ISO'
sha256Checksum: 'string'
sourceURI: 'string'
W przypadku platformyImage użyj:
type: 'PlatformImage'
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja zasobu | ciąg (wymagany) |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| properties | ImageTemplateProperties |
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[] |
| Rozpowszechniać | Cele dystrybucji, w których dane wyjściowe obrazu muszą przejść do. | ImageTemplateDistributor[] (wymagane) |
| source | Określa właściwości używane do opisywania obrazu źródłowego. | ImageTemplateSource (wymagane) |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | powłoka (wymagana) |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer | "shell" (wymagane) |
| skrypt | Skrypt powłoki, który ma zostać uruchomiony w celu dostosowania. Może to być link usługi GitHub, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | managedImage sharedImage (wymagane) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "managedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "sharedImage" (wymagane) |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | string[] (wymagane) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ISO PlatformImage (wymagane) |
ImageTemplateIsoSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ISO" (wymagane) |
| 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) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| Wersja | Wersja obrazu z obrazów galerii platformy Azure. | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Program Azure Image Builder z punktem odniesienia systemu Windows platformy Azure |
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi Aktualizacje 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. Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com w celu utworzenia pierwszego urządzenia Dev Box. |
Definicja zasobu szablonu usługi ARM
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"source": {
"type": "string"
// For remaining properties, see ImageTemplateSource objects
}
}
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku powłoki użyj:
"type": "shell",
"script": "string"
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu managedImage użyj:
"type": "managedImage",
"imageId": "string",
"location": "string"
W przypadku elementu sharedImage użyj:
"type": "sharedImage",
"galleryImageId": "string",
"replicationRegions": [ "string" ]
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku standardu ISO użyj:
"type": "ISO",
"sha256Checksum": "string",
"sourceURI": "string"
W przypadku platformyImage użyj:
"type": "PlatformImage",
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | Wersja interfejsu API zasobów | "2018-02-01-preview" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja zasobu | ciąg (wymagany) |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| properties | Właściwości imageTemplateProperties |
Właściwości 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[] |
| Rozpowszechniać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
| source | Określa właściwości używane do opisania obrazu źródłowego. | ImageTemplateSource (wymagane) |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | powłoka (wymagane) |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer | "shell" (wymagane) |
| 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. | ciąg |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | managedImage sharedImage (wymagane) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "managedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "sharedImage" (wymagane) |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | string[] (wymagane) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ISO PlatformImage (wymagane) |
ImageTemplateIsoSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ISO" (wymagane) |
| 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) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| Wersja | Wersja obrazu z obrazów galerii platformy Azure. | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Program Azure Image Builder z punktem odniesienia systemu Windows platformy Azure |
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi Aktualizacje 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. Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com w celu utworzenia pierwszego urządzenia Dev Box. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący element Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
source = {
type = "string"
// For remaining properties, see ImageTemplateSource objects
}
}
})
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku powłoki użyj:
type = "shell"
script = "string"
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu managedImage użyj:
type = "managedImage"
imageId = "string"
location = "string"
W przypadku elementu sharedImage użyj:
type = "sharedImage"
galleryImageId = "string"
replicationRegions = [
"string"
]
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku standardu ISO użyj:
type = "ISO"
sha256Checksum = "string"
sourceURI = "string"
W przypadku platformyImage użyj:
type = "PlatformImage"
offer = "string"
publisher = "string"
sku = "string"
version = "string"
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja zasobu | ciąg (wymagany) |
| parent_id | Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. |
| properties | Właściwości imageTemplateProperties |
Właściwości 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[] |
| Rozpowszechniać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
| source | Określa właściwości używane do opisania obrazu źródłowego. | ImageTemplateSource (wymagane) |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | powłoka (wymagane) |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "powłoka" może być shellCustomizer | "shell" (wymagane) |
| 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. | ciąg |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | managedImage sharedImage (wymagane) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "managedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "sharedImage" (wymagane) |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | string[] (wymagane) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ISO PlatformImage (wymagane) |
ImageTemplateIsoSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ISO" (wymagane) |
| 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) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| Wersja | Wersja obrazu z obrazów galerii platformy Azure. | ciąg |