Microsoft.VirtualMachineImages imageTemplates
Bicep-resourcedefinitie
Het resourcetype imageTemplates kan worden geïmplementeerd voor:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.VirtualMachineImages/imageTemplates wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2022-02-14' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
buildTimeoutInMinutes: int
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
}
stagingResourceGroup: 'string'
validate: {
continueDistributeOnFailure: bool
inVMValidations: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateInVMValidator objects
}
]
sourceValidationOnly: bool
}
vmProfile: {
osDiskSizeGB: int
userAssignedIdentities: [
'string'
]
vmSize: 'string'
vnetConfig: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Gebruik voor PowerShell:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Gebruik voor Shell:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Voor WindowsRestart gebruikt u:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Voor WindowsUpdate gebruikt u:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Gebruik voor SharedImage:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
Gebruik voor VHD:
type: 'VHD'
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
type: 'ManagedImage'
imageId: 'string'
Gebruik voor PlatformImage:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
Gebruik voor SharedImageVersion:
type: 'SharedImageVersion'
imageVersionId: 'string'
ImageTemplateInVMValidator-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor PowerShell:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Gebruik voor Shell:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Eigenschapswaarden
imageTemplates
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| identity | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity (vereist) |
| properties | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties |
ImageTemplateIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type 'Geen' worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | 'Geen' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | object |
ImageTemplateProperties
| Naam | Description | Waarde |
|---|---|---|
| buildTimeoutInMinutes | Maximale wachttijd tijdens het bouwen van de installatiekopieënsjabloon (inclusief alle aanpassingen, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (4 uur). | int |
| Aanpassen | Hiermee geeft u de eigenschappen op die worden gebruikt om de aanpassingsstappen van de afbeelding te beschrijven, zoals Afbeeldingsbron, enzovoort | ImageTemplateCustomizer[] |
| Distribueren | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
| source | Hiermee geeft u de eigenschappen die worden gebruikt om de broninstallatiekopieën te beschrijven. | ImageTemplateSource (vereist) |
| stagingResourceGroup | De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze gemaakt met dezelfde naam. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources die in de resourcegroep zijn gemaakt, verwijderd tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf bestaan. | tekenreeks |
| valideren | Configuratieopties en een lijst met validaties die moeten worden uitgevoerd op de resulterende installatiekopieën. | ImageTemplatePropertiesValidate |
| vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context op te geven over wat deze aanpassingsstap doet | tekenreeks |
| type | Het objecttype instellen | File PowerShell Shell Windows Opnieuw starten WindowsUpdate (vereist) |
ImageTemplateFileCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Bestand' (vereist) |
| doel | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VM | tekenreeks |
| sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande sourceUri-veld | tekenreeks |
| sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VM. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
ImageTemplatePowerShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'PowerShell' (vereist) |
| inline | Matrix met PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Shell' (vereist) |
| inline | Matrix met shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateRestartCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsRestart' (vereist) |
| restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | tekenreeks |
| restartCommand | Opdracht om opnieuw opstarten uit te voeren [Standaard: 'shutdown /r /f /t 0 /c "packer restart"'] | tekenreeks |
| restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | tekenreeks |
ImageTemplateWindowsUpdateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'WindowsUpdate' (vereist) |
| filters | Matrix van filters om toe te passen updates te selecteren. Laat een lege matrix weg of geef deze op als u de standaardwaarde wilt gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks[] |
| searchCriteria | Criteria voor het zoeken naar updates. Laat een lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (alles doorzoeken). Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks |
| updateLimit | Maximum aantal updates dat tegelijk moet worden toegepast. 0 weglaten of opgeven om de standaardwaarde (1000) te gebruiken | int |
ImageTemplateDistributor
| Naam | Description | Waarde |
|---|---|---|
| artifactTags | Tags die worden toegepast op het artefact zodra het is gemaakt/bijgewerkt door de distributeur. | object |
| runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | tekenreeks (vereist) |
| type | Het objecttype instellen | ManagedImage SharedImage VHD (vereist) |
ImageTemplateManagedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | ManagedImage (vereist) |
| imageId | Resource-id van de beheerde schijfinstallatiekopieën | tekenreeks (vereist) |
| location | De Azure-locatie voor de installatiekopieën moet overeenkomen met als de installatiekopieën al bestaan | tekenreeks (vereist) |
ImageTemplateSharedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | 'SharedImage' (vereist) |
| excludeFromLatest | Vlag die aangeeft of de versie van de gemaakte installatiekopieën moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde te gebruiken (onwaar). | booleaans |
| galleryImageId | Resource-id van de Shared Image Gallery-installatiekopieën | tekenreeks (vereist) |
| replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
| storageAccountType | Het type opslagaccount dat moet worden gebruikt om de gedeelde installatiekopieën op te slaan. Weglaten om de standaardwaarde (Standard_LRS) te gebruiken. | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | 'VHD' (vereist) |
ImageTemplateSource
| Naam | Description | Waarde |
|---|---|---|
| type | Het objecttype instellen | ManagedImage PlatformImage SharedImageVersion (vereist) |
ImageTemplateManagedImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | ManagedImage (vereist) |
| imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
ImageTemplatePlatformImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | 'PlatformImage' (vereist) |
| offer | Afbeeldingsaanbieding uit de Azure Gallery-installatiekopieën. | tekenreeks |
| planInfo | Optionele configuratie van aankoopplan voor platforminstallatiekopieën. | PlatformImagePurchasePlan |
| publisher | Afbeeldingsuitgever in Azure Gallery-installatiekopieën. | tekenreeks |
| sku | Installatiekopieën-SKU uit de Azure Gallery-installatiekopieën. | tekenreeks |
| versie | Installatiekopieënversie van de Azure Gallery-installatiekopieën. Als hier 'meest recente' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. | tekenreeks |
PlatformImagePurchasePlan
| Naam | Description | Waarde |
|---|---|---|
| planName | Naam van het aankoopplan. | tekenreeks (vereist) |
| planProduct | Product van het aankoopplan. | tekenreeks (vereist) |
| planPublisher | Uitgever van het aankoopplan. | tekenreeks (vereist) |
ImageTemplateSharedImageVersionSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | 'SharedImageVersion' (vereist) |
| imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
ImageTemplatePropertiesValidate
| Naam | Description | Waarde |
|---|---|---|
| continueDistributeOnFailure | Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is de standaardinstelling. Als de validatie mislukt en dit veld is ingesteld op true, worden de uitvoerafbeeldingen nog steeds gedistribueerd. Wees voorzichtig met deze optie, omdat dit ertoe kan leiden dat beschadigde afbeeldingen worden gedistribueerd voor gebruik. In beide gevallen (waar of onwaar), wordt de end-to-end-installatiekopie uitgevoerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] | booleaans |
| inVMValidations | Lijst met validaties die moeten worden uitgevoerd. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie 'bron' rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. | booleaans |
ImageTemplateInVMValidator
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context te geven over wat deze validatiestap doet | tekenreeks |
| type | Het objecttype instellen | PowerShell Shell (vereist) |
ImageTemplatePowerShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | 'PowerShell' (vereist) |
| inline | Matrix van PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | 'Shell' (vereist) |
| inline | Matrix met shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateVmProfile
| Naam | Description | Waarde |
|---|---|---|
| osDiskSizeGB | Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardschijfgrootte van het besturingssysteem van Azure te gebruiken. | int |
| userAssignedIdentities | Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon omvatten. | tekenreeks[] |
| vmSize | Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat de lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_D1_v2 voor Gen1-installatiekopieën en Standard_D2ds_v4 voor Gen2-installatiekopieën). | tekenreeks |
| vnetConfig | Optionele configuratie van het virtuele netwerk dat moet worden gebruikt om de build-VM en validatie-VM in te implementeren. Weglaten als er geen specifiek virtueel netwerk hoeft te worden gebruikt. | VirtualNetworkConfig |
VirtualNetworkConfig
| Naam | Description | Waarde |
|---|---|---|
| proxyVmSize | Grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Laat de tekenreeks weg of geef een lege tekenreeks op om de standaardreeks te gebruiken (Standard_A1_v2). | tekenreeks |
| subnetId | Resource-id van een bestaand subnet. | tekenreeks |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Azure Image Builder met Azure Windows Baseline |
Hiermee maakt u een Azure Image Builder-omgeving en bouwt u een Windows Server-installatiekopieën waarop de meest recente Windows Updates en Azure Windows Baseline zijn toegepast. |
| Dev Box-service configureren |
Met deze sjabloon worden alle Dev Box-beheerresources gemaakt volgens de snelstartgids voor Dev Box. U kunt alle gemaakte resources bekijken of rechtstreeks naar DevPortal.microsoft.com gaan om uw eerste Dev Box te maken. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype imageTemplates kan worden geïmplementeerd voor:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.VirtualMachineImages/imageTemplates-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2022-02-14",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"buildTimeoutInMinutes": "int",
"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
},
"stagingResourceGroup": "string",
"validate": {
"continueDistributeOnFailure": "bool",
"inVMValidations": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateInVMValidator objects
}
],
"sourceValidationOnly": "bool"
},
"vmProfile": {
"osDiskSizeGB": "int",
"userAssignedIdentities": [ "string" ],
"vmSize": "string",
"vnetConfig": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
}
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Gebruik voor PowerShell:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Gebruik voor Shell:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Voor WindowsRestart gebruikt u:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Voor WindowsUpdate gebruikt u:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Gebruik voor SharedImage:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
Gebruik voor VHD:
"type": "VHD"
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
"type": "ManagedImage",
"imageId": "string"
Gebruik voor PlatformImage:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
Gebruik voor SharedImageVersion:
"type": "SharedImageVersion",
"imageVersionId": "string"
ImageTemplateInVMValidator-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor PowerShell:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Gebruik voor Shell:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Eigenschapswaarden
imageTemplates
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.VirtualMachineImages/imageTemplates' |
| apiVersion | De resource-API-versie | '2022-02-14' |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| identity | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity (vereist) |
| properties | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties |
ImageTemplateIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type 'Geen' worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | 'Geen' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | object |
ImageTemplateProperties
| Naam | Description | Waarde |
|---|---|---|
| buildTimeoutInMinutes | Maximale wachttijd tijdens het bouwen van de installatiekopieënsjabloon (inclusief alle aanpassingen, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (4 uur). | int |
| Aanpassen | Hiermee geeft u de eigenschappen op die worden gebruikt om de aanpassingsstappen van de installatiekopieën te beschrijven, zoals Bron van installatiekopieën, enzovoort | ImageTemplateCustomizer[] |
| Distribueren | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
| source | Hiermee geeft u de eigenschappen op die worden gebruikt om de bronafbeelding te beschrijven. | ImageTemplateSource (vereist) |
| stagingResourceGroup | De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze met dezelfde naam gemaakt. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources die in de resourcegroep zijn gemaakt, verwijderd tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf bestaan. | tekenreeks |
| valideren | Configuratieopties en een lijst met validaties die moeten worden uitgevoerd op de resulterende installatiekopieën. | ImageTemplatePropertiesValidate |
| vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context te geven over wat deze aanpassingsstap doet | tekenreeks |
| type | Het objecttype instellen | File PowerShell Shell Windows Opnieuw starten WindowsUpdate (vereist) |
ImageTemplateFileCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'Bestand' (vereist) |
| doel | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waarnaar het bestand (van sourceUri) wordt geüpload in de VM | tekenreeks |
| sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande sourceUri-veld | tekenreeks |
| sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VM. Dit kan een GitHub-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
ImageTemplatePowerShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'PowerShell' (vereist) |
| inline | Matrix van PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Shell' (vereist) |
| inline | Matrix met shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateRestartCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsRestart' (vereist) |
| restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | tekenreeks |
| restartCommand | Opdracht om opnieuw opstarten uit te voeren [Standaard: 'shutdown /r /f /t 0 /c "packer restart"'] | tekenreeks |
| restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | tekenreeks |
ImageTemplateWindowsUpdateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsUpdate' (vereist) |
| filters | Matrix van filters om toe te passen updates te selecteren. U kunt lege matrix weglaten of opgeven om de standaardwaarde (geen filter) te gebruiken. Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks[] |
| searchCriteria | Criteria voor het zoeken naar updates. Laat de tekenreeks weg of geef een lege tekenreeks op om de standaardwaarde te gebruiken (alles doorzoeken). Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks |
| updateLimit | Maximum aantal updates dat tegelijk moet worden toegepast. Laat 0 weg of geef 0 op om de standaardwaarde (1000) te gebruiken | int |
ImageTemplateDistributor
| Naam | Description | Waarde |
|---|---|---|
| artifactTags | Tags die worden toegepast op het artefact zodra het is gemaakt/bijgewerkt door de distributeur. | object |
| runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | tekenreeks (vereist) |
| type | Het objecttype instellen | ManagedImage SharedImage VHD (vereist) |
ImageTemplateManagedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | ManagedImage (vereist) |
| imageId | Resource-id van de beheerde schijfinstallatiekopieën | tekenreeks (vereist) |
| location | De Azure-locatie voor de installatiekopieën moet overeenkomen met als de installatiekopieën al bestaan | tekenreeks (vereist) |
ImageTemplateSharedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | 'SharedImage' (vereist) |
| excludeFromLatest | Vlag die aangeeft of de versie van de gemaakte installatiekopieën moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde te gebruiken (onwaar). | booleaans |
| galleryImageId | Resource-id van de Shared Image Gallery-installatiekopieën | tekenreeks (vereist) |
| replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
| storageAccountType | Het type opslagaccount dat moet worden gebruikt om de gedeelde installatiekopieën op te slaan. Weglaten om de standaardwaarde (Standard_LRS) te gebruiken. | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | 'VHD' (vereist) |
ImageTemplateSource
| Naam | Description | Waarde |
|---|---|---|
| type | Het objecttype instellen | ManagedImage PlatformImage SharedImageVersion (vereist) |
ImageTemplateManagedImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | ManagedImage (vereist) |
| imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
ImageTemplatePlatformImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | 'PlatformImage' (vereist) |
| offer | Afbeeldingsaanbieding uit de Azure Gallery-installatiekopieën. | tekenreeks |
| planInfo | Optionele configuratie van aankoopplan voor platforminstallatiekopieën. | PlatformImagePurchasePlan |
| publisher | Afbeeldingsuitgever in Azure Gallery-installatiekopieën. | tekenreeks |
| sku | Installatiekopieën-SKU uit de Azure Gallery-installatiekopieën. | tekenreeks |
| versie | Installatiekopieënversie van de Azure Gallery-installatiekopieën. Als hier 'meest recente' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. | tekenreeks |
PlatformImagePurchasePlan
| Naam | Description | Waarde |
|---|---|---|
| planName | Naam van het aankoopplan. | tekenreeks (vereist) |
| planProduct | Product van het aankoopplan. | tekenreeks (vereist) |
| planPublisher | Uitgever van het aankoopplan. | tekenreeks (vereist) |
ImageTemplateSharedImageVersionSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | 'SharedImageVersion' (vereist) |
| imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
ImageTemplatePropertiesValidate
| Naam | Description | Waarde |
|---|---|---|
| continueDistributeOnFailure | Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is de standaardinstelling. Als de validatie mislukt en dit veld is ingesteld op true, worden de uitvoerafbeeldingen nog steeds gedistribueerd. Wees voorzichtig met deze optie, omdat dit ertoe kan leiden dat beschadigde afbeeldingen worden gedistribueerd voor gebruik. In beide gevallen (waar of onwaar), wordt de end-to-end-installatiekopie uitgevoerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] | booleaans |
| inVMValidations | Lijst met validaties die moeten worden uitgevoerd. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie 'bron' rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. | booleaans |
ImageTemplateInVMValidator
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context te geven over wat deze validatiestap doet | tekenreeks |
| type | Het objecttype instellen | PowerShell Shell (vereist) |
ImageTemplatePowerShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | 'PowerShell' (vereist) |
| inline | Matrix van PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | 'Shell' (vereist) |
| inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateVmProfile
| Naam | Description | Waarde |
|---|---|---|
| osDiskSizeGB | Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardgrootte van de besturingssysteemschijf van Azure te gebruiken. | int |
| userAssignedIdentities | Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon omvatten. | tekenreeks[] |
| vmSize | Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat een lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_D1_v2 voor Gen1-afbeeldingen en Standard_D2ds_v4 voor Gen2-installatiekopieën). | tekenreeks |
| vnetConfig | Optionele configuratie van het virtuele netwerk voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk hoeft te worden gebruikt. | VirtualNetworkConfig |
VirtualNetworkConfig
| Naam | Description | Waarde |
|---|---|---|
| proxyVmSize | Grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Laat de tekenreeks weg of geef een lege tekenreeks op om de standaardreeks te gebruiken (Standard_A1_v2). | tekenreeks |
| subnetId | Resource-id van een bestaand subnet. | tekenreeks |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Azure Image Builder met Azure Windows Baseline |
Hiermee maakt u een Azure Image Builder-omgeving en bouwt u een Windows Server-installatiekopieën waarop de meest recente Windows Updates en Azure Windows Baseline zijn toegepast. |
| Dev Box-service configureren |
Met deze sjabloon worden alle Dev Box-beheerresources gemaakt volgens de snelstartgids voor Dev Box. U kunt alle gemaakte resources bekijken of rechtstreeks naar DevPortal.microsoft.com gaan om uw eerste Dev Box te maken. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype imageTemplates kan worden geïmplementeerd voor:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.VirtualMachineImages/imageTemplates wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
buildTimeoutInMinutes = int
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
}
stagingResourceGroup = "string"
validate = {
continueDistributeOnFailure = bool
inVMValidations = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateInVMValidator objects
}
]
sourceValidationOnly = bool
}
vmProfile = {
osDiskSizeGB = int
userAssignedIdentities = [
"string"
]
vmSize = "string"
vnetConfig = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Gebruik voor PowerShell:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Gebruik voor Shell:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Voor WindowsRestart gebruikt u:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Voor WindowsUpdate gebruikt u:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
type = "ManagedImage"
imageId = "string"
location = "string"
Gebruik voor SharedImage:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
Gebruik voor VHD:
type = "VHD"
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
type = "ManagedImage"
imageId = "string"
Gebruik voor PlatformImage:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
Gebruik voor SharedImageVersion:
type = "SharedImageVersion"
imageVersionId = "string"
ImageTemplateInVMValidator-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor PowerShell:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Gebruik voor Shell:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Eigenschapswaarden
imageTemplates
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14" |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| parent_id | Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. |
| identity | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity (vereist) |
| properties | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties |
ImageTemplateIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type 'Geen' worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | "UserAssigned" |
| identity_ids | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | Matrix met gebruikersidentiteits-id's. |
ImageTemplateProperties
| Naam | Description | Waarde |
|---|---|---|
| buildTimeoutInMinutes | Maximale wachttijd tijdens het bouwen van de installatiekopieënsjabloon (inclusief alle aanpassingen, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (4 uur). | int |
| Aanpassen | Hiermee geeft u de eigenschappen op die worden gebruikt om de aanpassingsstappen van de afbeelding te beschrijven, zoals Afbeeldingsbron, enzovoort | ImageTemplateCustomizer[] |
| Distribueren | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
| source | Hiermee geeft u de eigenschappen die worden gebruikt om de broninstallatiekopieën te beschrijven. | ImageTemplateSource (vereist) |
| stagingResourceGroup | De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze met dezelfde naam gemaakt. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources die in de resourcegroep zijn gemaakt, verwijderd tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf bestaan. | tekenreeks |
| valideren | Configuratieopties en een lijst met validaties die moeten worden uitgevoerd op de resulterende installatiekopieën. | ImageTemplatePropertiesValidate |
| vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context te geven over wat deze aanpassingsstap doet | tekenreeks |
| type | Het objecttype instellen | File PowerShell Shell Windows Opnieuw starten WindowsUpdate (vereist) |
ImageTemplateFileCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | "Bestand" (vereist) |
| doel | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waarnaar het bestand (van sourceUri) wordt geüpload in de VM | tekenreeks |
| sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande sourceUri-veld | tekenreeks |
| sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VM. Dit kan een GitHub-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
ImageTemplatePowerShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'PowerShell' (vereist) |
| inline | Matrix van PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor aanpassing. Dit kan een GitHub-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | "Shell" (vereist) |
| inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor het aanpassen. Dit kan een GitHub-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateRestartCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'WindowsRestart' (vereist) |
| restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | tekenreeks |
| restartCommand | Opdracht om het opnieuw opstarten uit te voeren [Standaard: 'shutdown /r /f /t 0 /c "packer restart"'] | tekenreeks |
| restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | tekenreeks |
ImageTemplateWindowsUpdateCustomizer
| Naam | Description | Waarde |
|---|---|---|
| type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell customizer zijn | 'WindowsUpdate' (vereist) |
| filters | Matrix van filters om toe te passen updates te selecteren. Laat een lege matrix weg of geef deze op als u de standaardwaarde wilt gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks[] |
| searchCriteria | Criteria voor het zoeken naar updates. Laat een lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (alles doorzoeken). Raadpleeg de bovenstaande koppeling voor voorbeelden en een gedetailleerde beschrijving van dit veld. | tekenreeks |
| updateLimit | Maximum aantal updates dat tegelijk moet worden toegepast. 0 weglaten of opgeven om de standaardwaarde (1000) te gebruiken | int |
ImageTemplateDistributor
| Naam | Description | Waarde |
|---|---|---|
| artifactTags | Tags die worden toegepast op het artefact zodra het is gemaakt/bijgewerkt door de distributeur. | object |
| runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | tekenreeks (vereist) |
| type | Het objecttype instellen | ManagedImage SharedImage VHD (vereist) |
ImageTemplateManagedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | ManagedImage (vereist) |
| imageId | Resource-id van de beheerde schijfinstallatiekopieën | tekenreeks (vereist) |
| location | De Azure-locatie voor de installatiekopieën moet overeenkomen met als de installatiekopieën al bestaan | tekenreeks (vereist) |
ImageTemplateSharedImageDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | "SharedImage" (vereist) |
| excludeFromLatest | Vlag die aangeeft of de versie van de gemaakte installatiekopieën moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde te gebruiken (onwaar). | booleaans |
| galleryImageId | Resource-id van de Shared Image Gallery-installatiekopieën | tekenreeks (vereist) |
| replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
| storageAccountType | Het type opslagaccount dat moet worden gebruikt om de gedeelde installatiekopieën op te slaan. Weglaten om de standaardwaarde (Standard_LRS) te gebruiken. | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Naam | Description | Waarde |
|---|---|---|
| type | Type distributie. | 'VHD' (vereist) |
ImageTemplateSource
| Naam | Description | Waarde |
|---|---|---|
| type | Het objecttype instellen | ManagedImage PlatformImage SharedImageVersion (vereist) |
ImageTemplateManagedImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | ManagedImage (vereist) |
| imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
ImageTemplatePlatformImageSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | PlatformImage (vereist) |
| offer | Afbeeldingsaanbieding uit de Azure Gallery-installatiekopieën. | tekenreeks |
| planInfo | Optionele configuratie van aankoopplan voor platforminstallatiekopieën. | PlatformImagePurchasePlan |
| publisher | Afbeeldingsuitgever in Azure Gallery-installatiekopieën. | tekenreeks |
| sku | Installatiekopieën-SKU uit de Azure Gallery-installatiekopieën. | tekenreeks |
| versie | Installatiekopieënversie van de Azure Gallery-installatiekopieën. Als hier 'meest recente' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. | tekenreeks |
PlatformImagePurchasePlan
| Naam | Description | Waarde |
|---|---|---|
| planName | Naam van het aankoopplan. | tekenreeks (vereist) |
| planProduct | Product van het aankoopplan. | tekenreeks (vereist) |
| planPublisher | Uitgever van het aankoopplan. | tekenreeks (vereist) |
ImageTemplateSharedImageVersionSource
| Naam | Description | Waarde |
|---|---|---|
| type | Hiermee geeft u het type bronafbeelding waarmee u wilt beginnen. | "SharedImageVersion" (vereist) |
| imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
ImageTemplatePropertiesValidate
| Naam | Description | Waarde |
|---|---|---|
| continueDistributeOnFailure | Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is de standaardinstelling. Als de validatie mislukt en dit veld is ingesteld op true, worden de uitvoerafbeeldingen nog steeds gedistribueerd. Wees voorzichtig met deze optie, omdat dit ertoe kan leiden dat beschadigde afbeeldingen worden gedistribueerd voor gebruik. In beide gevallen (waar of onwaar), wordt de end-to-end-installatiekopie uitgevoerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] | booleaans |
| inVMValidations | Lijst met validaties die moeten worden uitgevoerd. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie 'bron' rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. | booleaans |
ImageTemplateInVMValidator
| Naam | Description | Waarde |
|---|---|---|
| naam | Beschrijvende naam om context te geven over wat deze validatiestap doet | tekenreeks |
| type | Het objecttype instellen | PowerShell Shell (vereist) |
ImageTemplatePowerShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | 'PowerShell' (vereist) |
| inline | Matrix van PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| runAsSystem | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de lokale systeemgebruiker. Kan alleen waar zijn wanneer het bovenstaande veld runElevated is ingesteld op true. | booleaans |
| runElevated | Indien opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | booleaans |
| scriptUri | URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | tekenreeks |
| validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateShellValidator
| Naam | Description | Waarde |
|---|---|---|
| type | Het type validatie dat u wilt gebruiken voor de afbeelding. 'Shell' kan bijvoorbeeld shellvalidatie zijn | "Shell" (vereist) |
| inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
| scriptUri | URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een GitHub-koppeling, Azure Storage-URI, enzovoort zijn | tekenreeks |
| sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het veld scriptUri | tekenreeks |
ImageTemplateVmProfile
| Naam | Description | Waarde |
|---|---|---|
| osDiskSizeGB | Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardgrootte van de besturingssysteemschijf van Azure te gebruiken. | int |
| userAssignedIdentities | Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon omvatten. | tekenreeks[] |
| vmSize | Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat een lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_D1_v2 voor Gen1-afbeeldingen en Standard_D2ds_v4 voor Gen2-installatiekopieën). | tekenreeks |
| vnetConfig | Optionele configuratie van het virtuele netwerk voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk hoeft te worden gebruikt. | VirtualNetworkConfig |
VirtualNetworkConfig
| Naam | Description | Waarde |
|---|---|---|
| proxyVmSize | Grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Laat een lege tekenreeks weg of geef deze op om de standaardreeks (Standard_A1_v2) te gebruiken. | tekenreeks |
| subnetId | Resource-id van een bestaand subnet. | tekenreeks |
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor