Add-AzsPlatformImage

Creates a new platform image with given publisher, offer, skus and version.

Syntax

Add-AzsPlatformImage
   -Offer <String>
   -Publisher <String>
   -Sku <String>
   -Version <String>
   [-Location <String>]
   [-SubscriptionId <String>]
   [-BillingPartNumber <String>]
   [-DataDisks <IDataDisk[]>]
   [-OsType <OSType>]
   [-OsUri <String>]
   [-ProvisioningState <ProvisioningState>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Add-AzsPlatformImage
   -Offer <String>
   -Publisher <String>
   -Sku <String>
   -Version <String>
   -NewImage <IPlatformImageParameters>
   [-Location <String>]
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Add-AzsPlatformImage
   -InputObject <IComputeAdminIdentity>
   -NewImage <IPlatformImageParameters>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Add-AzsPlatformImage
   -InputObject <IComputeAdminIdentity>
   [-BillingPartNumber <String>]
   [-DataDisks <IDataDisk[]>]
   [-OsType <OSType>]
   [-OsUri <String>]
   [-ProvisioningState <ProvisioningState>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Creates a new platform image with given publisher, offer, skus and version.

Examples

Example 1: Add-AzsPlatformImage

PS C:\> Add-AzsPlatformImage -Offer "asdf" -Publisher "asdf" -Sku "asdf" -Version "1.0.0" -OsType Windows -OsUri "https://asdf.blob.local.azurestack.external/asdf/UbuntuServer.vhd?sv=2017-04-17&ss=bqt&srt=sco&sp=rwdlacup&se=2020-02-13T13:25:58Z&st=2020-02-13T05:25:58Z&spr=https&sig=CKkE2r9MJc%2FK40PjRB5Tfz6DArxNd0akD90IvKJX95g%3D"

BillingPartNumber :
DataDisks         :
Id                : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Admin/locations/local/artifactTypes/platformImage/publishers/asdf/offers/asdf/skus/asdf/versions/1.0.0
Location          : local
Name              :
OsType            : Windows
OsUri             : https://asdf.blob.local.azurestack.external/asdf/UbuntuServer.vhd?sv=2017-04-17&ss=bqt&srt=sco&sp=rwdlacup&se=2020-02-13T13:25:58Z&st=2020-02-13T05:25:58Z&spr=https
ProvisioningState : Succeeded
#Type              : Microsoft.Compute.Admin/locations/artifactTypes/publishers/offers/skus/versions

Add a Platform Image from Blob Storage. Use the a SasUri to specify the location of the PlatformImage, or use a publicly accessible URL.

Parameters

-BillingPartNumber

The part number is used to bill for software costs.

Type:String
Position:Named
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. To construct, see NOTES section for DATADISKS properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IDataDisk[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Exception.Message
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.IComputeAdminIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Location

Location of the resource.

Type:String
Position:Named
Default value:(Get-AzLocation)[0].Location
Accept pipeline input:False
Accept wildcard characters:False
-NewImage

Parameters used to create a new platform image. To construct, see NOTES section for NEWIMAGE properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IPlatformImageParameters
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-NoWait

Run the command asynchronously

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

Name of the offer.

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

Operating system type.

Type:Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.OSType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OsUri

Location of the disk.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProvisioningState

Provisioning status of the platform image.

Type:Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.ProvisioningState
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Publisher

Name of the publisher.

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

Name of the SKU.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False
-Version

The version of the resource.

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

Inputs

Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IPlatformImageParameters

Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.IComputeAdminIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IPlatformImage

Notes

COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

DATADISKS <IDataDisk[]>: Data disks used by the platform image.

  • [Lun <Int32?>]: Logical unit number.
  • [Uri <String>]: Location of the disk template.

INPUTOBJECT : Identity Parameter

  • [DiskId <String>]: The disk guid as identity.
  • [Id <String>]: Resource identity path
  • [Location <String>]: Location of the resource.
  • [MigrationId <String>]: The migration job guid name.
  • [Offer <String>]: Name of the offer.
  • [Publisher <String>]: Name of the publisher.
  • [QuotaName <String>]: Name of the quota.
  • [Sku <String>]: Name of the SKU.
  • [SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • [Type <String>]: Type of extension.
  • [Version <String>]: The version of the resource.

NEWIMAGE : Parameters used to create a new platform image.

  • [DataDisk <IDataDisk[]>]: Data disks used by the platform image.
    • [Lun <Int32?>]: Logical unit number.
    • [Uri <String>]: Location of the disk template.
  • [DetailBillingPartNumber <String>]: The part number is used to bill for software costs.
  • [OSDiskOstype <OSType?>]: Operating system type.
  • [OSDiskUri <String>]: Location of the disk.
  • [ProvisioningState <ProvisioningState?>]: Provisioning status of the platform image.