Add-AzsPlatformImage

Module:

Azs.Compute.Admin Module

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

Syntax

CreateExpanded (Default)

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

Create

Add-AzsPlatformImage
    -Offer <String>
    -Publisher <String>
    -Sku <String>
    -Version <String>
    -NewImage
    [-Location <String>]
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

CreateViaIdentity

Add-AzsPlatformImage
    -INPUTOBJECT
    -NewImage
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

CreateViaIdentityExpanded

Add-AzsPlatformImage
    -INPUTOBJECT
    [-BillingPartNumber <String>]
    [-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 -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"

BillingPartNumber : DataDisks : Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/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

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-BillingPartNumber

The part number is used to bill for software costs.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DataDisks

Data disks used by the platform image. To construct, see NOTES section for DATADISKS properties and create a hash table.

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IDataDisk[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	System.Management.Automation.PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

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

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.IComputeAdminIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Location

Location of the resource.

Parameter properties

Type:	System.String
Default value:	(Get-AzLocation)[0].Location
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NewImage

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

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IPlatformImageParameters
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NoWait

Run the command asynchronously

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Offer

Name of the offer.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OsType

Operating system type.

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.OSType
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OsUri

Location of the disk.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProvisioningState

Provisioning status of the platform image.

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.ProvisioningState
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Publisher

Name of the publisher.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Sku

Name of the SKU.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

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

Parameter properties

Type:	System.String
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Version

The version of the resource.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

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

ALIASES

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 <IComputeAdminIdentity>: Identity Parameter

• [DiskId <String>]: The disk guid as identity.
• [FeatureName <String>]: Name of the feature.
• [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.
• [ScaleUnitName <String>]: Name of the scale unit.
• [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 <IPlatformImageParameters>: 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.