New-AzGalleryImageDefinition

Módulo:

Az.Compute Module

Create a gallery image definition.

Sintaxis

Default (Es el valor predeterminado).

New-AzGalleryImageDefinition
    [-ResourceGroupName] <String>
    [-GalleryName] <String>
    [-Name] <String>
    [-AsJob]
    [-Location] <String>
    -Publisher <String>
    -Offer <String>
    -Sku <String>
    -OsState <OperatingSystemStateTypes>
    -OsType <OperatingSystemTypes>
    [-Description <String>]
    [-DisallowedDiskType <String[]>]
    [-EndOfLifeDate <DateTime>]
    [-Eula <String>]
    [-HyperVGeneration <String>]
    [-MinimumMemory <Int32>]
    [-MinimumVCPU <Int32>]
    [-MaximumMemory <Int32>]
    [-MaximumVCPU <Int32>]
    [-PrivacyStatementUri <String>]
    [-PurchasePlanName <String>]
    [-PurchasePlanProduct <String>]
    [-PurchasePlanPublisher <String>]
    [-ReleaseNoteUri <String>]
    [-Tag <Hashtable>]
    [-Feature <GalleryImageFeature[]>]
    [-Architecture <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a gallery image definition. The gallery image definition will default to 'HyperVGeneration: V2' and 'SecurityType: TrustedLaunchSupported' if -HyperVGeneration and -Feature @{Name: SecurityType} is not set explicitly. Set SecurityType to 'None' to opt out of this defaulting (See Example 10).

Ejemplos

Example 1: Create an image definition for specialized linux images

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$description = "My gallery"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Specialized" -OsType "Linux" -Description $description

Creates a gallery image definition to contain image versions for specialized linux images. This will default the Gallery Image to HyperVGeneration V2 and Trusted Launch as -HyperVGeneration and -Feature SecurityType is not set explicitly.

Example 2: Create an image definition for generalized linux images

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$description = "My gallery"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Description $description

Creates a gallery image definition to contain image versions for generalized linux images.

Example 3: Create an image definition for specialized windows images

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$description = "My gallery"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Specialized" -OsType "Windows" -Description $description

Creates a gallery image definition to contain image versions for specialized windows images.

Example 4: Create an image definition for generalized windows images and set features.

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$description = "My gallery"
$IsHibernateSupported = @{Name='IsHibernateSupported';Value='True'}
$IsAcceleratedNetworkSupported = @{Name='IsAcceleratedNetworkSupported';Value='False'}
$ConfidentialVMSupported = @{Name='SecurityType';Value='ConfidentialVMSupported'}
$features = @($IsHibernateSupported,$IsAcceleratedNetworkSupported, $ConfidentialVMSupported)
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Windows" -Description $description -Feature $features -HyperVGeneration "V2"

Creates a gallery image definition to contain image versions for generalized windows images.

Example 5: Create an image definition with plan information

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$purchasePlanName = "myPlanName"
$purchasePlanProduct = "myPlanProduct"
$purchasePlanPublisher = "myPlanPublisher"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -PurchasePlanName $purchasePlanName -PurchasePlanProduct $purchasePlanProduct -PurchasePlanPublisher $purchasePlanPublisher

Creates a gallery image definition for linux generalized images and define the plan name, product, and publisher. Only image versions that match the plan information can be added to this definition.

Example 6: Create an image definition and indicate end of life date

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$endOfLifeDate = "2024-08-02T00:00:00+00:00"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -EndOfLifeDate $endOfLifeDate

This example has the end-of-life date for image definitions set to August 2, 2024 at midnight UTC. End-of-life dates can be specified for image definitions and image versions. Image definitions can still be used after the end-of-life dates.

Example 7: Create an image definition and recommend minimum and maximum CPU and memory (GB)

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$minMemory = 32
$maxMemory = 128
$minVCPU = 2
$maxVCPU = 8
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU

Creates a gallery image definition and recommends the minimum and maximum ranges for the CPU and memory that the image versions in this image definition support. Image versions can still be used to create virtual machines with memory and vCPU settings outside the recommended ranges.

Example 8: Create an image definition and indicate which OS disk types are not recommended for the image

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$disallowedDiskTypes = @("Standard_LRS")
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -DisallowedDiskType $disallowedDiskTypes

Creates a gallery image definition and indicate which OS disk types may not be compatible with image versions within this image definition. Image versions can still be used to create virtual machines with an OS disk that is one of the disallowed disk types.

Example 9: Create an image definition and provide the EULA, privacy statement URI, and release notes URI

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$eula = "https://myeula"
$privacyStatementUri = "https://mystatement"
$releaseNoteUri = "https://myreleasenotes"
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Eula $eula -PrivacyStatementUri $privacyStatementUri -ReleaseNoteUri $releaseNoteUri

Creates a gallery image definition for linux generalized images and specify either the string or path to an EULA agreement, privacy statement, and release notes tied to all image versions in the image definition.

Example 10: Create a gallery image definition with Standard SecurityType feature

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"

$Feature1 = @{Name='SecurityType';Value='None'}
$Features = @($Feature1)

New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Feature $Features

Create a gallery image definition with standard security type feature by providing 'None' as the value of the SecurityType feature.

Parámetros

-Architecture

CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64".

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-AsJob

Run cmdlet in the background

Propiedades del parámetro

Tipo:	SwitchParameter
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Propiedades del parámetro

Tipo:	SwitchParameter
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False
Alias:	cf

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Propiedades del parámetro

Tipo:	IAzureContextContainer
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False
Alias:	AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Description

The description of the gallery image Definition resource.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-DisallowedDiskType

The disallowed disk types.

Propiedades del parámetro

Tipo:	String[]
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-EndOfLifeDate

The end of life date of the gallery Image Definition

Propiedades del parámetro

Tipo:	DateTime
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Eula

The Eula agreement for the gallery Image Definition.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Feature

A list of gallery image features. For SecurityType, acceptable inputs are: None, TrustedlaunchSupported, Trustedlaunch, ConfidentialVM, ConfidentialVMSupported, TrustedLaunchAndConfidentialVmSupported

Propiedades del parámetro

Tipo:	GalleryImageFeature[]
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-GalleryName

The name of the gallery.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	1
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-HyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Location

Resource location

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	3
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-MaximumMemory

The maximum of the recommended memory

Propiedades del parámetro

Tipo:	Int32
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-MaximumVCPU

The maximum of the recommended CPU core

Propiedades del parámetro

Tipo:	Int32
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-MinimumMemory

The minimum of the recommended memory

Propiedades del parámetro

Tipo:	Int32
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-MinimumVCPU

The minimum of the recommended CPU core

Propiedades del parámetro

Tipo:	Int32
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Name

The name of the gallery image definition.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False
Alias:	GalleryImageDefinitionName

Conjuntos de parámetros

(All)

Posición:	2
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Offer

The name of the gallery Image Definition offer.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-OsState

The state of OS

Propiedades del parámetro

Tipo:	OperatingSystemStateTypes
Valor predeterminado:	None
Valores aceptados:	Generalized, Specialized
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-OsType

The type of OS

Propiedades del parámetro

Tipo:	OperatingSystemTypes
Valor predeterminado:	None
Valores aceptados:	Windows, Linux
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-PrivacyStatementUri

The privacy statement uri.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Publisher

The name of the gallery Image Definition publisher.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-PurchasePlanName

The ID for the purchase plan.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-PurchasePlanProduct

The product ID for the purchase plan.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-PurchasePlanPublisher

The publisher ID for the purchase plan.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-ReleaseNoteUri

The release note uri.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-ResourceGroupName

The name of the resource group.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	0
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Sku

The name of the gallery Image Definition SKU.

Propiedades del parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Tag

Resource tags

Propiedades del parámetro

Tipo:	Hashtable
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Propiedades del parámetro

Tipo:	SwitchParameter
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False
Alias:	wi

Conjuntos de parámetros

(All)

Posición:	Named
Mandatory:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Entradas

String

OperatingSystemStateTypes

OperatingSystemTypes

DateTime

Hashtable

Int32

String

Salidas

PSGalleryImage