Skip to content

Commit 8b59beb

Browse files
bganapabganapa
authored
Merge pull request Azure#31 from hannah-murphy-0/dev
ReadMe Updates, Adding Example Templates with Some Examples, and Adding Pester Test Files
2 parents 2aa45f4 + 0893197 commit 8b59beb

24 files changed

+1386
-3
lines changed

‎src/Azs.Compute.Admin/examples/Add-AzsPlatformImage.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Example 1: Add-AzsPlatformImage
2+
```powershell
3+
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"
4+
5+
BillingPartNumber :
6+
DataDisks :
7+
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
8+
Location : local
9+
Name :
10+
OsType : Windows
11+
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
12+
ProvisioningState : Succeeded
13+
Type : Microsoft.Compute.Admin/locations/artifactTypes/publishers/offers/skus/versions
14+
```
15+
16+
Add a Platform Image from Blob Storage. Use the a SasUri to specify the location of the PlatformImage.
17+

‎src/Azs.Compute.Admin/examples/Add-AzsVMExtension.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### Example 1: Add-AzsVMExtension
2+
```powershell
3+
PS C:\> Add-AzsVMExtension -Location "local" -Publisher "Microsoft" -Type "MicroExtension" -Version "0.1.0" -ComputeRole "IaaS" -SourceBlob "https://github.com/Microsoft/PowerShell-DSC-for-Linux/archive/v1.1.1-294.zip" -SupportMultipleExtensions -VmOsType "Linux"
4+
5+
Publisher : <EDIT THIS>
6+
ComputeRole : IaaS
7+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Admin/locati
8+
ons/local/artifactTypes/VMExtension/publishers/Microsoft/types/MicroExtension/versions/0.1.0
9+
IsSystemExtension : False
10+
Location : local
11+
Name :
12+
ProvisioningState : Creating
13+
SourceBlobUri : https://github.com/Microsoft/PowerShell-DSC-for-Linux/archive/v1.1.1-294.zip
14+
SupportMultipleExtension : True
15+
Type : Microsoft.Compute.Admin/locations/artifactTypes/publishers/types/versions
16+
VMScaleSetEnabled : False
17+
VmosType : Linux
18+
```
19+
20+
Use a publicly accessible link to provide the location of the extension, or the URI to an Azure Blob using the SasUri.

‎src/Azs.Compute.Admin/examples/Get-AzsComputeQuota.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
### Example 1: Get All Compute Quotas
2+
```powershell
3+
PS C:\> Get-AzsComputeQuota
4+
5+
AvailabilitySetCount : 10
6+
CoresLimit : 100
7+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Ad
8+
min/locations/local/quotas/ascancompquota433
9+
Location : local
10+
Name : ascancompquota433
11+
PremiumManagedDiskAndSnapshotSize : 2048
12+
StandardManagedDiskAndSnapshotSize : 2048
13+
Type : Microsoft.Compute.Admin/quotas
14+
VMScaleSetCount : 100
15+
VirtualMachineCount : 100
16+
```
17+
18+
Run `Get-AzsComputeQuota` with no parameters to get a list of all Compute Quotas.
19+
20+
### Example 2: Get Compute Quota by Name
21+
```powershell
22+
PS C:\> Get-AzsComputeQuota -Name ExampleComputeQuotaWithDefaultParameters
23+
24+
AvailabilitySetCount : 10
25+
CoresLimit : 100
26+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Ad
27+
min/locations/local/quotas/ExampleComputeQuotaWithDefaultParameters
28+
Location : local
29+
Name : ExampleComputeQuotaWithDefaultParameters
30+
PremiumManagedDiskAndSnapshotSize : 2048
31+
StandardManagedDiskAndSnapshotSize : 2048
32+
Type : Microsoft.Compute.Admin/quotas
33+
VMScaleSetCount : 0
34+
VirtualMachineCount : 100
35+
```
36+
37+
Specify the Quota's name on the command line to retrieve a specific quota.
38+
39+
### Example 3: (TODO) Get Compute Quota that Does Not Exist
40+
```powershell
41+
PS C:\> {{ Add code here }}
42+
43+
{{ Add output here }}
44+
```
45+
46+
{{ Add description here }}
47+

‎src/Azs.Compute.Admin/examples/Get-AzsDisk.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### Example 1: Get All Disks
2+
```powershell
3+
PS C:\> Get-AzsDisk
4+
5+
{{ Add output here }}
6+
```
7+
Without any parameters, `Get-AzsDisk` will list all Disks.
8+
9+
### Example 2: Get a Disk by Name
10+
```powershell
11+
PS C:\> {{ Add code here }}
12+
13+
{{ Add output here }}
14+
```
15+
16+
Specify a disk by its `Name` to retrieve it.
17+
18+
### Example 2: Get a Specified number of Disks
19+
```powershell
20+
PS C:\> Get-AzsDisk -Count 3
21+
22+
{{ Add output here }}
23+
```
24+
Use the `Count` parameter to retrieve a specific number of disks.

‎src/Azs.Compute.Admin/examples/Get-AzsDiskMigrationJob.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Get-AzsPlatformImage.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
### Example 1: Get All Platform Images
2+
```powershell
3+
PS C:\> Get-AzsPlatformImage
4+
5+
BillingPartNumber :
6+
DataDisks :
7+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Admin/locations/loc
8+
al/artifactTypes/platformImage/publishers/asdf/offers/asdf/skus/asdf/versions/1.0.0
9+
Location : local
10+
Name :
11+
OsType : Windows
12+
OsUri : https://asdf.blob.local.azurestack.external/asdf/UbuntuServer.vhd?sv=2017-04-17&ss=bqt&srt=sco&sp=r
13+
wdlacup&se=2020-02-13T13:25:58Z&st=2020-02-13T05:25:58Z&spr=https
14+
ProvisioningState : Succeeded
15+
Type : Microsoft.Compute.Admin/locations/artifactTypes/publishers/offers/skus/versions
16+
```
17+
18+
Get a list of all Platform Images by leaving all parameters blank.
19+
20+
### Example 2: Get Specific Platform Image
21+
```powershell
22+
PS C:\> Get-AzsPlatformImage -Offer ExampleOffer -Publisher ExamplePublisher -Location local -Sku ExampleSku -Version 1.0.0
23+
24+
BillingPartNumber :
25+
DataDisks :
26+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Admin/locations/local/artifa
27+
ctTypes/platformImage/publishers/ExamplePublisher/offers/ExampleOffer/skus/ExampleSku/versions/1.0.0
28+
Location : local
29+
Name :
30+
OsType : Windows
31+
OsUri : https://asdf.blob.local.azurestack.external/asdf/UbuntuServer.vhd?sv=2017-04-17&ss=bqt&srt=sco&sp=rwdlacup&s
32+
e=2020-02-13T13:25:58Z&st=2020-02-13T05:25:58Z&spr=https
33+
ProvisioningState : Succeeded
34+
Type : Microsoft.Compute.Admin/locations/artifactTypes/publishers/offers/skus/versions
35+
```
36+
37+
Specify the Offer, Publisher, Location, Sku, and Version to retrieve a Platform Image.

‎src/Azs.Compute.Admin/examples/Get-AzsVMExtension.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/New-AzsComputeQuota.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
### Example 1: Create a Compute Quota with Default Parameters
2+
```powershell
3+
PS C:\> New-AzsComputeQuota -Name ExampleComputeQuotaWithDefaultParameters
4+
5+
AvailabilitySetCount : 10
6+
CoresLimit : 100
7+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Ad
8+
min/locations/local/quotas/ExampleComputeQuotaWithDefaultParameters
9+
Location : local
10+
Name : ExampleComputeQuotaWithDefaultParameters
11+
PremiumManagedDiskAndSnapshotSize : 2048
12+
StandardManagedDiskAndSnapshotSize : 2048
13+
Type : Microsoft.Compute.Admin/quotas
14+
VMScaleSetCount : 0
15+
VirtualMachineCount : 100
16+
```
17+
18+
Any parameters that are not specified will be set to their default parameter, shown above.
19+
20+
### Example 2: Create a Comute Quota with Custom Parameters
21+
```powershell
22+
PS C:\> New-AzsComputeQuota -Name ExampleComputeQuotaWithCustomParameters -Location local -AvailabilitySetCount 9 -CoresCount 99 -PremiumManagedDiskAndSnapshotSize 1024 -StandardManagedDiskAndSnapshotSize 1024 -VirtualMachineCount 99 -VMScaleSetCount 2
23+
24+
AvailabilitySetCount : 9
25+
CoresLimit : 99
26+
Id : /subscriptions/3ae476e5-83d3-429d-a450-2f4f2fc67c5e/providers/Microsoft.Compute.Admin/locat
27+
ions/local/quotas/ExampleComputeQuotaWithCustomParameters
28+
Location : local
29+
Name : ExampleComputeQuotaWithCustomParameters
30+
PremiumManagedDiskAndSnapshotSize : 1024
31+
StandardManagedDiskAndSnapshotSize : 1024
32+
Type : Microsoft.Compute.Admin/quotas
33+
VMScaleSetCount : 2
34+
VirtualMachineCount : 99
35+
```
36+
37+
Customize Quota with parameters. Any parameters not specified will have default value.
38+

‎src/Azs.Compute.Admin/examples/New-AzsDiskMigrationJob.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Remove-AzsComputeQuota.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Remove-AzsPlatformImage.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Remove-AzsVMExtension.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Set-AzsComputeQuota.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

‎src/Azs.Compute.Admin/examples/Stop-AzsDiskMigrationJob.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Example 1: {{ Add title here }}
2+
```powershell
3+
PS C:\> {{ Add code here }}
4+
5+
{{ Add output here }}
6+
```
7+
8+
{{ Add description here }}
9+
10+
### Example 2: {{ Add title here }}
11+
```powershell
12+
PS C:\> {{ Add code here }}
13+
14+
{{ Add output here }}
15+
```
16+
17+
{{ Add description here }}
18+

0 commit comments

Comments
 (0)