Microsoft.VirtualMachineImages imageTemplates 2019-05-01-preview
Bicep-resourcedefinitie
Het resourcetype imageTemplates kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor 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@2019-05-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
buildTimeoutInMinutes: int
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
}
vmProfile: {
vmSize: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ISO-:
{
sha256Checksum: 'string'
sourceUri: 'string'
type: 'ISO'
}
Gebruik voor ManagedImage:
{
imageId: 'string'
type: 'ManagedImage'
}
Gebruik voor PlatformImage:
{
offer: 'string'
publisher: 'string'
sku: 'string'
type: 'PlatformImage'
version: 'string'
}
Gebruik voor SharedImageVersion:
{
imageVersionId: 'string'
type: 'SharedImageVersion'
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
{
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
type: 'File'
}
Gebruik voor PowerShell-:
{
inline: [
'string'
]
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
Gebruik voor Shell-:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
Gebruik voor WindowsRestart:
{
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
type: 'WindowsRestart'
}
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
{
imageId: 'string'
location: 'string'
type: 'ManagedImage'
}
Gebruik voor SharedImage:
{
galleryImageId: 'string'
replicationRegions: [
'string'
]
type: 'SharedImage'
}
Gebruik voor VHD-:
{
type: 'VHD'
}
Eigenschapswaarden
ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties
Naam | Beschrijving | Waarde |
---|
ImageTemplateCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
naam | Beschrijvende naam om context te geven over wat deze aanpassingsstap doet | snaar |
type | Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. | 'Bestand' 'PowerShell' 'Shell' 'WindowsRestart' (vereist) |
ImageTemplateDistributor
Naam | Beschrijving | Waarde |
---|---|---|
artifactTags | Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. | ImageTemplateDistributorArtifactTags |
runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
type | Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. | ManagedImage 'SharedImage' VHD (vereist) |
ImageTemplateDistributorArtifactTags
Naam | Beschrijving | Waarde |
---|
ImageTemplateFileCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine | snaar |
sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld | snaar |
sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Bestand' (vereist) |
ImageTemplateIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | 'Geen' UserAssigned |
userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ImageTemplateIdentityUserAssignedIdentities |
ImageTemplateIdentityUserAssignedIdentities
Naam | Beschrijving | Waarde |
---|
ImageTemplateIsoSource
Naam | Beschrijving | Waarde |
---|---|---|
sha256Checksum | SHA256 Controlesom van de ISO-installatiekopieën. | tekenreeks (vereist) |
sourceUri | URI om de ISO-installatiekopieën op te halen. Deze URI moet toegankelijk zijn voor de resourceprovider op het moment dat de installatiekopiesjabloon is gemaakt. | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | 'ISO' (vereist) |
ImageTemplateManagedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
imageId | Resource-id van de installatiekopieën van de beheerde schijf | tekenreeks (vereist) |
plaats | Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan | tekenreeks (vereist) |
type | Type distributie. | ManagedImage (vereist) |
ImageTemplateManagedImageSource
Naam | Beschrijving | Waarde |
---|---|---|
imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | ManagedImage (vereist) |
ImageTemplatePlatformImageSource
Naam | Beschrijving | Waarde |
---|---|---|
aanbieden | Afbeeldingsaanbieding uit de Azure Gallery Images. | snaar |
uitgever | Image Publisher in Azure Gallery Images. | snaar |
Sku | Afbeeldingsku uit de Azure Gallery-installatiekopieën. | snaar |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | PlatformImage (vereist) |
Versie | Installatiekopieën van de Azure Gallery-installatiekopieën. | snaar |
ImageTemplatePowerShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix met PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
runElevated | Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | Bool |
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 | snaar |
sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | PowerShell (vereist) |
validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateProperties
Naam | Beschrijving | Waarde |
---|---|---|
buildTimeoutInMinutes | Maximale duur die moet worden gewacht tijdens het bouwen van de afbeeldingssjabloon. Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. | Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 960 |
Aanpassen | Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort | ImageTemplateCustomizer[] |
uitdelen | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
bron | Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. | ImageTemplateSource (vereist) |
vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateRestartCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | snaar |
restartCommand | Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] | snaar |
restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsRestart' (vereist) |
ImageTemplateSharedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
galleryImageId | Resource-id van de installatiekopieëngalerie met gedeelde installatiekopieën | tekenreeks (vereist) |
replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
type | Type distributie. | SharedImage (vereist) |
ImageTemplateSharedImageVersionSource
Naam | Beschrijving | Waarde |
---|---|---|
imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | SharedImageVersion (vereist) |
ImageTemplateShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
scriptUri | URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Shell' (vereist) |
ImageTemplateSource
Naam | Beschrijving | Waarde |
---|---|---|
type | Ingesteld op ISO voor type ImageTemplateIsoSource. Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. | 'ISO' ManagedImage 'PlatformImage' SharedImageVersion (vereist) |
ImageTemplateVhdDistributor
Naam | Beschrijving | Waarde |
---|---|---|
type | Type distributie. | VHD (vereist) |
ImageTemplateVmProfile
Naam | Beschrijving | Waarde |
---|---|---|
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 standaardreeks te gebruiken (Standard_D1_v2). | snaar |
Microsoft.VirtualMachineImages/imageTemplates
Naam | Beschrijving | Waarde |
---|---|---|
identiteit | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity- |
plaats | Resourcelocatie | tekenreeks (vereist) |
naam | De resourcenaam | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
Eigenschappen | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties- |
Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
ResourceTags
Naam | Beschrijving | Waarde |
---|
Gebruiksvoorbeelden
Geverifieerde Azure-modules
De volgende azure-geverifieerde modules kunnen worden gebruikt om dit resourcetype te implementeren.
Module | Beschrijving |
---|---|
vm-installatiekopieënsjabloon | AVM-resourcemodule voor sjabloon voor installatiekopieën van virtuele machines |
Azure-snelstartvoorbeelden
De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.
Bicep-bestand | 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 nieuwste Windows-updates en Azure Windows Baseline zijn toegepast. |
Dev Box-service configureren | Met deze sjabloon worden alle Dev Box-beheerbronnen gemaakt volgens de Quick Start-handleiding voor Dev Box (/azure/dev-box/quickstart-create-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 met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor 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": "2019-05-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"buildTimeoutInMinutes": "int",
"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
},
"vmProfile": {
"vmSize": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ISO-:
{
"sha256Checksum": "string",
"sourceUri": "string",
"type": "ISO"
}
Gebruik voor ManagedImage:
{
"imageId": "string",
"type": "ManagedImage"
}
Gebruik voor PlatformImage:
{
"offer": "string",
"publisher": "string",
"sku": "string",
"type": "PlatformImage",
"version": "string"
}
Gebruik voor SharedImageVersion:
{
"imageVersionId": "string",
"type": "SharedImageVersion"
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
{
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string",
"type": "File"
}
Gebruik voor PowerShell-:
{
"inline": [ "string" ],
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
Gebruik voor Shell-:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
Gebruik voor WindowsRestart:
{
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string",
"type": "WindowsRestart"
}
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
{
"imageId": "string",
"location": "string",
"type": "ManagedImage"
}
Gebruik voor SharedImage:
{
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"type": "SharedImage"
}
Gebruik voor VHD-:
{
"type": "VHD"
}
Eigenschapswaarden
ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties
Naam | Beschrijving | Waarde |
---|
ImageTemplateCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
naam | Beschrijvende naam om context te geven over wat deze aanpassingsstap doet | snaar |
type | Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. | 'Bestand' 'PowerShell' 'Shell' 'WindowsRestart' (vereist) |
ImageTemplateDistributor
Naam | Beschrijving | Waarde |
---|---|---|
artifactTags | Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. | ImageTemplateDistributorArtifactTags |
runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
type | Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. | ManagedImage 'SharedImage' VHD (vereist) |
ImageTemplateDistributorArtifactTags
Naam | Beschrijving | Waarde |
---|
ImageTemplateFileCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine | snaar |
sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld | snaar |
sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Bestand' (vereist) |
ImageTemplateIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | 'Geen' UserAssigned |
userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ImageTemplateIdentityUserAssignedIdentities |
ImageTemplateIdentityUserAssignedIdentities
Naam | Beschrijving | Waarde |
---|
ImageTemplateIsoSource
Naam | Beschrijving | Waarde |
---|---|---|
sha256Checksum | SHA256 Controlesom van de ISO-installatiekopieën. | tekenreeks (vereist) |
sourceUri | URI om de ISO-installatiekopieën op te halen. Deze URI moet toegankelijk zijn voor de resourceprovider op het moment dat de installatiekopiesjabloon is gemaakt. | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | 'ISO' (vereist) |
ImageTemplateManagedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
imageId | Resource-id van de installatiekopieën van de beheerde schijf | tekenreeks (vereist) |
plaats | Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan | tekenreeks (vereist) |
type | Type distributie. | ManagedImage (vereist) |
ImageTemplateManagedImageSource
Naam | Beschrijving | Waarde |
---|---|---|
imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | ManagedImage (vereist) |
ImageTemplatePlatformImageSource
Naam | Beschrijving | Waarde |
---|---|---|
aanbieden | Afbeeldingsaanbieding uit de Azure Gallery Images. | snaar |
uitgever | Image Publisher in Azure Gallery Images. | snaar |
Sku | Afbeeldingsku uit de Azure Gallery-installatiekopieën. | snaar |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | PlatformImage (vereist) |
Versie | Installatiekopieën van de Azure Gallery-installatiekopieën. | snaar |
ImageTemplatePowerShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix met PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
runElevated | Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | Bool |
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 | snaar |
sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | PowerShell (vereist) |
validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateProperties
Naam | Beschrijving | Waarde |
---|---|---|
buildTimeoutInMinutes | Maximale duur die moet worden gewacht tijdens het bouwen van de afbeeldingssjabloon. Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. | Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 960 |
Aanpassen | Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort | ImageTemplateCustomizer[] |
uitdelen | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
bron | Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. | ImageTemplateSource (vereist) |
vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateRestartCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | snaar |
restartCommand | Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] | snaar |
restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsRestart' (vereist) |
ImageTemplateSharedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
galleryImageId | Resource-id van de installatiekopieëngalerie met gedeelde installatiekopieën | tekenreeks (vereist) |
replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
type | Type distributie. | SharedImage (vereist) |
ImageTemplateSharedImageVersionSource
Naam | Beschrijving | Waarde |
---|---|---|
imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | SharedImageVersion (vereist) |
ImageTemplateShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
scriptUri | URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Shell' (vereist) |
ImageTemplateSource
Naam | Beschrijving | Waarde |
---|---|---|
type | Ingesteld op ISO voor type ImageTemplateIsoSource. Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. | 'ISO' ManagedImage 'PlatformImage' SharedImageVersion (vereist) |
ImageTemplateVhdDistributor
Naam | Beschrijving | Waarde |
---|---|---|
type | Type distributie. | VHD (vereist) |
ImageTemplateVmProfile
Naam | Beschrijving | Waarde |
---|---|---|
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 standaardreeks te gebruiken (Standard_D1_v2). | snaar |
Microsoft.VirtualMachineImages/imageTemplates
Naam | Beschrijving | Waarde |
---|---|---|
apiVersion | De API-versie | '2019-05-01-preview' |
identiteit | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity- |
plaats | Resourcelocatie | tekenreeks (vereist) |
naam | De resourcenaam | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
Eigenschappen | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties- |
Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
type | Het resourcetype | 'Microsoft.VirtualMachineImages/imageTemplates' |
ResourceTags
Naam | Beschrijving | Waarde |
---|
Gebruiksvoorbeelden
Azure-snelstartsjablonen
De volgende Azure-quickstartsjablonen dit resourcetype implementeren.
Sjabloon | 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 nieuwste Windows-updates en Azure Windows Baseline zijn toegepast. |
Dev Box-service configureren |
Met deze sjabloon worden alle Dev Box-beheerbronnen gemaakt volgens de Quick Start-handleiding voor Dev Box (/azure/dev-box/quickstart-create-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 met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.VirtualMachineImages/imageTemplates-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
buildTimeoutInMinutes = int
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
}
vmProfile = {
vmSize = "string"
}
}
}
}
ImageTemplateSource-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ISO-:
{
sha256Checksum = "string"
sourceUri = "string"
type = "ISO"
}
Gebruik voor ManagedImage:
{
imageId = "string"
type = "ManagedImage"
}
Gebruik voor PlatformImage:
{
offer = "string"
publisher = "string"
sku = "string"
type = "PlatformImage"
version = "string"
}
Gebruik voor SharedImageVersion:
{
imageVersionId = "string"
type = "SharedImageVersion"
}
ImageTemplateCustomizer-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor Bestand:
{
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
type = "File"
}
Gebruik voor PowerShell-:
{
inline = [
"string"
]
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
Gebruik voor Shell-:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
Gebruik voor WindowsRestart:
{
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
type = "WindowsRestart"
}
ImageTemplateDistributor-objecten
Stel de eigenschap type in om het type object op te geven.
Gebruik voor ManagedImage:
{
imageId = "string"
location = "string"
type = "ManagedImage"
}
Gebruik voor SharedImage:
{
galleryImageId = "string"
replicationRegions = [
"string"
]
type = "SharedImage"
}
Gebruik voor VHD-:
{
type = "VHD"
}
Eigenschapswaarden
ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties
Naam | Beschrijving | Waarde |
---|
ImageTemplateCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
naam | Beschrijvende naam om context te geven over wat deze aanpassingsstap doet | snaar |
type | Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. | 'Bestand' 'PowerShell' 'Shell' 'WindowsRestart' (vereist) |
ImageTemplateDistributor
Naam | Beschrijving | Waarde |
---|---|---|
artifactTags | Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. | ImageTemplateDistributorArtifactTags |
runOutputName | De naam die moet worden gebruikt voor de bijbehorende RunOutput. | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
type | Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. | ManagedImage 'SharedImage' VHD (vereist) |
ImageTemplateDistributorArtifactTags
Naam | Beschrijving | Waarde |
---|
ImageTemplateFileCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine | snaar |
sha256Checksum | SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld | snaar |
sourceUri | De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Bestand' (vereist) |
ImageTemplateIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. | 'Geen' UserAssigned |
userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ImageTemplateIdentityUserAssignedIdentities |
ImageTemplateIdentityUserAssignedIdentities
Naam | Beschrijving | Waarde |
---|
ImageTemplateIsoSource
Naam | Beschrijving | Waarde |
---|---|---|
sha256Checksum | SHA256 Controlesom van de ISO-installatiekopieën. | tekenreeks (vereist) |
sourceUri | URI om de ISO-installatiekopieën op te halen. Deze URI moet toegankelijk zijn voor de resourceprovider op het moment dat de installatiekopiesjabloon is gemaakt. | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | 'ISO' (vereist) |
ImageTemplateManagedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
imageId | Resource-id van de installatiekopieën van de beheerde schijf | tekenreeks (vereist) |
plaats | Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan | tekenreeks (vereist) |
type | Type distributie. | ManagedImage (vereist) |
ImageTemplateManagedImageSource
Naam | Beschrijving | Waarde |
---|---|---|
imageId | ARM-resource-id van de beheerde installatiekopieën in het klantabonnement | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | ManagedImage (vereist) |
ImageTemplatePlatformImageSource
Naam | Beschrijving | Waarde |
---|---|---|
aanbieden | Afbeeldingsaanbieding uit de Azure Gallery Images. | snaar |
uitgever | Image Publisher in Azure Gallery Images. | snaar |
Sku | Afbeeldingsku uit de Azure Gallery-installatiekopieën. | snaar |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | PlatformImage (vereist) |
Versie | Installatiekopieën van de Azure Gallery-installatiekopieën. | snaar |
ImageTemplatePowerShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix met PowerShell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
runElevated | Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden | Bool |
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 | snaar |
sha256Checksum | SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | PowerShell (vereist) |
validExitCodes | Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] | int[] |
ImageTemplateProperties
Naam | Beschrijving | Waarde |
---|---|---|
buildTimeoutInMinutes | Maximale duur die moet worden gewacht tijdens het bouwen van de afbeeldingssjabloon. Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. | Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 960 |
Aanpassen | Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort | ImageTemplateCustomizer[] |
uitdelen | De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. | ImageTemplateDistributor[] (vereist) |
bron | Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. | ImageTemplateSource (vereist) |
vmProfile | Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën | ImageTemplateVmProfile |
ImageTemplateRestartCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
restartCheckCommand | Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] | snaar |
restartCommand | Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] | snaar |
restartTimeout | Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'WindowsRestart' (vereist) |
ImageTemplateSharedImageDistributor
Naam | Beschrijving | Waarde |
---|---|---|
galleryImageId | Resource-id van de installatiekopieëngalerie met gedeelde installatiekopieën | tekenreeks (vereist) |
replicationRegions | Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd | tekenreeks[] (vereist) |
type | Type distributie. | SharedImage (vereist) |
ImageTemplateSharedImageVersionSource
Naam | Beschrijving | Waarde |
---|---|---|
imageVersionId | ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën | tekenreeks (vereist) |
type | Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. | SharedImageVersion (vereist) |
ImageTemplateShellCustomizer
Naam | Beschrijving | Waarde |
---|---|---|
Inline | Matrix van shell-opdrachten die moeten worden uitgevoerd | tekenreeks[] |
scriptUri | URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn | snaar |
sha256Checksum | SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld | snaar |
type | Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn | 'Shell' (vereist) |
ImageTemplateSource
Naam | Beschrijving | Waarde |
---|---|---|
type | Ingesteld op ISO voor type ImageTemplateIsoSource. Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. | 'ISO' ManagedImage 'PlatformImage' SharedImageVersion (vereist) |
ImageTemplateVhdDistributor
Naam | Beschrijving | Waarde |
---|---|---|
type | Type distributie. | VHD (vereist) |
ImageTemplateVmProfile
Naam | Beschrijving | Waarde |
---|---|---|
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 standaardreeks te gebruiken (Standard_D1_v2). | snaar |
Microsoft.VirtualMachineImages/imageTemplates
Naam | Beschrijving | Waarde |
---|---|---|
identiteit | De identiteit van de afbeeldingssjabloon, indien geconfigureerd. | ImageTemplateIdentity- |
plaats | Resourcelocatie | tekenreeks (vereist) |
naam | De resourcenaam | string Beperkingen: Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist) |
Eigenschappen | De eigenschappen van de afbeeldingssjabloon | ImageTemplateProperties- |
Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
type | Het resourcetype | "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview" |
ResourceTags
Naam | Beschrijving | Waarde |
---|