Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Azs.Compute.Admin/custom/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ These provide functionality to our HTTP pipeline and other useful features. In s

### Attributes
For processing the cmdlets, we've created some additional attributes:
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.DescriptionAttribute`
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.DescriptionAttribute`
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propegated to reference documentation via [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.DoNotExportAttribute`
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Azs.Compute.Admin`.
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.InternalExportAttribute`
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Azs.Compute.Admin`. For more information, see [readme.md](..\internal/readme.md) in the `..\internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.ProfileAttribute`
- `Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
45 changes: 16 additions & 29 deletions src/Azs.Compute.Admin/docs/Add-AzsPlatformImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ Creates a new platform image with given publisher, offer, skus and version.

## EXAMPLES

### Example 1: Add-AzsPlatformImage
### -------------------------- EXAMPLE 1 --------------------------
```powershell
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"
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 :
Expand All @@ -58,12 +59,11 @@ 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

### -AsJob
Run the command as a job

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -75,7 +75,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -BillingPartNumber
Expand All @@ -91,7 +90,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -DataDisks
Expand All @@ -108,7 +106,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -DefaultProfile
Expand All @@ -124,7 +121,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -InputObject
Expand All @@ -141,7 +137,6 @@ Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Dynamic: False
```

### -Location
Expand All @@ -157,7 +152,6 @@ Position: Named
Default value: (Get-AzLocation)[0].Location
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -NewImage
Expand All @@ -174,7 +168,6 @@ Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Dynamic: False
```

### -NoWait
Expand All @@ -190,7 +183,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -Offer
Expand All @@ -206,7 +198,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -OsType
Expand All @@ -222,7 +213,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -OsUri
Expand All @@ -238,7 +228,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -ProvisioningState
Expand All @@ -254,7 +243,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -Publisher
Expand All @@ -270,7 +258,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -Sku
Expand All @@ -286,7 +273,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -SubscriptionId
Expand All @@ -303,7 +289,6 @@ Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -Version
Expand All @@ -319,7 +304,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -Confirm
Expand All @@ -335,7 +319,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### -WhatIf
Expand All @@ -352,7 +335,6 @@ Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Dynamic: False
```

### CommonParameters
Expand All @@ -368,31 +350,35 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

## ALIASES

## NOTES

### COMPLEX PARAMETER PROPERTIES
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.

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
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.
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.
Expand All @@ -402,3 +388,4 @@ To create the parameters described below, construct a hash table containing the
- `[ProvisioningState <ProvisioningState?>]`: Provisioning status of the platform image.

## RELATED LINKS

Loading