Add-AzsPlatformImage

Add a virtual machine platform image from a given image configuration.

Syntax

Add-AzsPlatformImage
   [-Publisher] <String>
   [-Offer] <String>
   [-Sku] <String>
   [-Version] <String>
   [-OsType] <Object>
   [-OsUri] <String>
   [[-BillingPartNumber] <String>]
   [[-DataDisks] <DataDisk[]>]
   [[-Location] <String>]
   [-AsJob]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Add a platform image.

Examples

-------------------------- EXAMPLE 1 --------------------------

Add-AzsPlatformImage -Publisher Test -Offer UbuntuServer -Sku 16.04-LTS -Version 1.0.0 -OsType "Linux" -OsUri "https://test.blob.local.azurestack.external/test/xenial-server-cloudimg-amd64-disk1.vhd"

Add a new platform image.

Required Parameters

-Offer

Name of the offer.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OsType

Operating system type.

Type:Object
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OsUri

Location of the disk.

Type:String
Position:6
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Publisher

Name of the publisher.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Sku

Name of the SKU.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Version

The version of the virtual machine platform image.

Type:String
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AsJob

Run asynchronous as a job and return the job object.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-BillingPartNumber

The part number is used to bill for software costs.

Type:String
Position:7
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DataDisks

Data disks used by the platform image.

Type:DataDisk[]
Position:8
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Don't ask for confirmation.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Location

Location of the resource.

Type:String
Position:9
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

PlatformImageObject